1 /* ====================================================================
2 * Copyright (c) 2001-2011 The OpenSSL Project. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in
13 * the documentation and/or other materials provided with the
16 * 3. All advertising materials mentioning features or use of this
17 * software must display the following acknowledgment:
18 * "This product includes software developed by the OpenSSL Project
19 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
21 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
22 * endorse or promote products derived from this software without
23 * prior written permission. For written permission, please contact
24 * openssl-core@openssl.org.
26 * 5. Products derived from this software may not be called "OpenSSL"
27 * nor may "OpenSSL" appear in their names without prior written
28 * permission of the OpenSSL Project.
30 * 6. Redistributions of any form whatsoever must retain the following
32 * "This product includes software developed by the OpenSSL Project
33 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
35 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
36 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
38 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
41 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
42 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
43 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
44 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
45 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
46 * OF THE POSSIBILITY OF SUCH DAMAGE.
47 * ====================================================================
51 #include <openssl/opensslconf.h>
52 #ifndef OPENSSL_NO_AES
53 # include <openssl/evp.h>
54 # include <openssl/err.h>
57 # include <openssl/aes.h>
58 # include "evp_locl.h"
60 # include "modes_lcl.h"
61 # include <openssl/rand.h>
73 AES_KEY ks; /* AES key schedule to use */
74 int key_set; /* Set if key initialised */
75 int iv_set; /* Set if an iv is set */
77 unsigned char *iv; /* Temporary IV store */
78 int ivlen; /* IV length */
80 int iv_gen; /* It is OK to generate IVs */
81 int tls_aad_len; /* TLS AAD length */
86 AES_KEY ks1, ks2; /* AES key schedules to use */
88 void (*stream) (const unsigned char *in,
89 unsigned char *out, size_t length,
90 const AES_KEY *key1, const AES_KEY *key2,
91 const unsigned char iv[16]);
95 AES_KEY ks; /* AES key schedule to use */
96 int key_set; /* Set if key initialised */
97 int iv_set; /* Set if an iv is set */
98 int tag_set; /* Set if tag is valid */
99 int len_set; /* Set if message length set */
100 int L, M; /* L and M parameters from RFC3610 */
105 # define MAXBITCHUNK ((size_t)1<<(sizeof(size_t)*8-4))
108 int vpaes_set_encrypt_key(const unsigned char *userKey, int bits,
110 int vpaes_set_decrypt_key(const unsigned char *userKey, int bits,
113 void vpaes_encrypt(const unsigned char *in, unsigned char *out,
115 void vpaes_decrypt(const unsigned char *in, unsigned char *out,
118 void vpaes_cbc_encrypt(const unsigned char *in,
121 const AES_KEY *key, unsigned char *ivec, int enc);
124 void bsaes_cbc_encrypt(const unsigned char *in, unsigned char *out,
125 size_t length, const AES_KEY *key,
126 unsigned char ivec[16], int enc);
127 void bsaes_ctr32_encrypt_blocks(const unsigned char *in, unsigned char *out,
128 size_t len, const AES_KEY *key,
129 const unsigned char ivec[16]);
130 void bsaes_xts_encrypt(const unsigned char *inp, unsigned char *out,
131 size_t len, const AES_KEY *key1,
132 const AES_KEY *key2, const unsigned char iv[16]);
133 void bsaes_xts_decrypt(const unsigned char *inp, unsigned char *out,
134 size_t len, const AES_KEY *key1,
135 const AES_KEY *key2, const unsigned char iv[16]);
138 void AES_ctr32_encrypt(const unsigned char *in, unsigned char *out,
139 size_t blocks, const AES_KEY *key,
140 const unsigned char ivec[AES_BLOCK_SIZE]);
143 void AES_xts_encrypt(const char *inp, char *out, size_t len,
144 const AES_KEY *key1, const AES_KEY *key2,
145 const unsigned char iv[16]);
146 void AES_xts_decrypt(const char *inp, char *out, size_t len,
147 const AES_KEY *key1, const AES_KEY *key2,
148 const unsigned char iv[16]);
151 # if defined(AES_ASM) && !defined(I386_ONLY) && ( \
152 ((defined(__i386) || defined(__i386__) || \
153 defined(_M_IX86)) && defined(OPENSSL_IA32_SSE2))|| \
154 defined(__x86_64) || defined(__x86_64__) || \
155 defined(_M_AMD64) || defined(_M_X64) || \
158 extern unsigned int OPENSSL_ia32cap_P[2];
161 # define VPAES_CAPABLE (OPENSSL_ia32cap_P[1]&(1<<(41-32)))
164 # define BSAES_CAPABLE (OPENSSL_ia32cap_P[1]&(1<<(41-32)))
169 # define AESNI_CAPABLE (OPENSSL_ia32cap_P[1]&(1<<(57-32)))
171 int aesni_set_encrypt_key(const unsigned char *userKey, int bits,
173 int aesni_set_decrypt_key(const unsigned char *userKey, int bits,
176 void aesni_encrypt(const unsigned char *in, unsigned char *out,
178 void aesni_decrypt(const unsigned char *in, unsigned char *out,
181 void aesni_ecb_encrypt(const unsigned char *in,
183 size_t length, const AES_KEY *key, int enc);
184 void aesni_cbc_encrypt(const unsigned char *in,
187 const AES_KEY *key, unsigned char *ivec, int enc);
189 void aesni_ctr32_encrypt_blocks(const unsigned char *in,
192 const void *key, const unsigned char *ivec);
194 void aesni_xts_encrypt(const unsigned char *in,
197 const AES_KEY *key1, const AES_KEY *key2,
198 const unsigned char iv[16]);
200 void aesni_xts_decrypt(const unsigned char *in,
203 const AES_KEY *key1, const AES_KEY *key2,
204 const unsigned char iv[16]);
206 void aesni_ccm64_encrypt_blocks(const unsigned char *in,
210 const unsigned char ivec[16],
211 unsigned char cmac[16]);
213 void aesni_ccm64_decrypt_blocks(const unsigned char *in,
217 const unsigned char ivec[16],
218 unsigned char cmac[16]);
220 static int aesni_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
221 const unsigned char *iv, int enc)
224 EVP_AES_KEY *dat = (EVP_AES_KEY *) ctx->cipher_data;
226 mode = ctx->cipher->flags & EVP_CIPH_MODE;
227 if ((mode == EVP_CIPH_ECB_MODE || mode == EVP_CIPH_CBC_MODE)
229 ret = aesni_set_decrypt_key(key, ctx->key_len * 8, ctx->cipher_data);
230 dat->block = (block128_f) aesni_decrypt;
231 dat->stream.cbc = mode == EVP_CIPH_CBC_MODE ?
232 (cbc128_f) aesni_cbc_encrypt : NULL;
234 ret = aesni_set_encrypt_key(key, ctx->key_len * 8, ctx->cipher_data);
235 dat->block = (block128_f) aesni_encrypt;
236 if (mode == EVP_CIPH_CBC_MODE)
237 dat->stream.cbc = (cbc128_f) aesni_cbc_encrypt;
238 else if (mode == EVP_CIPH_CTR_MODE)
239 dat->stream.ctr = (ctr128_f) aesni_ctr32_encrypt_blocks;
241 dat->stream.cbc = NULL;
245 EVPerr(EVP_F_AESNI_INIT_KEY, EVP_R_AES_KEY_SETUP_FAILED);
252 static int aesni_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
253 const unsigned char *in, size_t len)
255 aesni_cbc_encrypt(in, out, len, ctx->cipher_data, ctx->iv, ctx->encrypt);
260 static int aesni_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
261 const unsigned char *in, size_t len)
263 size_t bl = ctx->cipher->block_size;
268 aesni_ecb_encrypt(in, out, len, ctx->cipher_data, ctx->encrypt);
273 # define aesni_ofb_cipher aes_ofb_cipher
274 static int aesni_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
275 const unsigned char *in, size_t len);
277 # define aesni_cfb_cipher aes_cfb_cipher
278 static int aesni_cfb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
279 const unsigned char *in, size_t len);
281 # define aesni_cfb8_cipher aes_cfb8_cipher
282 static int aesni_cfb8_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
283 const unsigned char *in, size_t len);
285 # define aesni_cfb1_cipher aes_cfb1_cipher
286 static int aesni_cfb1_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
287 const unsigned char *in, size_t len);
289 # define aesni_ctr_cipher aes_ctr_cipher
290 static int aesni_ctr_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
291 const unsigned char *in, size_t len);
293 static int aesni_gcm_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
294 const unsigned char *iv, int enc)
296 EVP_AES_GCM_CTX *gctx = ctx->cipher_data;
300 aesni_set_encrypt_key(key, ctx->key_len * 8, &gctx->ks);
301 CRYPTO_gcm128_init(&gctx->gcm, &gctx->ks, (block128_f) aesni_encrypt);
302 gctx->ctr = (ctr128_f) aesni_ctr32_encrypt_blocks;
304 * If we have an iv can set it directly, otherwise use saved IV.
306 if (iv == NULL && gctx->iv_set)
309 CRYPTO_gcm128_setiv(&gctx->gcm, iv, gctx->ivlen);
314 /* If key set use IV, otherwise copy */
316 CRYPTO_gcm128_setiv(&gctx->gcm, iv, gctx->ivlen);
318 memcpy(gctx->iv, iv, gctx->ivlen);
325 # define aesni_gcm_cipher aes_gcm_cipher
326 static int aesni_gcm_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
327 const unsigned char *in, size_t len);
329 static int aesni_xts_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
330 const unsigned char *iv, int enc)
332 EVP_AES_XTS_CTX *xctx = ctx->cipher_data;
337 /* key_len is two AES keys */
339 aesni_set_encrypt_key(key, ctx->key_len * 4, &xctx->ks1);
340 xctx->xts.block1 = (block128_f) aesni_encrypt;
341 xctx->stream = aesni_xts_encrypt;
343 aesni_set_decrypt_key(key, ctx->key_len * 4, &xctx->ks1);
344 xctx->xts.block1 = (block128_f) aesni_decrypt;
345 xctx->stream = aesni_xts_decrypt;
348 aesni_set_encrypt_key(key + ctx->key_len / 2,
349 ctx->key_len * 4, &xctx->ks2);
350 xctx->xts.block2 = (block128_f) aesni_encrypt;
352 xctx->xts.key1 = &xctx->ks1;
356 xctx->xts.key2 = &xctx->ks2;
357 memcpy(ctx->iv, iv, 16);
363 # define aesni_xts_cipher aes_xts_cipher
364 static int aesni_xts_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
365 const unsigned char *in, size_t len);
367 static int aesni_ccm_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
368 const unsigned char *iv, int enc)
370 EVP_AES_CCM_CTX *cctx = ctx->cipher_data;
374 aesni_set_encrypt_key(key, ctx->key_len * 8, &cctx->ks);
375 CRYPTO_ccm128_init(&cctx->ccm, cctx->M, cctx->L,
376 &cctx->ks, (block128_f) aesni_encrypt);
377 cctx->str = enc ? (ccm128_f) aesni_ccm64_encrypt_blocks :
378 (ccm128_f) aesni_ccm64_decrypt_blocks;
382 memcpy(ctx->iv, iv, 15 - cctx->L);
388 # define aesni_ccm_cipher aes_ccm_cipher
389 static int aesni_ccm_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
390 const unsigned char *in, size_t len);
392 # define BLOCK_CIPHER_generic(nid,keylen,blocksize,ivlen,nmode,mode,MODE,flags) \
393 static const EVP_CIPHER aesni_##keylen##_##mode = { \
394 nid##_##keylen##_##nmode,blocksize,keylen/8,ivlen, \
395 flags|EVP_CIPH_##MODE##_MODE, \
397 aesni_##mode##_cipher, \
399 sizeof(EVP_AES_KEY), \
400 NULL,NULL,NULL,NULL }; \
401 static const EVP_CIPHER aes_##keylen##_##mode = { \
402 nid##_##keylen##_##nmode,blocksize, \
404 flags|EVP_CIPH_##MODE##_MODE, \
406 aes_##mode##_cipher, \
408 sizeof(EVP_AES_KEY), \
409 NULL,NULL,NULL,NULL }; \
410 const EVP_CIPHER *EVP_aes_##keylen##_##mode(void) \
411 { return AESNI_CAPABLE?&aesni_##keylen##_##mode:&aes_##keylen##_##mode; }
413 # define BLOCK_CIPHER_custom(nid,keylen,blocksize,ivlen,mode,MODE,flags) \
414 static const EVP_CIPHER aesni_##keylen##_##mode = { \
415 nid##_##keylen##_##mode,blocksize, \
416 (EVP_CIPH_##MODE##_MODE==EVP_CIPH_XTS_MODE?2:1)*keylen/8, ivlen, \
417 flags|EVP_CIPH_##MODE##_MODE, \
418 aesni_##mode##_init_key, \
419 aesni_##mode##_cipher, \
420 aes_##mode##_cleanup, \
421 sizeof(EVP_AES_##MODE##_CTX), \
422 NULL,NULL,aes_##mode##_ctrl,NULL }; \
423 static const EVP_CIPHER aes_##keylen##_##mode = { \
424 nid##_##keylen##_##mode,blocksize, \
425 (EVP_CIPH_##MODE##_MODE==EVP_CIPH_XTS_MODE?2:1)*keylen/8, ivlen, \
426 flags|EVP_CIPH_##MODE##_MODE, \
427 aes_##mode##_init_key, \
428 aes_##mode##_cipher, \
429 aes_##mode##_cleanup, \
430 sizeof(EVP_AES_##MODE##_CTX), \
431 NULL,NULL,aes_##mode##_ctrl,NULL }; \
432 const EVP_CIPHER *EVP_aes_##keylen##_##mode(void) \
433 { return AESNI_CAPABLE?&aesni_##keylen##_##mode:&aes_##keylen##_##mode; }
437 # define BLOCK_CIPHER_generic(nid,keylen,blocksize,ivlen,nmode,mode,MODE,flags) \
438 static const EVP_CIPHER aes_##keylen##_##mode = { \
439 nid##_##keylen##_##nmode,blocksize,keylen/8,ivlen, \
440 flags|EVP_CIPH_##MODE##_MODE, \
442 aes_##mode##_cipher, \
444 sizeof(EVP_AES_KEY), \
445 NULL,NULL,NULL,NULL }; \
446 const EVP_CIPHER *EVP_aes_##keylen##_##mode(void) \
447 { return &aes_##keylen##_##mode; }
449 # define BLOCK_CIPHER_custom(nid,keylen,blocksize,ivlen,mode,MODE,flags) \
450 static const EVP_CIPHER aes_##keylen##_##mode = { \
451 nid##_##keylen##_##mode,blocksize, \
452 (EVP_CIPH_##MODE##_MODE==EVP_CIPH_XTS_MODE?2:1)*keylen/8, ivlen, \
453 flags|EVP_CIPH_##MODE##_MODE, \
454 aes_##mode##_init_key, \
455 aes_##mode##_cipher, \
456 aes_##mode##_cleanup, \
457 sizeof(EVP_AES_##MODE##_CTX), \
458 NULL,NULL,aes_##mode##_ctrl,NULL }; \
459 const EVP_CIPHER *EVP_aes_##keylen##_##mode(void) \
460 { return &aes_##keylen##_##mode; }
463 # define BLOCK_CIPHER_generic_pack(nid,keylen,flags) \
464 BLOCK_CIPHER_generic(nid,keylen,16,16,cbc,cbc,CBC,flags|EVP_CIPH_FLAG_DEFAULT_ASN1) \
465 BLOCK_CIPHER_generic(nid,keylen,16,0,ecb,ecb,ECB,flags|EVP_CIPH_FLAG_DEFAULT_ASN1) \
466 BLOCK_CIPHER_generic(nid,keylen,1,16,ofb128,ofb,OFB,flags|EVP_CIPH_FLAG_DEFAULT_ASN1) \
467 BLOCK_CIPHER_generic(nid,keylen,1,16,cfb128,cfb,CFB,flags|EVP_CIPH_FLAG_DEFAULT_ASN1) \
468 BLOCK_CIPHER_generic(nid,keylen,1,16,cfb1,cfb1,CFB,flags) \
469 BLOCK_CIPHER_generic(nid,keylen,1,16,cfb8,cfb8,CFB,flags) \
470 BLOCK_CIPHER_generic(nid,keylen,1,16,ctr,ctr,CTR,flags)
472 static int aes_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
473 const unsigned char *iv, int enc)
476 EVP_AES_KEY *dat = (EVP_AES_KEY *) ctx->cipher_data;
478 mode = ctx->cipher->flags & EVP_CIPH_MODE;
479 if ((mode == EVP_CIPH_ECB_MODE || mode == EVP_CIPH_CBC_MODE)
481 # ifdef BSAES_CAPABLE
482 if (BSAES_CAPABLE && mode == EVP_CIPH_CBC_MODE) {
483 ret = AES_set_decrypt_key(key, ctx->key_len * 8, &dat->ks);
484 dat->block = (block128_f) AES_decrypt;
485 dat->stream.cbc = (cbc128_f) bsaes_cbc_encrypt;
488 # ifdef VPAES_CAPABLE
490 ret = vpaes_set_decrypt_key(key, ctx->key_len * 8, &dat->ks);
491 dat->block = (block128_f) vpaes_decrypt;
492 dat->stream.cbc = mode == EVP_CIPH_CBC_MODE ?
493 (cbc128_f) vpaes_cbc_encrypt : NULL;
497 ret = AES_set_decrypt_key(key, ctx->key_len * 8, &dat->ks);
498 dat->block = (block128_f) AES_decrypt;
499 dat->stream.cbc = mode == EVP_CIPH_CBC_MODE ?
500 (cbc128_f) AES_cbc_encrypt : NULL;
502 # ifdef BSAES_CAPABLE
503 if (BSAES_CAPABLE && mode == EVP_CIPH_CTR_MODE) {
504 ret = AES_set_encrypt_key(key, ctx->key_len * 8, &dat->ks);
505 dat->block = (block128_f) AES_encrypt;
506 dat->stream.ctr = (ctr128_f) bsaes_ctr32_encrypt_blocks;
509 # ifdef VPAES_CAPABLE
511 ret = vpaes_set_encrypt_key(key, ctx->key_len * 8, &dat->ks);
512 dat->block = (block128_f) vpaes_encrypt;
513 dat->stream.cbc = mode == EVP_CIPH_CBC_MODE ?
514 (cbc128_f) vpaes_cbc_encrypt : NULL;
518 ret = AES_set_encrypt_key(key, ctx->key_len * 8, &dat->ks);
519 dat->block = (block128_f) AES_encrypt;
520 dat->stream.cbc = mode == EVP_CIPH_CBC_MODE ?
521 (cbc128_f) AES_cbc_encrypt : NULL;
523 if (mode == EVP_CIPH_CTR_MODE)
524 dat->stream.ctr = (ctr128_f) AES_ctr32_encrypt;
529 EVPerr(EVP_F_AES_INIT_KEY, EVP_R_AES_KEY_SETUP_FAILED);
536 static int aes_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
537 const unsigned char *in, size_t len)
539 EVP_AES_KEY *dat = (EVP_AES_KEY *) ctx->cipher_data;
542 (*dat->stream.cbc) (in, out, len, &dat->ks, ctx->iv, ctx->encrypt);
543 else if (ctx->encrypt)
544 CRYPTO_cbc128_encrypt(in, out, len, &dat->ks, ctx->iv, dat->block);
546 CRYPTO_cbc128_encrypt(in, out, len, &dat->ks, ctx->iv, dat->block);
551 static int aes_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
552 const unsigned char *in, size_t len)
554 size_t bl = ctx->cipher->block_size;
556 EVP_AES_KEY *dat = (EVP_AES_KEY *) ctx->cipher_data;
561 for (i = 0, len -= bl; i <= len; i += bl)
562 (*dat->block) (in + i, out + i, &dat->ks);
567 static int aes_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
568 const unsigned char *in, size_t len)
570 EVP_AES_KEY *dat = (EVP_AES_KEY *) ctx->cipher_data;
572 CRYPTO_ofb128_encrypt(in, out, len, &dat->ks,
573 ctx->iv, &ctx->num, dat->block);
577 static int aes_cfb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
578 const unsigned char *in, size_t len)
580 EVP_AES_KEY *dat = (EVP_AES_KEY *) ctx->cipher_data;
582 CRYPTO_cfb128_encrypt(in, out, len, &dat->ks,
583 ctx->iv, &ctx->num, ctx->encrypt, dat->block);
587 static int aes_cfb8_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
588 const unsigned char *in, size_t len)
590 EVP_AES_KEY *dat = (EVP_AES_KEY *) ctx->cipher_data;
592 CRYPTO_cfb128_8_encrypt(in, out, len, &dat->ks,
593 ctx->iv, &ctx->num, ctx->encrypt, dat->block);
597 static int aes_cfb1_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
598 const unsigned char *in, size_t len)
600 EVP_AES_KEY *dat = (EVP_AES_KEY *) ctx->cipher_data;
602 if (ctx->flags & EVP_CIPH_FLAG_LENGTH_BITS) {
603 CRYPTO_cfb128_1_encrypt(in, out, len, &dat->ks,
604 ctx->iv, &ctx->num, ctx->encrypt, dat->block);
608 while (len >= MAXBITCHUNK) {
609 CRYPTO_cfb128_1_encrypt(in, out, MAXBITCHUNK * 8, &dat->ks,
610 ctx->iv, &ctx->num, ctx->encrypt, dat->block);
614 CRYPTO_cfb128_1_encrypt(in, out, len * 8, &dat->ks,
615 ctx->iv, &ctx->num, ctx->encrypt, dat->block);
620 static int aes_ctr_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
621 const unsigned char *in, size_t len)
623 unsigned int num = ctx->num;
624 EVP_AES_KEY *dat = (EVP_AES_KEY *) ctx->cipher_data;
627 CRYPTO_ctr128_encrypt_ctr32(in, out, len, &dat->ks,
628 ctx->iv, ctx->buf, &num, dat->stream.ctr);
630 CRYPTO_ctr128_encrypt(in, out, len, &dat->ks,
631 ctx->iv, ctx->buf, &num, dat->block);
632 ctx->num = (size_t)num;
636 BLOCK_CIPHER_generic_pack(NID_aes, 128, EVP_CIPH_FLAG_FIPS)
637 BLOCK_CIPHER_generic_pack(NID_aes, 192, EVP_CIPH_FLAG_FIPS)
638 BLOCK_CIPHER_generic_pack(NID_aes, 256, EVP_CIPH_FLAG_FIPS)
640 static int aes_gcm_cleanup(EVP_CIPHER_CTX *c)
642 EVP_AES_GCM_CTX *gctx = c->cipher_data;
643 OPENSSL_cleanse(&gctx->gcm, sizeof(gctx->gcm));
644 if (gctx->iv != c->iv)
645 OPENSSL_free(gctx->iv);
649 /* increment counter (64-bit int) by 1 */
650 static void ctr64_inc(unsigned char *counter)
665 static int aes_gcm_ctrl(EVP_CIPHER_CTX *c, int type, int arg, void *ptr)
667 EVP_AES_GCM_CTX *gctx = c->cipher_data;
672 gctx->ivlen = c->cipher->iv_len;
676 gctx->tls_aad_len = -1;
679 case EVP_CTRL_GCM_SET_IVLEN:
683 if (FIPS_module_mode() && !(c->flags & EVP_CIPH_FLAG_NON_FIPS_ALLOW)
687 /* Allocate memory for IV if needed */
688 if ((arg > EVP_MAX_IV_LENGTH) && (arg > gctx->ivlen)) {
689 if (gctx->iv != c->iv)
690 OPENSSL_free(gctx->iv);
691 gctx->iv = OPENSSL_malloc(arg);
698 case EVP_CTRL_GCM_SET_TAG:
699 if (arg <= 0 || arg > 16 || c->encrypt)
701 memcpy(c->buf, ptr, arg);
705 case EVP_CTRL_GCM_GET_TAG:
706 if (arg <= 0 || arg > 16 || !c->encrypt || gctx->taglen < 0)
708 memcpy(ptr, c->buf, arg);
711 case EVP_CTRL_GCM_SET_IV_FIXED:
712 /* Special case: -1 length restores whole IV */
714 memcpy(gctx->iv, ptr, gctx->ivlen);
719 * Fixed field must be at least 4 bytes and invocation field at least
722 if ((arg < 4) || (gctx->ivlen - arg) < 8)
725 memcpy(gctx->iv, ptr, arg);
726 if (c->encrypt && RAND_bytes(gctx->iv + arg, gctx->ivlen - arg) <= 0)
731 case EVP_CTRL_GCM_IV_GEN:
732 if (gctx->iv_gen == 0 || gctx->key_set == 0)
734 CRYPTO_gcm128_setiv(&gctx->gcm, gctx->iv, gctx->ivlen);
735 if (arg <= 0 || arg > gctx->ivlen)
737 memcpy(ptr, gctx->iv + gctx->ivlen - arg, arg);
739 * Invocation field will be at least 8 bytes in size and so no need
740 * to check wrap around or increment more than last 8 bytes.
742 ctr64_inc(gctx->iv + gctx->ivlen - 8);
746 case EVP_CTRL_GCM_SET_IV_INV:
747 if (gctx->iv_gen == 0 || gctx->key_set == 0 || c->encrypt)
749 memcpy(gctx->iv + gctx->ivlen - arg, ptr, arg);
750 CRYPTO_gcm128_setiv(&gctx->gcm, gctx->iv, gctx->ivlen);
754 case EVP_CTRL_AEAD_TLS1_AAD:
755 /* Save the AAD for later use */
758 memcpy(c->buf, ptr, arg);
759 gctx->tls_aad_len = arg;
761 unsigned int len = c->buf[arg - 2] << 8 | c->buf[arg - 1];
762 /* Correct length for explicit IV */
763 len -= EVP_GCM_TLS_EXPLICIT_IV_LEN;
764 /* If decrypting correct for tag too */
766 len -= EVP_GCM_TLS_TAG_LEN;
767 c->buf[arg - 2] = len >> 8;
768 c->buf[arg - 1] = len & 0xff;
770 /* Extra padding: tag appended to record */
771 return EVP_GCM_TLS_TAG_LEN;
775 EVP_CIPHER_CTX *out = ptr;
776 EVP_AES_GCM_CTX *gctx_out = out->cipher_data;
778 if (gctx->gcm.key != &gctx->ks)
780 gctx_out->gcm.key = &gctx_out->ks;
782 if (gctx->iv == c->iv)
783 gctx_out->iv = out->iv;
785 gctx_out->iv = OPENSSL_malloc(gctx->ivlen);
788 memcpy(gctx_out->iv, gctx->iv, gctx->ivlen);
799 static int aes_gcm_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
800 const unsigned char *iv, int enc)
802 EVP_AES_GCM_CTX *gctx = ctx->cipher_data;
807 # ifdef BSAES_CAPABLE
809 AES_set_encrypt_key(key, ctx->key_len * 8, &gctx->ks);
810 CRYPTO_gcm128_init(&gctx->gcm, &gctx->ks,
811 (block128_f) AES_encrypt);
812 gctx->ctr = (ctr128_f) bsaes_ctr32_encrypt_blocks;
816 # ifdef VPAES_CAPABLE
818 vpaes_set_encrypt_key(key, ctx->key_len * 8, &gctx->ks);
819 CRYPTO_gcm128_init(&gctx->gcm, &gctx->ks,
820 (block128_f) vpaes_encrypt);
825 (void)0; /* terminate potentially open 'else' */
827 AES_set_encrypt_key(key, ctx->key_len * 8, &gctx->ks);
828 CRYPTO_gcm128_init(&gctx->gcm, &gctx->ks,
829 (block128_f) AES_encrypt);
831 gctx->ctr = (ctr128_f) AES_ctr32_encrypt;
838 * If we have an iv can set it directly, otherwise use saved IV.
840 if (iv == NULL && gctx->iv_set)
843 CRYPTO_gcm128_setiv(&gctx->gcm, iv, gctx->ivlen);
848 /* If key set use IV, otherwise copy */
850 CRYPTO_gcm128_setiv(&gctx->gcm, iv, gctx->ivlen);
852 memcpy(gctx->iv, iv, gctx->ivlen);
860 * Handle TLS GCM packet format. This consists of the last portion of the IV
861 * followed by the payload and finally the tag. On encrypt generate IV,
862 * encrypt payload and write the tag. On verify retrieve IV, decrypt payload
866 static int aes_gcm_tls_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
867 const unsigned char *in, size_t len)
869 EVP_AES_GCM_CTX *gctx = ctx->cipher_data;
871 /* Encrypt/decrypt must be performed in place */
873 || len < (EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN))
876 * Set IV from start of buffer or generate IV and write to start of
879 if (EVP_CIPHER_CTX_ctrl(ctx, ctx->encrypt ?
880 EVP_CTRL_GCM_IV_GEN : EVP_CTRL_GCM_SET_IV_INV,
881 EVP_GCM_TLS_EXPLICIT_IV_LEN, out) <= 0)
884 if (CRYPTO_gcm128_aad(&gctx->gcm, ctx->buf, gctx->tls_aad_len))
886 /* Fix buffer and length to point to payload */
887 in += EVP_GCM_TLS_EXPLICIT_IV_LEN;
888 out += EVP_GCM_TLS_EXPLICIT_IV_LEN;
889 len -= EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN;
891 /* Encrypt payload */
893 if (CRYPTO_gcm128_encrypt_ctr32(&gctx->gcm,
894 in, out, len, gctx->ctr))
897 if (CRYPTO_gcm128_encrypt(&gctx->gcm, in, out, len))
901 /* Finally write tag */
902 CRYPTO_gcm128_tag(&gctx->gcm, out, EVP_GCM_TLS_TAG_LEN);
903 rv = len + EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN;
907 if (CRYPTO_gcm128_decrypt_ctr32(&gctx->gcm,
908 in, out, len, gctx->ctr))
911 if (CRYPTO_gcm128_decrypt(&gctx->gcm, in, out, len))
915 CRYPTO_gcm128_tag(&gctx->gcm, ctx->buf, EVP_GCM_TLS_TAG_LEN);
916 /* If tag mismatch wipe buffer */
917 if (memcmp(ctx->buf, in + len, EVP_GCM_TLS_TAG_LEN)) {
918 OPENSSL_cleanse(out, len);
926 gctx->tls_aad_len = -1;
930 static int aes_gcm_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
931 const unsigned char *in, size_t len)
933 EVP_AES_GCM_CTX *gctx = ctx->cipher_data;
934 /* If not set up, return error */
938 if (gctx->tls_aad_len >= 0)
939 return aes_gcm_tls_cipher(ctx, out, in, len);
945 if (CRYPTO_gcm128_aad(&gctx->gcm, in, len))
947 } else if (ctx->encrypt) {
949 if (CRYPTO_gcm128_encrypt_ctr32(&gctx->gcm,
950 in, out, len, gctx->ctr))
953 if (CRYPTO_gcm128_encrypt(&gctx->gcm, in, out, len))
958 if (CRYPTO_gcm128_decrypt_ctr32(&gctx->gcm,
959 in, out, len, gctx->ctr))
962 if (CRYPTO_gcm128_decrypt(&gctx->gcm, in, out, len))
969 if (gctx->taglen < 0)
971 if (CRYPTO_gcm128_finish(&gctx->gcm, ctx->buf, gctx->taglen) != 0)
976 CRYPTO_gcm128_tag(&gctx->gcm, ctx->buf, 16);
978 /* Don't reuse the IV */
985 # define CUSTOM_FLAGS (EVP_CIPH_FLAG_DEFAULT_ASN1 \
986 | EVP_CIPH_CUSTOM_IV | EVP_CIPH_FLAG_CUSTOM_CIPHER \
987 | EVP_CIPH_ALWAYS_CALL_INIT | EVP_CIPH_CTRL_INIT \
988 | EVP_CIPH_CUSTOM_COPY)
990 BLOCK_CIPHER_custom(NID_aes, 128, 1, 12, gcm, GCM,
991 EVP_CIPH_FLAG_FIPS | EVP_CIPH_FLAG_AEAD_CIPHER |
993 BLOCK_CIPHER_custom(NID_aes, 192, 1, 12, gcm, GCM,
994 EVP_CIPH_FLAG_FIPS | EVP_CIPH_FLAG_AEAD_CIPHER |
996 BLOCK_CIPHER_custom(NID_aes, 256, 1, 12, gcm, GCM,
997 EVP_CIPH_FLAG_FIPS | EVP_CIPH_FLAG_AEAD_CIPHER |
1000 static int aes_xts_ctrl(EVP_CIPHER_CTX *c, int type, int arg, void *ptr)
1002 EVP_AES_XTS_CTX *xctx = c->cipher_data;
1003 if (type == EVP_CTRL_COPY) {
1004 EVP_CIPHER_CTX *out = ptr;
1005 EVP_AES_XTS_CTX *xctx_out = out->cipher_data;
1006 if (xctx->xts.key1) {
1007 if (xctx->xts.key1 != &xctx->ks1)
1009 xctx_out->xts.key1 = &xctx_out->ks1;
1011 if (xctx->xts.key2) {
1012 if (xctx->xts.key2 != &xctx->ks2)
1014 xctx_out->xts.key2 = &xctx_out->ks2;
1017 } else if (type != EVP_CTRL_INIT)
1019 /* key1 and key2 are used as an indicator both key and IV are set */
1020 xctx->xts.key1 = NULL;
1021 xctx->xts.key2 = NULL;
1025 static int aes_xts_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
1026 const unsigned char *iv, int enc)
1028 EVP_AES_XTS_CTX *xctx = ctx->cipher_data;
1035 xctx->stream = enc ? AES_xts_encrypt : AES_xts_decrypt;
1037 xctx->stream = NULL;
1039 /* key_len is two AES keys */
1040 # ifdef BSAES_CAPABLE
1042 xctx->stream = enc ? bsaes_xts_encrypt : bsaes_xts_decrypt;
1045 # ifdef VPAES_CAPABLE
1046 if (VPAES_CAPABLE) {
1048 vpaes_set_encrypt_key(key, ctx->key_len * 4, &xctx->ks1);
1049 xctx->xts.block1 = (block128_f) vpaes_encrypt;
1051 vpaes_set_decrypt_key(key, ctx->key_len * 4, &xctx->ks1);
1052 xctx->xts.block1 = (block128_f) vpaes_decrypt;
1055 vpaes_set_encrypt_key(key + ctx->key_len / 2,
1056 ctx->key_len * 4, &xctx->ks2);
1057 xctx->xts.block2 = (block128_f) vpaes_encrypt;
1059 xctx->xts.key1 = &xctx->ks1;
1063 (void)0; /* terminate potentially open 'else' */
1066 AES_set_encrypt_key(key, ctx->key_len * 4, &xctx->ks1);
1067 xctx->xts.block1 = (block128_f) AES_encrypt;
1069 AES_set_decrypt_key(key, ctx->key_len * 4, &xctx->ks1);
1070 xctx->xts.block1 = (block128_f) AES_decrypt;
1073 AES_set_encrypt_key(key + ctx->key_len / 2,
1074 ctx->key_len * 4, &xctx->ks2);
1075 xctx->xts.block2 = (block128_f) AES_encrypt;
1077 xctx->xts.key1 = &xctx->ks1;
1081 xctx->xts.key2 = &xctx->ks2;
1082 memcpy(ctx->iv, iv, 16);
1088 static int aes_xts_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
1089 const unsigned char *in, size_t len)
1091 EVP_AES_XTS_CTX *xctx = ctx->cipher_data;
1092 if (!xctx->xts.key1 || !xctx->xts.key2)
1094 if (!out || !in || len < AES_BLOCK_SIZE)
1096 # ifdef OPENSSL_FIPS
1097 /* Requirement of SP800-38E */
1098 if (FIPS_module_mode() && !(ctx->flags & EVP_CIPH_FLAG_NON_FIPS_ALLOW) &&
1099 (len > (1UL << 20) * 16)) {
1100 EVPerr(EVP_F_AES_XTS_CIPHER, EVP_R_TOO_LARGE);
1105 (*xctx->stream) (in, out, len,
1106 xctx->xts.key1, xctx->xts.key2, ctx->iv);
1107 else if (CRYPTO_xts128_encrypt(&xctx->xts, ctx->iv, in, out, len,
1113 # define aes_xts_cleanup NULL
1115 # define XTS_FLAGS (EVP_CIPH_FLAG_DEFAULT_ASN1 | EVP_CIPH_CUSTOM_IV \
1116 | EVP_CIPH_ALWAYS_CALL_INIT | EVP_CIPH_CTRL_INIT \
1117 | EVP_CIPH_CUSTOM_COPY)
1119 BLOCK_CIPHER_custom(NID_aes, 128, 1, 16, xts, XTS,
1120 EVP_CIPH_FLAG_FIPS | XTS_FLAGS)
1121 BLOCK_CIPHER_custom(NID_aes, 256, 1, 16, xts, XTS,
1122 EVP_CIPH_FLAG_FIPS | XTS_FLAGS)
1124 static int aes_ccm_ctrl(EVP_CIPHER_CTX *c, int type, int arg, void *ptr)
1126 EVP_AES_CCM_CTX *cctx = c->cipher_data;
1137 case EVP_CTRL_CCM_SET_IVLEN:
1139 case EVP_CTRL_CCM_SET_L:
1140 if (arg < 2 || arg > 8)
1145 case EVP_CTRL_CCM_SET_TAG:
1146 if ((arg & 1) || arg < 4 || arg > 16)
1148 if ((c->encrypt && ptr) || (!c->encrypt && !ptr))
1152 memcpy(c->buf, ptr, arg);
1157 case EVP_CTRL_CCM_GET_TAG:
1158 if (!c->encrypt || !cctx->tag_set)
1160 if (!CRYPTO_ccm128_tag(&cctx->ccm, ptr, (size_t)arg))
1169 EVP_CIPHER_CTX *out = ptr;
1170 EVP_AES_CCM_CTX *cctx_out = out->cipher_data;
1171 if (cctx->ccm.key) {
1172 if (cctx->ccm.key != &cctx->ks)
1174 cctx_out->ccm.key = &cctx_out->ks;
1185 static int aes_ccm_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
1186 const unsigned char *iv, int enc)
1188 EVP_AES_CCM_CTX *cctx = ctx->cipher_data;
1193 # ifdef VPAES_CAPABLE
1194 if (VPAES_CAPABLE) {
1195 vpaes_set_encrypt_key(key, ctx->key_len * 8, &cctx->ks);
1196 CRYPTO_ccm128_init(&cctx->ccm, cctx->M, cctx->L,
1197 &cctx->ks, (block128_f) vpaes_encrypt);
1203 AES_set_encrypt_key(key, ctx->key_len * 8, &cctx->ks);
1204 CRYPTO_ccm128_init(&cctx->ccm, cctx->M, cctx->L,
1205 &cctx->ks, (block128_f) AES_encrypt);
1210 memcpy(ctx->iv, iv, 15 - cctx->L);
1216 static int aes_ccm_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
1217 const unsigned char *in, size_t len)
1219 EVP_AES_CCM_CTX *cctx = ctx->cipher_data;
1220 CCM128_CONTEXT *ccm = &cctx->ccm;
1221 /* If not set up, return error */
1222 if (!cctx->iv_set && !cctx->key_set)
1224 if (!ctx->encrypt && !cctx->tag_set)
1228 if (CRYPTO_ccm128_setiv(ccm, ctx->iv, 15 - cctx->L, len))
1233 /* If have AAD need message length */
1234 if (!cctx->len_set && len)
1236 CRYPTO_ccm128_aad(ccm, in, len);
1239 /* EVP_*Final() doesn't return any data */
1242 /* If not set length yet do it */
1243 if (!cctx->len_set) {
1244 if (CRYPTO_ccm128_setiv(ccm, ctx->iv, 15 - cctx->L, len))
1249 if (cctx->str ? CRYPTO_ccm128_encrypt_ccm64(ccm, in, out, len,
1251 CRYPTO_ccm128_encrypt(ccm, in, out, len))
1257 if (cctx->str ? !CRYPTO_ccm128_decrypt_ccm64(ccm, in, out, len,
1259 !CRYPTO_ccm128_decrypt(ccm, in, out, len)) {
1260 unsigned char tag[16];
1261 if (CRYPTO_ccm128_tag(ccm, tag, cctx->M)) {
1262 if (!memcmp(tag, ctx->buf, cctx->M))
1267 OPENSSL_cleanse(out, len);
1276 # define aes_ccm_cleanup NULL
1278 BLOCK_CIPHER_custom(NID_aes, 128, 1, 12, ccm, CCM,
1279 EVP_CIPH_FLAG_FIPS | CUSTOM_FLAGS)
1280 BLOCK_CIPHER_custom(NID_aes, 192, 1, 12, ccm, CCM,
1281 EVP_CIPH_FLAG_FIPS | CUSTOM_FLAGS)
1282 BLOCK_CIPHER_custom(NID_aes, 256, 1, 12, ccm, CCM,
1283 EVP_CIPH_FLAG_FIPS | CUSTOM_FLAGS)