cipher_test.h File Reference

Cipher self-tests. More...

#include <stdint.h>
#include <ipxe/crypto.h>
#include <ipxe/test.h>

Go to the source code of this file.

Data Structures
struct	cipher_test
	A cipher test. More...

Macros
#define	KEY(...)
	Define inline key.
#define	IV(...)
	Define inline initialisation vector.
#define	ADDITIONAL(...)
	Define inline additional data.
#define	PLAINTEXT(...)
	Define inline plaintext data.
#define	CIPHERTEXT(...)
	Define inline ciphertext data.
#define	AUTH(...)
	Define inline authentication tag.
#define	CIPHER_TEST(name, CIPHER, KEY, IV, ADDITIONAL, PLAINTEXT, CIPHERTEXT, AUTH)
	Define a cipher test.
#define	cipher_encrypt_ok(test)
	Report a cipher encryption test result.
#define	cipher_decrypt_ok(test)
	Report a cipher decryption test result.
#define	cipher_ok(test)
	Report a cipher encryption and decryption test result.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
void	cipher_encrypt_okx (struct cipher_test *test, const char *file, unsigned int line)
	Report a cipher encryption test result.
void	cipher_decrypt_okx (struct cipher_test *test, const char *file, unsigned int line)
	Report a cipher decryption test result.
void	cipher_okx (struct cipher_test *test, const char *file, unsigned int line)
	Report a cipher encryption and decryption test result.
unsigned long	cipher_cost_encrypt (struct cipher_algorithm *cipher, size_t key_len)
	Calculate cipher encryption cost.
unsigned long	cipher_cost_decrypt (struct cipher_algorithm *cipher, size_t key_len)
	Calculate cipher decryption cost.

Detailed Description

Cipher self-tests.

Definition in file cipher_test.h.

Macro Definition Documentation

KEY

#define KEY

(

...

)

Value:

{ __VA_ARGS__ }

Define inline key.

Definition at line 45 of file cipher_test.h.

Referenced by CIPHER_TEST(), CIPHER_TEST(), HMAC_TEST(), HMAC_TEST(), HMAC_TEST(), HMAC_TEST(), and HMAC_TEST().

IV

#define IV

(

...

)

Value:

{ __VA_ARGS__ }

Define inline initialisation vector.

Definition at line 48 of file cipher_test.h.

Referenced by CIPHER_TEST().

ADDITIONAL

#define ADDITIONAL

(

...

)

Value:

{ __VA_ARGS__ }

Define inline additional data.

Definition at line 51 of file cipher_test.h.

PLAINTEXT

#define PLAINTEXT

(

...

)

Value:

{ __VA_ARGS__ }

Define inline plaintext data.

Definition at line 54 of file cipher_test.h.

Referenced by CIPHER_TEST(), CIPHER_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_SIGN_TEST(), PUBKEY_TEST(), and PUBKEY_TEST().

CIPHERTEXT

#define CIPHERTEXT

(

...

)

Value:

{ __VA_ARGS__ }

Define inline ciphertext data.

Definition at line 57 of file cipher_test.h.

Referenced by CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), PUBKEY_TEST(), and PUBKEY_TEST().

AUTH

#define AUTH

(

...

)

Value:

{ __VA_ARGS__ }

Define inline authentication tag.

Definition at line 60 of file cipher_test.h.

Referenced by CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), CIPHER_TEST(), and CIPHER_TEST().

CIPHER_TEST

#define CIPHER_TEST	(		name,
			CIPHER,
			KEY,
			IV,
			ADDITIONAL,
			PLAINTEXT,
			CIPHERTEXT,
			AUTH )

