iPXE
Data Structures | Macros | Functions
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(...)   { __VA_ARGS__ }
 Define inline key. More...
 
#define IV(...)   { __VA_ARGS__ }
 Define inline initialisation vector. More...
 
#define ADDITIONAL(...)   { __VA_ARGS__ }
 Define inline additional data. More...
 
#define PLAINTEXT(...)   { __VA_ARGS__ }
 Define inline plaintext data. More...
 
#define CIPHERTEXT(...)   { __VA_ARGS__ }
 Define inline ciphertext data. More...
 
#define AUTH(...)   { __VA_ARGS__ }
 Define inline authentication tag. More...
 
#define CIPHER_TEST(name, CIPHER, KEY, IV, ADDITIONAL, PLAINTEXT, CIPHERTEXT, AUTH)
 Define a cipher test. More...
 
#define cipher_encrypt_ok(test)   cipher_encrypt_okx ( test, __FILE__, __LINE__ )
 Report a cipher encryption test result. More...
 
#define cipher_decrypt_ok(test)   cipher_decrypt_okx ( test, __FILE__, __LINE__ )
 Report a cipher decryption test result. More...
 
#define cipher_ok(test)   cipher_okx ( test, __FILE__, __LINE__ )
 Report a cipher encryption and decryption test result. More...
 

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. More...
 
void cipher_decrypt_okx (struct cipher_test *test, const char *file, unsigned int line)
 Report a cipher decryption test result. More...
 
void cipher_okx (struct cipher_test *test, const char *file, unsigned int line)
 Report a cipher encryption and decryption test result. More...
 
unsigned long cipher_cost_encrypt (struct cipher_algorithm *cipher, size_t key_len)
 Calculate cipher encryption cost. More...
 
unsigned long cipher_cost_decrypt (struct cipher_algorithm *cipher, size_t key_len)
 Calculate cipher decryption cost. More...
 

Detailed Description

Cipher self-tests.

Definition in file cipher_test.h.

Macro Definition Documentation

◆ KEY

#define KEY (   ...)    { __VA_ARGS__ }

Define inline key.

Definition at line 45 of file cipher_test.h.

◆ IV

#define IV (   ...)    { __VA_ARGS__ }

Define inline initialisation vector.

Definition at line 48 of file cipher_test.h.

◆ ADDITIONAL

#define ADDITIONAL (   ...)    { __VA_ARGS__ }

Define inline additional data.

Definition at line 51 of file cipher_test.h.

◆ PLAINTEXT

#define PLAINTEXT (   ...)    { __VA_ARGS__ }

Define inline plaintext data.

Definition at line 54 of file cipher_test.h.

◆ CIPHERTEXT

#define CIPHERTEXT (   ...)    { __VA_ARGS__ }

Define inline ciphertext data.

Definition at line 57 of file cipher_test.h.

◆ AUTH

#define AUTH (   ...)    { __VA_ARGS__ }

Define inline authentication tag.

Definition at line 60 of file cipher_test.h.

◆ 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 ), \
}
AUTH
#define AUTH(...)
Define inline authentication tag.
Definition: cipher_test.h:60
IV
#define IV(...)
Define inline initialisation vector.
Definition: cipher_test.h:48
name
const char * name
Definition: ath9k_hw.c:1984
CIPHERTEXT
#define CIPHERTEXT(...)
Define inline ciphertext data.
Definition: cipher_test.h:57
PLAINTEXT
#define PLAINTEXT(...)
Define inline plaintext data.
Definition: cipher_test.h:54
KEY
#define KEY(...)
Define inline key.
Definition: cipher_test.h:45
cipher_test
A cipher test.
Definition: cipher_test.h:17
cipher_test::ciphertext
const void * ciphertext
Ciphertext.
Definition: cipher_test.h:35
cipher_test::plaintext
const void * plaintext
Plaintext.
Definition: cipher_test.h:33
uint8_t
unsigned char uint8_t
Definition: stdint.h:10
cipher_test::iv_len
size_t iv_len
Length of initialisation vector.
Definition: cipher_test.h:27
len
uint32_t len
Length.
Definition: ena.h:14
iv
static void const void * iv
Definition: crypto.h:238
ADDITIONAL
#define ADDITIONAL(...)
Define inline additional data.
Definition: cipher_test.h:51

Define a cipher test.

Parameters
nameTest name
CIPHERCipher algorithm
KEYKey
IVInitialisation vector
ADDITIONALAdditional data
PLAINTEXTPlaintext
CIPHERTEXTCiphertext
AUTHAuthentication tag
Return values
testCipher test

Definition at line 75 of file cipher_test.h.

◆ cipher_encrypt_ok

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

Report a cipher encryption test result.

Parameters
testCipher test

Definition at line 115 of file cipher_test.h.

◆ cipher_decrypt_ok

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

Report a cipher decryption test result.

Parameters
testCipher test

