1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
|
/**********************************************************************
Copyright(c) 2011-2016 Intel Corporation All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.
* Neither the name of Intel Corporation nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
**********************************************************************/
/**
* @file aes_gcm.h
* @brief AES GCM encryption/decryption function prototypes.
*
* At build time there is an option to use non-temporal loads and stores
* selected by defining the compile time option NT_LDST. The use of this option
* places the following restriction on the gcm encryption functions:
*
* - The plaintext and cyphertext buffers must be aligned on a 16 byte boundary.
*
* - When using the streaming API, all partial input buffers must be a multiple
* of 16 bytes long except for the last input buffer.
*
* - In-place encryption/decryption is not recommended.
*
*/
/*
; References:
; This code was derived and highly optimized from the code described in paper:
; Vinodh Gopal et. al. Optimized Galois-Counter-Mode Implementation on Intel Architecture Processors. August, 2010
;
; For the shift-based reductions used in this code, we used the method described in paper:
; Shay Gueron, Michael E. Kounavis. Intel Carry-Less Multiplication Instruction and its Usage for Computing the GCM Mode. January, 2010.
;
;
;
; Assumptions: Support for SSE4.1 or greater, AVX or AVX2
;
;
; iv:
; 0 1 2 3
; 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
; +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
; | Salt (From the SA) |
; +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
; | Initialization Vector |
; | (This is the sequence number from IPSec header) |
; +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
; | 0x1 |
; +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
;
; TLen:
; from the definition of the spec, TLen can only be 8, 12 or 16 bytes.
;
*/
#ifndef _AES_GCM_h
#define _AES_GCM_h
#include <stdint.h>
#ifdef __cplusplus
extern "C" {
#endif
/* Authenticated Tag Length in bytes. Valid values are 16 (most likely), 12 or 8. */
#define MAX_TAG_LEN (16)
//
// IV data is limited to 16 bytes. The last DWORD (4 bytes) must be 0x1
//
#define GCM_IV_LEN (16)
#define GCM_IV_DATA_LEN (12)
#define GCM_IV_END_MARK {0x00, 0x00, 0x00, 0x01};
#define GCM_IV_END_START (12)
#define LONGEST_TESTED_AAD_LENGTH (2* 1024)
// Key lengths of 128 and 256 supported
#define GCM_128_KEY_LEN (16)
#define GCM_256_KEY_LEN (32)
#define GCM_BLOCK_LEN 16
#define GCM_ENC_KEY_LEN 16
#define GCM_KEY_SETS (15) /*exp key + 14 exp round keys*/
/** @brief holds intermediate key data needed to improve performance
*
* gcm_data hold internal key information used by gcm128 and gcm256.
*/
struct gcm_data {
uint8_t expanded_keys[GCM_ENC_KEY_LEN * GCM_KEY_SETS];
uint8_t shifted_hkey_1[GCM_ENC_KEY_LEN]; // store HashKey <<1 mod poly here
uint8_t shifted_hkey_2[GCM_ENC_KEY_LEN]; // store HashKey^2 <<1 mod poly here
uint8_t shifted_hkey_3[GCM_ENC_KEY_LEN]; // store HashKey^3 <<1 mod poly here
uint8_t shifted_hkey_4[GCM_ENC_KEY_LEN]; // store HashKey^4 <<1 mod poly here
uint8_t shifted_hkey_5[GCM_ENC_KEY_LEN]; // store HashKey^5 <<1 mod poly here
uint8_t shifted_hkey_6[GCM_ENC_KEY_LEN]; // store HashKey^6 <<1 mod poly here
uint8_t shifted_hkey_7[GCM_ENC_KEY_LEN]; // store HashKey^7 <<1 mod poly here
uint8_t shifted_hkey_8[GCM_ENC_KEY_LEN]; // store HashKey^8 <<1 mod poly here
uint8_t shifted_hkey_1_k[GCM_ENC_KEY_LEN]; // store XOR of High 64 bits and Low 64 bits of HashKey <<1 mod poly here (for Karatsuba purposes)
uint8_t shifted_hkey_2_k[GCM_ENC_KEY_LEN]; // store XOR of High 64 bits and Low 64 bits of HashKey^2 <<1 mod poly here (for Karatsuba purposes)
uint8_t shifted_hkey_3_k[GCM_ENC_KEY_LEN]; // store XOR of High 64 bits and Low 64 bits of HashKey^3 <<1 mod poly here (for Karatsuba purposes)
uint8_t shifted_hkey_4_k[GCM_ENC_KEY_LEN]; // store XOR of High 64 bits and Low 64 bits of HashKey^4 <<1 mod poly here (for Karatsuba purposes)
uint8_t shifted_hkey_5_k[GCM_ENC_KEY_LEN]; // store XOR of High 64 bits and Low 64 bits of HashKey^5 <<1 mod poly here (for Karatsuba purposes)
uint8_t shifted_hkey_6_k[GCM_ENC_KEY_LEN]; // store XOR of High 64 bits and Low 64 bits of HashKey^6 <<1 mod poly here (for Karatsuba purposes)
uint8_t shifted_hkey_7_k[GCM_ENC_KEY_LEN]; // store XOR of High 64 bits and Low 64 bits of HashKey^7 <<1 mod poly here (for Karatsuba purposes)
uint8_t shifted_hkey_8_k[GCM_ENC_KEY_LEN]; // store XOR of High 64 bits and Low 64 bits of HashKey^8 <<1 mod poly here (for Karatsuba purposes)
// init, update and finalize context data
uint8_t aad_hash[GCM_BLOCK_LEN];
uint64_t aad_length;
uint64_t in_length;
uint8_t partial_block_enc_key[GCM_BLOCK_LEN];
uint8_t orig_IV[GCM_BLOCK_LEN];
uint8_t current_counter[GCM_BLOCK_LEN];
uint64_t partial_block_length;
};
/**
* @brief GCM-AES Encryption using 128 bit keys
*
* @requires SSE4.1 and AESNI
*
*/
void aesni_gcm128_enc(struct gcm_data *my_ctx_data,
uint8_t * out, //!< Ciphertext output. Encrypt in-place is allowed.
uint8_t const *in, //!< Plaintext input
uint64_t plaintext_len, //!< Length of data in Bytes for encryption.
uint8_t * iv, //!< Pre-counter block j0: 4 byte salt (from Security Association) concatenated with 8 byte Initialization Vector (from IPSec ESP Payload) concatenated with 0x00000001. 16-byte pointer.
uint8_t const *aad, //!< Additional Authentication Data (AAD).
uint64_t aad_len, //!< Length of AAD.
uint8_t * auth_tag, //!< Authenticated Tag output.
uint64_t auth_tag_len //!< Authenticated Tag Length in bytes (must be a multiple of 4 bytes). Valid values are 16 (most likely), 12 or 8.
);
/**
* @brief GCM-AES Decryption using 128 bit keys
*
* @requires SSE4.1 and AESNI
*
*/
void aesni_gcm128_dec(struct gcm_data *my_ctx_data,
uint8_t * out, //!< Plaintext output. Decrypt in-place is allowed.
uint8_t const *in, //!< Ciphertext input
uint64_t plaintext_len, //!< Length of data in Bytes for encryption.
uint8_t * iv, //!< Pre-counter block j0: 4 byte salt (from Security Association) concatenated with 8 byte Initialisation Vector (from IPSec ESP Payload) concatenated with 0x00000001. 16-byte pointer.
uint8_t const *aad, //!< Additional Authentication Data (AAD).
uint64_t aad_len, //!< Length of AAD.
uint8_t * auth_tag, //!< Authenticated Tag output.
uint64_t auth_tag_len //!< Authenticated Tag Length in bytes (must be a multiple of 4 bytes). Valid values are 16 (most likely), 12 or 8.
);
/**
* @brief start a AES-128-GCM Encryption message
*
* @requires SSE4.1 and AESNI
*
*/
void aesni_gcm128_init( struct gcm_data *my_ctx_data,
uint8_t * iv, //!< Pre-counter block j0: 4 byte salt (from Security Association) concatenated with 8 byte Initialization Vector (from IPSec ESP Payload) concatenated with 0x00000001. 16-byte pointer.
uint8_t const *aad, //!< Additional Authentication Data (AAD).
uint64_t aad_len //!< Length of AAD.
);
/**
* @brief encrypt a block of a AES-128-GCM Encryption message
*
* @requires SSE4.1 and AESNI
*
*/
void aesni_gcm128_enc_update( struct gcm_data *my_ctx_data,
uint8_t *out, //!< Ciphertext output. Encrypt in-place is allowed.
const uint8_t *in, //!< Plaintext input
uint64_t plaintext_len //!< Length of data in Bytes for encryption.
);
/**
* @brief decrypt a block of a AES-128-GCM Encryption message
*
* @requires SSE4.1 and AESNI
*
*/
void aesni_gcm128_dec_update( struct gcm_data *my_ctx_data,
uint8_t *out, //!< Ciphertext output. Encrypt in-place is allowed.
const uint8_t *in, //!< Plaintext input
uint64_t plaintext_len //!< Length of data in Bytes for encryption.
);
/**
* @brief End encryption of a AES-128-GCM Encryption message
*
* @requires SSE4.1 and AESNI
*
*/
void aesni_gcm128_enc_finalize( struct gcm_data *my_ctx_data,
uint8_t *auth_tag, //!< Authenticated Tag output.
uint64_t auth_tag_len //!< Authenticated Tag Length in bytes. Valid values are 16 (most likely), 12 or 8.
);
/**
* @brief End decryption of a AES-128-GCM Encryption message
*
* @requires SSE4.1 and AESNI
*
*/
void aesni_gcm128_dec_finalize( struct gcm_data *my_ctx_data,
uint8_t *auth_tag, //!< Authenticated Tag output.
uint64_t auth_tag_len //!< Authenticated Tag Length in bytes. Valid values are 16 (most likely), 12 or 8.
);
/**
* @brief pre-processes key data
*
* Prefills the gcm data with key values for each round and the initial sub hash key for tag encoding
*/
void aesni_gcm128_pre(uint8_t * key, struct gcm_data *gdata
);
/**
* @brief GCM-AES Encryption using 256 bit keys
*
* @requires SSE4.1 and AESNI
*
*/
void aesni_gcm256_enc(struct gcm_data *my_ctx_data,
uint8_t * out, //!< Ciphertext output. Encrypt in-place is allowed.
uint8_t const *in, //!< Plaintext input
uint64_t plaintext_len, //!< Length of data in Bytes for encryption.
uint8_t * iv, //!< Pre-counter block j0: 4 byte salt (from Security Association) concatenated with 8 byte Initialization Vector (from IPSec ESP Payload) concatenated with 0x00000001. 16-byte pointer.
uint8_t const *aad, //!< Additional Authentication Data (AAD).
uint64_t aad_len, //!< Length of AAD.
uint8_t * auth_tag, //!< Authenticated Tag output.
uint64_t auth_tag_len //!< Authenticated Tag Length in bytes (must be a multiple of 4 bytes). Valid values are 16 (most likely), 12 or 8.
);
/**
* @brief GCM-AES Decryption using 256 bit keys
*
* @requires SSE4.1 and AESNI
*
*/
void aesni_gcm256_dec(struct gcm_data *my_ctx_data,
uint8_t * out, //!< Plaintext output. Decrypt in-place is allowed.
uint8_t const *in, //!< Ciphertext input
uint64_t plaintext_len, //!< Length of data in Bytes for encryption.
uint8_t * iv, //!< Pre-counter block j0: 4 byte salt (from Security Association) concatenated with 8 byte Initialisation Vector (from IPSec ESP Payload) concatenated with 0x00000001. 16-byte pointer.
uint8_t const *aad, //!< Additional Authentication Data (AAD).
uint64_t aad_len, //!< Length of AAD.
uint8_t * auth_tag, //!< Authenticated Tag output.
uint64_t auth_tag_len //!< Authenticated Tag Length in bytes (must be a multiple of 4 bytes). Valid values are 16 (most likely), 12 or 8.
);
/**
* @brief start a AES-256-GCM Encryption message
*
* @requires SSE4.1 and AESNI
*
*/
void aesni_gcm256_init( struct gcm_data *my_ctx_data,
uint8_t * iv, //!< Pre-counter block j0: 4 byte salt (from Security Association) concatenated with 8 byte Initialization Vector (from IPSec ESP Payload) concatenated with 0x00000001. 16-byte pointer.
uint8_t const *aad, //!< Additional Authentication Data (AAD).
uint64_t aad_len //!< Length of AAD.
);
/**
* @brief encrypt a block of a AES-256-GCM Encryption message
*
* @requires SSE4.1 and AESNI
*
*/
void aesni_gcm256_enc_update( struct gcm_data *my_ctx_data,
uint8_t *out, //!< Ciphertext output. Encrypt in-place is allowed.
const uint8_t *in, //!< Plaintext input
uint64_t plaintext_len //!< Length of data in Bytes for encryption.
);
/**
* @brief decrypt a block of a AES-256-GCM Encryption message
*
* @requires SSE4.1 and AESNI
*
*/
void aesni_gcm256_dec_update( struct gcm_data *my_ctx_data,
uint8_t *out, //!< Ciphertext output. Encrypt in-place is allowed.
const uint8_t *in, //!< Plaintext input
uint64_t plaintext_len //!< Length of data in Bytes for encryption.
);
/**
* @brief End encryption of a AES-256-GCM Encryption message
*
* @requires SSE4.1 and AESNI
*
*/
void aesni_gcm256_enc_finalize( struct gcm_data *my_ctx_data,
uint8_t *auth_tag, //!< Authenticated Tag output.
uint64_t auth_tag_len //!< Authenticated Tag Length in bytes. Valid values are 16 (most likely), 12 or 8.
);
/**
* @brief End decryption of a AES-256-GCM Encryption message
*
* @requires SSE4.1 and AESNI
*
*/
void aesni_gcm256_dec_finalize( struct gcm_data *my_ctx_data,
uint8_t *auth_tag, //!< Authenticated Tag output.
uint64_t auth_tag_len //!< Authenticated Tag Length in bytes. Valid values are 16 (most likely), 12 or 8.
);
/**
* @brief pre-processes key data
*
* Prefills the gcm data with key values for each round and the initial sub hash key for tag encoding
*/
void aesni_gcm256_pre(uint8_t * key, struct gcm_data *gdata);
#ifdef __cplusplus
}
#endif //__cplusplus
#endif //ifndef _AES_GCM_h
|