Value:

        static const uint8_t name ## _key [] = KEY;                       \
        static const uint8_t name ## _iv [] = IV;                  \
        static const uint8_t name ## _additional [] = ADDITIONAL;  \
        static const uint8_t name ## _plaintext [] = PLAINTEXT;             \
        static const uint8_t name ## _ciphertext                     \
                [ sizeof ( name ## _plaintext ) ] = CIPHERTEXT;           \
        static const uint8_t name ## _auth [] = AUTH;                    \
        static struct cipher_test name = {                               \
                .cipher = CIPHER,                                       \
                .key = name ## _key,                                        \
                .key_len = sizeof ( name ## _key ),                 \
                .iv = name ## _iv,                                        \
                .iv_len = sizeof ( name ## _iv ),                   \
                .additional = name ## _additional,                  \
                .additional_len = sizeof ( name ## _additional ),   \
                .plaintext = name ## _plaintext,                    \
                .ciphertext = name ## _ciphertext,                  \
                .len = sizeof ( name ## _plaintext ),                    \
                .auth = name ## _auth,                                      \
                .auth_len = sizeof ( name ## _auth ),                       \
        }

Define a cipher test.

Parameters

name	Test name
CIPHER	Cipher algorithm
KEY	Key
IV	Initialisation vector
ADDITIONAL	Additional data
PLAINTEXT	Plaintext
CIPHERTEXT	Ciphertext
AUTH	Authentication tag

Return values

test	Cipher test

Definition at line 75 of file cipher_test.h.

cipher_encrypt_ok

#define cipher_encrypt_ok

(

test

)

Value:

        cipher_encrypt_okx ( test, __FILE__, __LINE__ )

Report a cipher encryption test result.

Parameters

test	Cipher test

Definition at line 115 of file cipher_test.h.

#define cipher_encrypt_ok( test ) \
        cipher_encrypt_okx ( test, __FILE__, __LINE__ )

cipher_decrypt_ok

#define cipher_decrypt_ok

(

test

)

Value:

        cipher_decrypt_okx ( test, __FILE__, __LINE__ )

Report a cipher decryption test result.

Parameters

test	Cipher test

Definition at line 123 of file cipher_test.h.

#define cipher_decrypt_ok( test ) \
        cipher_decrypt_okx ( test, __FILE__, __LINE__ )

cipher_ok

#define cipher_ok

(

test

)

Value:

        cipher_okx ( test, __FILE__, __LINE__ )

Report a cipher encryption and decryption test result.

Parameters

test	Cipher test

Definition at line 131 of file cipher_test.h.

#define cipher_ok( test ) \
        cipher_okx ( test, __FILE__, __LINE__ )

Referenced by aes_test_exec(), des_test_exec(), and gcm_test_exec().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

cipher_encrypt_okx()

void cipher_encrypt_okx ( struct cipher_test * test, const char * file, unsigned int line )

extern

Report a cipher encryption test result.

Parameters

test	Cipher test
file	Test code file
line	Test code line

Definition at line 54 of file cipher_test.c.

                                              {
        struct cipher_algorithm *cipher = test->cipher;
        size_t len = test->len;
        uint8_t ctx[cipher->ctxsize];
        uint8_t ciphertext[len];
        uint8_t auth[cipher->authsize];
 
        /* Initialise cipher */
        okx ( cipher_setkey ( cipher, ctx, test->key, test->key_len ) == 0,
              file, line );
        cipher_setiv ( cipher, ctx, test->iv, test->iv_len );
 
        /* Process additional data, if applicable */
        if ( test->additional_len ) {
                okx ( is_auth_cipher ( cipher ), file, line );
                cipher_encrypt ( cipher, ctx, test->additional, NULL,
                                 test->additional_len );
        }
 
        /* Perform encryption */
        cipher_encrypt ( cipher, ctx, test->plaintext, ciphertext, len );
 
        /* Compare against expected ciphertext */
        okx ( memcmp ( ciphertext, test->ciphertext, len ) == 0, file, line );
 
        /* Check authentication tag */
        okx ( cipher->authsize == test->auth_len, file, line );
        cipher_auth ( cipher, ctx, auth );
        okx ( memcmp ( auth, test->auth, test->auth_len ) == 0, file, line );
 
        /* Reset initialisation vector */
        cipher_setiv ( cipher, ctx, test->iv, test->iv_len );
 
        /* Process additional data, if applicable */
        if ( test->additional_len ) {
                cipher_encrypt ( cipher, ctx, test->additional, NULL,
                                 test->additional_len );
        }
 
        /* Perform in-place encryption */
        memcpy ( ciphertext, test->plaintext, len );
        cipher_encrypt ( cipher, ctx, ciphertext, ciphertext, len );
 
        /* Compare against expected ciphertext */
        okx ( memcmp ( ciphertext, test->ciphertext, len ) == 0, file, line );
 
        /* Check authentication tag */
        cipher_auth ( cipher, ctx, auth );
        okx ( memcmp ( auth, test->auth, test->auth_len ) == 0, file, line );
}

References cipher_algorithm::auth, cipher_algorithm::authsize, cipher_auth(), cipher_encrypt, cipher_setiv(), cipher_setkey(), ctx, cipher_algorithm::ctxsize, is_auth_cipher(), len, memcmp(), memcpy(), NULL, okx, and test.

Referenced by cipher_okx().

cipher_decrypt_okx()

void cipher_decrypt_okx ( struct cipher_test * test, const char * file, unsigned int line )

extern

Report a cipher decryption test result.

Parameters

test	Cipher test
file	Test code file
line	Test code line

Definition at line 113 of file cipher_test.c.

                                              {
        struct cipher_algorithm *cipher = test->cipher;
        size_t len = test->len;
        uint8_t ctx[cipher->ctxsize];
        uint8_t plaintext[len];
        uint8_t auth[cipher->authsize];
 
        /* Initialise cipher */
        okx ( cipher_setkey ( cipher, ctx, test->key, test->key_len ) == 0,
              file, line );
        cipher_setiv ( cipher, ctx, test->iv, test->iv_len );
 
        /* Process additional data, if applicable */
        if ( test->additional_len ) {
                okx ( is_auth_cipher ( cipher ), file, line );
                cipher_decrypt ( cipher, ctx, test->additional, NULL,
                                 test->additional_len );
        }
 
        /* Perform decryption */
        cipher_decrypt ( cipher, ctx, test->ciphertext, plaintext, len );
 
        /* Compare against expected plaintext */
        okx ( memcmp ( plaintext, test->plaintext, len ) == 0, file, line );
 
        /* Check authentication tag */
        okx ( cipher->authsize == test->auth_len, file, line );
        cipher_auth ( cipher, ctx, auth );
        okx ( memcmp ( auth, test->auth, test->auth_len ) == 0, file, line );
 
        /* Reset initialisation vector */
        cipher_setiv ( cipher, ctx, test->iv, test->iv_len );
 
        /* Process additional data, if applicable */
        if ( test->additional_len ) {
                cipher_decrypt ( cipher, ctx, test->additional, NULL,
                                 test->additional_len );
        }
 
        /* Perform in-place decryption */
        memcpy ( plaintext, test->ciphertext, len );
        cipher_decrypt ( cipher, ctx, plaintext, plaintext, len );
 
        /* Compare against expected plaintext */
        okx ( memcmp ( plaintext, test->plaintext, len ) == 0, file, line );
 
        /* Check authentication tag */
        cipher_auth ( cipher, ctx, auth );
        okx ( memcmp ( auth, test->auth, test->auth_len ) == 0, file, line );
}

References cipher_algorithm::auth, cipher_algorithm::authsize, cipher_auth(), cipher_decrypt, cipher_setiv(), cipher_setkey(), ctx, cipher_algorithm::ctxsize, is_auth_cipher(), len, memcmp(), memcpy(), NULL, okx, and test.

Referenced by cipher_okx().

cipher_okx()

void cipher_okx ( struct cipher_test * test, const char * file, unsigned int line )

extern

Report a cipher encryption and decryption test result.

Parameters

test	Cipher test
file	Test code file
line	Test code line

Definition at line 172 of file cipher_test.c.

                                      {
        struct cipher_algorithm *cipher = test->cipher;
        size_t len = test->len;
 
        /* Sanity checks */
        okx ( cipher->blocksize != 0, file, line );
        okx ( ( len % cipher->blocksize ) == 0, file, line );
        okx ( ( cipher->alignsize % cipher->blocksize ) == 0, file, line );
 
        /* Report encryption test result */
        cipher_encrypt_okx ( test, file, line );
 
        /* Report decryption test result */
        cipher_decrypt_okx ( test, file, line );
}

References cipher_algorithm::alignsize, cipher_algorithm::blocksize, cipher_decrypt_okx(), cipher_encrypt_okx(), len, okx, and test.

cipher_cost_encrypt()

unsigned long cipher_cost_encrypt ( struct cipher_algorithm * cipher, size_t key_len )

extern

Calculate cipher encryption cost.

Parameters

cipher	Cipher algorithm
key_len	Length of key

Return values

cost	Cost (in cycles per byte)

Definition at line 246 of file cipher_test.c.

                                                     {
        return cipher_cost ( cipher, key_len, cipher_encrypt );
}

References cipher_cost(), and cipher_encrypt.

Referenced by aes_test_exec(), des_test_exec(), and gcm_test_exec().

cipher_cost_decrypt()

unsigned long cipher_cost_decrypt ( struct cipher_algorithm * cipher, size_t key_len )

extern

Calculate cipher decryption cost.

Parameters

cipher	Cipher algorithm
key_len	Length of key

Return values

cost	Cost (in cycles per byte)

Definition at line 258 of file cipher_test.c.

                                                     {
        return cipher_cost ( cipher, key_len, cipher_decrypt );
}

References cipher_cost(), and cipher_decrypt.

Referenced by aes_test_exec(), des_test_exec(), and gcm_test_exec().