Definition at line 123 of file cipher_test.h.

◆ cipher_ok

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

Report a cipher encryption and decryption test result.

Parameters
testCipher test

Definition at line 131 of file cipher_test.h.

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
testCipher test
fileTest code file
lineTest code line

Definition at line 54 of file cipher_test.c.

55  {
56  struct cipher_algorithm *cipher = test->cipher;
57  size_t len = test->len;
58  uint8_t ctx[cipher->ctxsize];
59  uint8_t ciphertext[len];
60  uint8_t auth[cipher->authsize];
61 
62  /* Initialise cipher */
63  okx ( cipher_setkey ( cipher, ctx, test->key, test->key_len ) == 0,
64  file, line );
65  cipher_setiv ( cipher, ctx, test->iv, test->iv_len );
66 
67  /* Process additional data, if applicable */
68  if ( test->additional_len ) {
69  okx ( is_auth_cipher ( cipher ), file, line );
70  cipher_encrypt ( cipher, ctx, test->additional, NULL,
71  test->additional_len );
72  }
73 
74  /* Perform encryption */
75  cipher_encrypt ( cipher, ctx, test->plaintext, ciphertext, len );
76 
77  /* Compare against expected ciphertext */
78  okx ( memcmp ( ciphertext, test->ciphertext, len ) == 0, file, line );
79 
80  /* Check authentication tag */
81  okx ( cipher->authsize == test->auth_len, file, line );
82  cipher_auth ( cipher, ctx, auth );
83  okx ( memcmp ( auth, test->auth, test->auth_len ) == 0, file, line );
84 
85  /* Reset initialisation vector */
86  cipher_setiv ( cipher, ctx, test->iv, test->iv_len );
87 
88  /* Process additional data, if applicable */
89  if ( test->additional_len ) {
90  cipher_encrypt ( cipher, ctx, test->additional, NULL,
91  test->additional_len );
92  }
93 
94  /* Perform in-place encryption */
95  memcpy ( ciphertext, test->plaintext, len );
96  cipher_encrypt ( cipher, ctx, ciphertext, ciphertext, len );
97 
98  /* Compare against expected ciphertext */
99  okx ( memcmp ( ciphertext, test->ciphertext, len ) == 0, file, line );
100 
101  /* Check authentication tag */
102  cipher_auth ( cipher, ctx, auth );
103  okx ( memcmp ( auth, test->auth, test->auth_len ) == 0, file, line );
104 }
auth
static void void * auth
Definition: crypto.h:264
cipher_encrypt
#define cipher_encrypt(cipher, ctx, src, dst, len)
Definition: crypto.h:248
cipher_algorithm::authsize
size_t authsize
Authentication tag size.
Definition: crypto.h:73
memcpy
void * memcpy(void *dest, const void *src, size_t len) __nonnull
okx
#define okx(success, file, line)
Report test result.
Definition: test.h:44
ctx
struct golan_eq_context ctx
Definition: CIB_PRM.h:28
uint8_t
unsigned char uint8_t
Definition: stdint.h:10
cipher_algorithm::ctxsize
size_t ctxsize
Context size.
Definition: crypto.h:53
len
uint32_t len
Length.
Definition: ena.h:14
cipher_algorithm
A cipher algorithm.
Definition: crypto.h:49
memcmp
int memcmp(const void *first, const void *second, size_t len)
Compare memory regions.
Definition: string.c:114
NULL
#define NULL
NULL pointer (VOID *)
Definition: Base.h:321
test
static int test
Definition: epic100.c:73

References auth, cipher_algorithm::authsize, cipher_encrypt, ctx, cipher_algorithm::ctxsize, 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
testCipher test
fileTest code file
lineTest code line

Definition at line 113 of file cipher_test.c.

