1 /* ====================================================================
2 * Copyright (c) 2011-2013 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 * licensing@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 * ====================================================================
50 #include <openssl/opensslconf.h>
55 #if !defined(OPENSSL_NO_AES) && !defined(OPENSSL_NO_SHA1)
57 # include <openssl/evp.h>
58 # include <openssl/objects.h>
59 # include <openssl/aes.h>
60 # include <openssl/sha.h>
61 # include "evp_locl.h"
62 # include "constant_time_locl.h"
64 # ifndef EVP_CIPH_FLAG_AEAD_CIPHER
65 # define EVP_CIPH_FLAG_AEAD_CIPHER 0x200000
66 # define EVP_CTRL_AEAD_TLS1_AAD 0x16
67 # define EVP_CTRL_AEAD_SET_MAC_KEY 0x17
70 # if !defined(EVP_CIPH_FLAG_DEFAULT_ASN1)
71 # define EVP_CIPH_FLAG_DEFAULT_ASN1 0
74 # define TLS1_1_VERSION 0x0302
78 SHA_CTX head, tail, md;
79 size_t payload_length; /* AAD length in decrypt case */
82 unsigned char tls_aad[16]; /* 13 used */
86 # define NO_PAYLOAD_LENGTH ((size_t)-1)
88 # if defined(AES_ASM) && ( \
89 defined(__x86_64) || defined(__x86_64__) || \
90 defined(_M_AMD64) || defined(_M_X64) || \
93 # if defined(__GNUC__) && __GNUC__>=2 && !defined(PEDANTIC)
94 # define BSWAP(x) ({ unsigned int r=(x); asm ("bswapl %0":"=r"(r):"0"(r)); r; })
97 extern unsigned int OPENSSL_ia32cap_P[2];
98 # define AESNI_CAPABLE (1<<(57-32))
100 int aesni_set_encrypt_key(const unsigned char *userKey, int bits,
102 int aesni_set_decrypt_key(const unsigned char *userKey, int bits,
105 void aesni_cbc_encrypt(const unsigned char *in,
108 const AES_KEY *key, unsigned char *ivec, int enc);
110 void aesni_cbc_sha1_enc(const void *inp, void *out, size_t blocks,
111 const AES_KEY *key, unsigned char iv[16],
112 SHA_CTX *ctx, const void *in0);
114 # define data(ctx) ((EVP_AES_HMAC_SHA1 *)(ctx)->cipher_data)
116 static int aesni_cbc_hmac_sha1_init_key(EVP_CIPHER_CTX *ctx,
117 const unsigned char *inkey,
118 const unsigned char *iv, int enc)
120 EVP_AES_HMAC_SHA1 *key = data(ctx);
124 ret = aesni_set_encrypt_key(inkey, ctx->key_len * 8, &key->ks);
126 ret = aesni_set_decrypt_key(inkey, ctx->key_len * 8, &key->ks);
128 SHA1_Init(&key->head); /* handy when benchmarking */
129 key->tail = key->head;
132 key->payload_length = NO_PAYLOAD_LENGTH;
134 return ret < 0 ? 0 : 1;
137 # define STITCHED_CALL
139 # if !defined(STITCHED_CALL)
143 void sha1_block_data_order(void *c, const void *p, size_t len);
145 static void sha1_update(SHA_CTX *c, const void *data, size_t len)
147 const unsigned char *ptr = data;
150 if ((res = c->num)) {
151 res = SHA_CBLOCK - res;
154 SHA1_Update(c, ptr, res);
159 res = len % SHA_CBLOCK;
163 sha1_block_data_order(c, ptr, len / SHA_CBLOCK);
168 if (c->Nl < (unsigned int)len)
173 SHA1_Update(c, ptr, res);
179 # define SHA1_Update sha1_update
181 static int aesni_cbc_hmac_sha1_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
182 const unsigned char *in, size_t len)
184 EVP_AES_HMAC_SHA1 *key = data(ctx);
186 size_t plen = key->payload_length, iv = 0, /* explicit IV in TLS 1.1 and
189 # if defined(STITCHED_CALL)
190 size_t aes_off = 0, blocks;
192 sha_off = SHA_CBLOCK - key->md.num;
195 key->payload_length = NO_PAYLOAD_LENGTH;
197 if (len % AES_BLOCK_SIZE)
201 if (plen == NO_PAYLOAD_LENGTH)
204 ((plen + SHA_DIGEST_LENGTH +
205 AES_BLOCK_SIZE) & -AES_BLOCK_SIZE))
207 else if (key->aux.tls_ver >= TLS1_1_VERSION)
210 # if defined(STITCHED_CALL)
211 if (plen > (sha_off + iv)
212 && (blocks = (plen - (sha_off + iv)) / SHA_CBLOCK)) {
213 SHA1_Update(&key->md, in + iv, sha_off);
215 aesni_cbc_sha1_enc(in, out, blocks, &key->ks,
216 ctx->iv, &key->md, in + iv + sha_off);
217 blocks *= SHA_CBLOCK;
220 key->md.Nh += blocks >> 29;
221 key->md.Nl += blocks <<= 3;
222 if (key->md.Nl < (unsigned int)blocks)
229 SHA1_Update(&key->md, in + sha_off, plen - sha_off);
231 if (plen != len) { /* "TLS" mode of operation */
233 memcpy(out + aes_off, in + aes_off, plen - aes_off);
235 /* calculate HMAC and append it to payload */
236 SHA1_Final(out + plen, &key->md);
238 SHA1_Update(&key->md, out + plen, SHA_DIGEST_LENGTH);
239 SHA1_Final(out + plen, &key->md);
241 /* pad the payload|hmac */
242 plen += SHA_DIGEST_LENGTH;
243 for (l = len - plen - 1; plen < len; plen++)
245 /* encrypt HMAC|padding at once */
246 aesni_cbc_encrypt(out + aes_off, out + aes_off, len - aes_off,
247 &key->ks, ctx->iv, 1);
249 aesni_cbc_encrypt(in + aes_off, out + aes_off, len - aes_off,
250 &key->ks, ctx->iv, 1);
254 unsigned int u[SHA_DIGEST_LENGTH / sizeof(unsigned int)];
255 unsigned char c[32 + SHA_DIGEST_LENGTH];
258 /* arrange cache line alignment */
259 pmac = (void *)(((size_t)mac.c + 31) & ((size_t)0 - 32));
261 /* decrypt HMAC|padding at once */
262 aesni_cbc_encrypt(in, out, len, &key->ks, ctx->iv, 0);
264 if (plen) { /* "TLS" mode of operation */
265 size_t inp_len, mask, j, i;
266 unsigned int res, maxpad, pad, bitlen;
269 unsigned int u[SHA_LBLOCK];
270 unsigned char c[SHA_CBLOCK];
271 } *data = (void *)key->md.data;
273 if ((key->aux.tls_aad[plen - 4] << 8 | key->aux.tls_aad[plen - 3])
277 if (len < (iv + SHA_DIGEST_LENGTH + 1))
280 /* omit explicit iv */
284 /* figure out payload length */
286 maxpad = len - (SHA_DIGEST_LENGTH + 1);
287 maxpad |= (255 - maxpad) >> (sizeof(maxpad) * 8 - 8);
290 ret &= constant_time_ge(maxpad, pad);
292 inp_len = len - (SHA_DIGEST_LENGTH + pad + 1);
293 mask = (0 - ((inp_len - len) >> (sizeof(inp_len) * 8 - 1)));
297 key->aux.tls_aad[plen - 2] = inp_len >> 8;
298 key->aux.tls_aad[plen - 1] = inp_len;
302 SHA1_Update(&key->md, key->aux.tls_aad, plen);
305 len -= SHA_DIGEST_LENGTH; /* amend mac */
306 if (len >= (256 + SHA_CBLOCK)) {
307 j = (len - (256 + SHA_CBLOCK)) & (0 - SHA_CBLOCK);
308 j += SHA_CBLOCK - key->md.num;
309 SHA1_Update(&key->md, out, j);
315 /* but pretend as if we hashed padded payload */
316 bitlen = key->md.Nl + (inp_len << 3); /* at most 18 bits */
318 bitlen = BSWAP(bitlen);
321 mac.c[1] = (unsigned char)(bitlen >> 16);
322 mac.c[2] = (unsigned char)(bitlen >> 8);
323 mac.c[3] = (unsigned char)bitlen;
333 for (res = key->md.num, j = 0; j < len; j++) {
335 mask = (j - inp_len) >> (sizeof(j) * 8 - 8);
337 c |= 0x80 & ~mask & ~((inp_len - j) >> (sizeof(j) * 8 - 8));
338 data->c[res++] = (unsigned char)c;
340 if (res != SHA_CBLOCK)
343 /* j is not incremented yet */
344 mask = 0 - ((inp_len + 7 - j) >> (sizeof(j) * 8 - 1));
345 data->u[SHA_LBLOCK - 1] |= bitlen & mask;
346 sha1_block_data_order(&key->md, data, 1);
347 mask &= 0 - ((j - inp_len - 72) >> (sizeof(j) * 8 - 1));
348 pmac->u[0] |= key->md.h0 & mask;
349 pmac->u[1] |= key->md.h1 & mask;
350 pmac->u[2] |= key->md.h2 & mask;
351 pmac->u[3] |= key->md.h3 & mask;
352 pmac->u[4] |= key->md.h4 & mask;
356 for (i = res; i < SHA_CBLOCK; i++, j++)
359 if (res > SHA_CBLOCK - 8) {
360 mask = 0 - ((inp_len + 8 - j) >> (sizeof(j) * 8 - 1));
361 data->u[SHA_LBLOCK - 1] |= bitlen & mask;
362 sha1_block_data_order(&key->md, data, 1);
363 mask &= 0 - ((j - inp_len - 73) >> (sizeof(j) * 8 - 1));
364 pmac->u[0] |= key->md.h0 & mask;
365 pmac->u[1] |= key->md.h1 & mask;
366 pmac->u[2] |= key->md.h2 & mask;
367 pmac->u[3] |= key->md.h3 & mask;
368 pmac->u[4] |= key->md.h4 & mask;
370 memset(data, 0, SHA_CBLOCK);
373 data->u[SHA_LBLOCK - 1] = bitlen;
374 sha1_block_data_order(&key->md, data, 1);
375 mask = 0 - ((j - inp_len - 73) >> (sizeof(j) * 8 - 1));
376 pmac->u[0] |= key->md.h0 & mask;
377 pmac->u[1] |= key->md.h1 & mask;
378 pmac->u[2] |= key->md.h2 & mask;
379 pmac->u[3] |= key->md.h3 & mask;
380 pmac->u[4] |= key->md.h4 & mask;
383 pmac->u[0] = BSWAP(pmac->u[0]);
384 pmac->u[1] = BSWAP(pmac->u[1]);
385 pmac->u[2] = BSWAP(pmac->u[2]);
386 pmac->u[3] = BSWAP(pmac->u[3]);
387 pmac->u[4] = BSWAP(pmac->u[4]);
389 for (i = 0; i < 5; i++) {
391 pmac->c[4 * i + 0] = (unsigned char)(res >> 24);
392 pmac->c[4 * i + 1] = (unsigned char)(res >> 16);
393 pmac->c[4 * i + 2] = (unsigned char)(res >> 8);
394 pmac->c[4 * i + 3] = (unsigned char)res;
397 len += SHA_DIGEST_LENGTH;
399 SHA1_Update(&key->md, out, inp_len);
401 SHA1_Final(pmac->c, &key->md);
404 unsigned int inp_blocks, pad_blocks;
406 /* but pretend as if we hashed padded payload */
408 1 + ((SHA_CBLOCK - 9 - res) >> (sizeof(res) * 8 - 1));
409 res += (unsigned int)(len - inp_len);
410 pad_blocks = res / SHA_CBLOCK;
413 1 + ((SHA_CBLOCK - 9 - res) >> (sizeof(res) * 8 - 1));
414 for (; inp_blocks < pad_blocks; inp_blocks++)
415 sha1_block_data_order(&key->md, data, 1);
419 SHA1_Update(&key->md, pmac->c, SHA_DIGEST_LENGTH);
420 SHA1_Final(pmac->c, &key->md);
427 unsigned char *p = out + len - 1 - maxpad - SHA_DIGEST_LENGTH;
428 size_t off = out - p;
429 unsigned int c, cmask;
431 maxpad += SHA_DIGEST_LENGTH;
432 for (res = 0, i = 0, j = 0; j < maxpad; j++) {
435 ((int)(j - off - SHA_DIGEST_LENGTH)) >> (sizeof(int) *
437 res |= (c ^ pad) & ~cmask; /* ... and padding */
438 cmask &= ((int)(off - 1 - j)) >> (sizeof(int) * 8 - 1);
439 res |= (c ^ pmac->c[i]) & cmask;
442 maxpad -= SHA_DIGEST_LENGTH;
444 res = 0 - ((0 - res) >> (sizeof(res) * 8 - 1));
448 for (res = 0, i = 0; i < SHA_DIGEST_LENGTH; i++)
449 res |= out[i] ^ pmac->c[i];
450 res = 0 - ((0 - res) >> (sizeof(res) * 8 - 1));
454 pad = (pad & ~res) | (maxpad & res);
455 out = out + len - 1 - pad;
456 for (res = 0, i = 0; i < pad; i++)
459 res = (0 - res) >> (sizeof(res) * 8 - 1);
464 SHA1_Update(&key->md, out, len);
471 static int aesni_cbc_hmac_sha1_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg,
474 EVP_AES_HMAC_SHA1 *key = data(ctx);
477 case EVP_CTRL_AEAD_SET_MAC_KEY:
480 unsigned char hmac_key[64];
482 memset(hmac_key, 0, sizeof(hmac_key));
484 if (arg > (int)sizeof(hmac_key)) {
485 SHA1_Init(&key->head);
486 SHA1_Update(&key->head, ptr, arg);
487 SHA1_Final(hmac_key, &key->head);
489 memcpy(hmac_key, ptr, arg);
492 for (i = 0; i < sizeof(hmac_key); i++)
493 hmac_key[i] ^= 0x36; /* ipad */
494 SHA1_Init(&key->head);
495 SHA1_Update(&key->head, hmac_key, sizeof(hmac_key));
497 for (i = 0; i < sizeof(hmac_key); i++)
498 hmac_key[i] ^= 0x36 ^ 0x5c; /* opad */
499 SHA1_Init(&key->tail);
500 SHA1_Update(&key->tail, hmac_key, sizeof(hmac_key));
502 OPENSSL_cleanse(hmac_key, sizeof(hmac_key));
506 case EVP_CTRL_AEAD_TLS1_AAD:
508 unsigned char *p = ptr;
511 if (arg != EVP_AEAD_TLS1_AAD_LEN)
514 len = p[arg - 2] << 8 | p[arg - 1];
517 key->payload_length = len;
518 if ((key->aux.tls_ver =
519 p[arg - 4] << 8 | p[arg - 3]) >= TLS1_1_VERSION) {
520 len -= AES_BLOCK_SIZE;
521 p[arg - 2] = len >> 8;
525 SHA1_Update(&key->md, p, arg);
527 return (int)(((len + SHA_DIGEST_LENGTH +
528 AES_BLOCK_SIZE) & -AES_BLOCK_SIZE)
531 memcpy(key->aux.tls_aad, ptr, arg);
532 key->payload_length = arg;
534 return SHA_DIGEST_LENGTH;
542 static EVP_CIPHER aesni_128_cbc_hmac_sha1_cipher = {
543 # ifdef NID_aes_128_cbc_hmac_sha1
544 NID_aes_128_cbc_hmac_sha1,
549 EVP_CIPH_CBC_MODE | EVP_CIPH_FLAG_DEFAULT_ASN1 |
550 EVP_CIPH_FLAG_AEAD_CIPHER,
551 aesni_cbc_hmac_sha1_init_key,
552 aesni_cbc_hmac_sha1_cipher,
554 sizeof(EVP_AES_HMAC_SHA1),
555 EVP_CIPH_FLAG_DEFAULT_ASN1 ? NULL : EVP_CIPHER_set_asn1_iv,
556 EVP_CIPH_FLAG_DEFAULT_ASN1 ? NULL : EVP_CIPHER_get_asn1_iv,
557 aesni_cbc_hmac_sha1_ctrl,
561 static EVP_CIPHER aesni_256_cbc_hmac_sha1_cipher = {
562 # ifdef NID_aes_256_cbc_hmac_sha1
563 NID_aes_256_cbc_hmac_sha1,
568 EVP_CIPH_CBC_MODE | EVP_CIPH_FLAG_DEFAULT_ASN1 |
569 EVP_CIPH_FLAG_AEAD_CIPHER,
570 aesni_cbc_hmac_sha1_init_key,
571 aesni_cbc_hmac_sha1_cipher,
573 sizeof(EVP_AES_HMAC_SHA1),
574 EVP_CIPH_FLAG_DEFAULT_ASN1 ? NULL : EVP_CIPHER_set_asn1_iv,
575 EVP_CIPH_FLAG_DEFAULT_ASN1 ? NULL : EVP_CIPHER_get_asn1_iv,
576 aesni_cbc_hmac_sha1_ctrl,
580 const EVP_CIPHER *EVP_aes_128_cbc_hmac_sha1(void)
582 return (OPENSSL_ia32cap_P[1] & AESNI_CAPABLE ?
583 &aesni_128_cbc_hmac_sha1_cipher : NULL);
586 const EVP_CIPHER *EVP_aes_256_cbc_hmac_sha1(void)
588 return (OPENSSL_ia32cap_P[1] & AESNI_CAPABLE ?
589 &aesni_256_cbc_hmac_sha1_cipher : NULL);
592 const EVP_CIPHER *EVP_aes_128_cbc_hmac_sha1(void)
597 const EVP_CIPHER *EVP_aes_256_cbc_hmac_sha1(void)