cipher_test.c File Reference

Cipher self-tests. More...

#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include <assert.h>
#include <ipxe/crypto.h>
#include <ipxe/profile.h>
#include <ipxe/test.h>
#include "cipher_test.h"

Go to the source code of this file.

Macros
#define	PROFILE_COUNT   16
	Number of sample iterations for profiling.

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.
void	cipher_key_fail_okx (struct cipher_test *test, const char *file, unsigned int line)
	Report a cipher key failure test result.
void	cipher_iv_fail_okx (struct cipher_test *test, const char *file, unsigned int line)
	Report a cipher IV failure test result.
static unsigned long	cipher_cost (struct cipher_algorithm *cipher, size_t key_len, void(*op)(struct cipher_algorithm *cipher, void *ctx, const void *src, void *dst, size_t len))
	Calculate cipher encryption or decryption cost.
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.c.

Macro Definition Documentation

PROFILE_COUNT

#define PROFILE_COUNT   16

Number of sample iterations for profiling.

Definition at line 45 of file cipher_test.c.

Referenced by cipher_cost(), digest_cost(), librm_test_exec(), memcpy_test_speed(), and tcpip_random_okx().

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 )

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 );
        okx ( cipher_setiv ( cipher, ctx, test->iv, test->iv_len ) == 0,
              file, line );
 
        /* 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 */
        okx ( cipher_setiv ( cipher, ctx, test->iv, test->iv_len ) == 0,
              file, line );
 
        /* 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 )

Report a cipher decryption test result.

Parameters

test	Cipher test
file	Test code file
line	Test code line

Definition at line 115 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 );
        okx ( cipher_setiv ( cipher, ctx, test->iv, test->iv_len ) == 0,
              file, line );
 
        /* 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 */
        okx ( cipher_setiv ( cipher, ctx, test->iv, test->iv_len ) == 0,
              file, line );
 
        /* 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 )

Report a cipher encryption and decryption test result.

Parameters

test	Cipher test
file	Test code file
line	Test code line

Definition at line 176 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 );
        okx ( cipher->confidential, 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(), cipher_algorithm::confidential, len, okx, and test.

cipher_key_fail_okx()

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

Report a cipher key failure test result.

Parameters

test	Cipher test
file	Test code file
line	Test code line

Definition at line 201 of file cipher_test.c.

                                               {
        struct cipher_algorithm *cipher = test->cipher;
        uint8_t ctx[cipher->ctxsize];
 
        /* Initialise cipher */
        okx ( cipher_setkey ( cipher, ctx, test->key, test->key_len ) != 0,
              file, line );
}

References cipher_setkey(), ctx, cipher_algorithm::ctxsize, okx, and test.

cipher_iv_fail_okx()

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

Report a cipher IV failure test result.

Parameters

test	Cipher test
file	Test code file
line	Test code line

Definition at line 218 of file cipher_test.c.

                                              {
        struct cipher_algorithm *cipher = test->cipher;
        uint8_t ctx[cipher->ctxsize];
 
        /* Initialise cipher */
        okx ( cipher_setkey ( cipher, ctx, test->key, test->key_len ) == 0,
              file, line );
        okx ( cipher_setiv ( cipher, ctx, test->iv, test->iv_len ) != 0,
              file, line );
}

References cipher_setiv(), cipher_setkey(), ctx, cipher_algorithm::ctxsize, okx, and test.

cipher_cost()

unsigned long cipher_cost ( struct cipher_algorithm * cipher, size_t key_len, void(* op )(struct cipher_algorithm *cipher, void *ctx, const void *src, void *dst, size_t len) )

static

Calculate cipher encryption or decryption cost.

Parameters

cipher	Cipher algorithm
key_len	Length of key
op	Encryption or decryption operation

Return values

cost	Cost (in cycles per byte)

Definition at line 239 of file cipher_test.c.

                                                                         {
        static uint8_t random[8192]; /* Too large for stack */
        uint8_t key[key_len];
        uint8_t iv[cipher->blocksize];
        uint8_t ctx[cipher->ctxsize];
        struct profiler profiler;
        unsigned long cost;
        unsigned int i;
        int rc;
 
        /* Fill buffer with pseudo-random data */
        srand ( 0x1234568 );
        for ( i = 0 ; i < sizeof ( random ) ; i++ )
                random[i] = rand();
        for ( i = 0 ; i < sizeof ( key ) ; i++ )
                key[i] = rand();
        for ( i = 0 ; i < sizeof ( iv ) ; i++ )
                iv[i] = rand();
 
        /* Initialise cipher */
        rc = cipher_setkey ( cipher, ctx, key, key_len );
        assert ( rc == 0 );
        rc = cipher_setiv ( cipher, ctx, iv, sizeof ( iv ) );
        assert ( rc == 0 );
 
        /* Profile cipher operation */
        memset ( &profiler, 0, sizeof ( profiler ) );
        for ( i = 0 ; i < PROFILE_COUNT ; i++ ) {
                profile_start ( &profiler );
                op ( cipher, ctx, random, random, sizeof ( random ) );
                profile_stop ( &profiler );
        }
 
        /* Round to nearest whole number of cycles per byte */
        cost = ( ( profile_mean ( &profiler ) + ( sizeof ( random ) / 2 ) ) /
                 sizeof ( random ) );
 
        return cost;
}

References assert, cipher_algorithm::blocksize, cipher_setiv(), cipher_setkey(), cost, ctx, cipher_algorithm::ctxsize, iv, key, len, memset(), op, PROFILE_COUNT, profile_mean(), profile_start(), profile_stop(), rand(), random(), rc, srand(), and src.

Referenced by cipher_cost_decrypt(), and cipher_cost_encrypt().

cipher_cost_encrypt()

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

Calculate cipher encryption cost.

Parameters

cipher	Cipher algorithm
key_len	Length of key

Return values

cost	Cost (in cycles per byte)

Definition at line 288 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 )

Calculate cipher decryption cost.

Parameters

cipher	Cipher algorithm
key_len	Length of key

Return values

cost	Cost (in cycles per byte)

Definition at line 300 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().