114  {
115  struct cipher_algorithm *cipher = test->cipher;
116  size_t len = test->len;
117  uint8_t ctx[cipher->ctxsize];
118  uint8_t plaintext[len];
119  uint8_t auth[cipher->authsize];
120 
121  /* Initialise cipher */
122  okx ( cipher_setkey ( cipher, ctx, test->key, test->key_len ) == 0,
123  file, line );
124  cipher_setiv ( cipher, ctx, test->iv, test->iv_len );
125 
126  /* Process additional data, if applicable */
127  if ( test->additional_len ) {
128  okx ( is_auth_cipher ( cipher ), file, line );
129  cipher_decrypt ( cipher, ctx, test->additional, NULL,
130  test->additional_len );
131  }
132 
133  /* Perform decryption */
134  cipher_decrypt ( cipher, ctx, test->ciphertext, plaintext, len );
135 
136  /* Compare against expected plaintext */
137  okx ( memcmp ( plaintext, test->plaintext, len ) == 0, file, line );
138 
139  /* Check authentication tag */
140  okx ( cipher->authsize == test->auth_len, file, line );
141  cipher_auth ( cipher, ctx, auth );
142  okx ( memcmp ( auth, test->auth, test->auth_len ) == 0, file, line );
143 
144  /* Reset initialisation vector */
145  cipher_setiv ( cipher, ctx, test->iv, test->iv_len );
146 
147  /* Process additional data, if applicable */
148  if ( test->additional_len ) {
149  cipher_decrypt ( cipher, ctx, test->additional, NULL,
150  test->additional_len );
151  }
152 
153  /* Perform in-place decryption */
154  memcpy ( plaintext, test->ciphertext, len );
155  cipher_decrypt ( cipher, ctx, plaintext, plaintext, len );
156 
157  /* Compare against expected plaintext */
158  okx ( memcmp ( plaintext, test->plaintext, len ) == 0, file, line );
159 
160  /* Check authentication tag */
161  cipher_auth ( cipher, ctx, auth );
162  okx ( memcmp ( auth, test->auth, test->auth_len ) == 0, file, line );
163 }
auth
static void void * auth
Definition: crypto.h:264
cipher_algorithm::authsize
size_t authsize
Authentication tag size.
Definition: crypto.h:73
memcpy
void * memcpy(void *dest, const void *src, size_t len) __nonnull
okx
#define okx(success, file, line)
Report test result.
Definition: test.h:44
ctx
struct golan_eq_context ctx
Definition: CIB_PRM.h:28
uint8_t
unsigned char uint8_t
Definition: stdint.h:10
cipher_algorithm::ctxsize
size_t ctxsize
Context size.
Definition: crypto.h:53
cipher_decrypt
#define cipher_decrypt(cipher, ctx, src, dst, len)
Definition: crypto.h:258
len
uint32_t len
Length.
Definition: ena.h:14
cipher_algorithm
A cipher algorithm.
Definition: crypto.h:49
memcmp
int memcmp(const void *first, const void *second, size_t len)
Compare memory regions.
Definition: string.c:114
NULL
#define NULL
NULL pointer (VOID *)
Definition: Base.h:321
test
static int test
Definition: epic100.c:73

References auth, cipher_algorithm::authsize, cipher_decrypt, ctx, cipher_algorithm::ctxsize, 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
testCipher test
fileTest code file
lineTest code line

Definition at line 172 of file cipher_test.c.

173  {
174  struct cipher_algorithm *cipher = test->cipher;
175  size_t len = test->len;
176 
177  /* Sanity checks */
178  okx ( cipher->blocksize != 0, file, line );
179  okx ( ( len % cipher->blocksize ) == 0, file, line );
180  okx ( ( cipher->alignsize % cipher->blocksize ) == 0, file, line );
181 
182  /* Report encryption test result */
183  cipher_encrypt_okx ( test, file, line );
184 
185  /* Report decryption test result */
186  cipher_decrypt_okx ( test, file, line );
187 }
cipher_algorithm::blocksize
size_t blocksize
Block size.
Definition: crypto.h:59
cipher_algorithm::alignsize
size_t alignsize
Alignment size.
Definition: crypto.h:71
cipher_decrypt_okx
void cipher_decrypt_okx(struct cipher_test *test, const char *file, unsigned int line)
Report a cipher decryption test result.
Definition: cipher_test.c:113
okx
#define okx(success, file, line)
Report test result.
Definition: test.h:44
len
uint32_t len
Length.
Definition: ena.h:14
cipher_algorithm
A cipher algorithm.
Definition: crypto.h:49
cipher_encrypt_okx
void cipher_encrypt_okx(struct cipher_test *test, const char *file, unsigned int line)
Report a cipher encryption test result.
Definition: cipher_test.c:54
test
static int test
Definition: epic100.c:73

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 
)

Calculate cipher encryption cost.

Parameters
cipherCipher algorithm
key_lenLength of key
Return values
costCost (in cycles per byte)

Definition at line 246 of file cipher_test.c.

247  {
248  return cipher_cost ( cipher, key_len, cipher_encrypt );
249 }
cipher_cost
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.
Definition: cipher_test.c:198
key_len
static void const void size_t key_len
Definition: crypto.h:285
cipher_encrypt
#define cipher_encrypt(cipher, ctx, src, dst, len)
Definition: crypto.h:248

References cipher_cost(), cipher_encrypt, and key_len.

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
cipherCipher algorithm
key_lenLength of key
Return values
costCost (in cycles per byte)

Definition at line 258 of file cipher_test.c.

259  {
260  return cipher_cost ( cipher, key_len, cipher_decrypt );
261 }
cipher_cost
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.
Definition: cipher_test.c:198
key_len
static void const void size_t key_len
Definition: crypto.h:285
cipher_decrypt
#define cipher_decrypt(cipher, ctx, src, dst, len)
Definition: crypto.h:258

References cipher_cost(), cipher_decrypt, and key_len.

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

Generated by   doxygen 1.8.15