crypto/evp/e_aes.c

   1 /*
   2  * Copyright 2001-2018 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #include <openssl/opensslconf.h>
  11 #include <openssl/crypto.h>
  12 #include <openssl/evp.h>
  13 #include <openssl/err.h>
  14 #include <string.h>
  15 #include <assert.h>
  16 #include <openssl/aes.h>
  17 #include "internal/evp_int.h"
  18 #include "modes_lcl.h"
  19 #include <openssl/rand.h>
  20 #include "evp_locl.h"
  21
  22 typedef struct {
  23     union {
  24         double align;
  25         AES_KEY ks;
  26     } ks;
  27     block128_f block;
  28     union {
  29         cbc128_f cbc;
  30         ctr128_f ctr;
  31     } stream;
  32 } EVP_AES_KEY;
  33
  34 typedef struct {
  35     union {
  36         double align;
  37         AES_KEY ks;
  38     } ks;                       /* AES key schedule to use */
  39     int key_set;                /* Set if key initialised */
  40     int iv_set;                 /* Set if an iv is set */
  41     GCM128_CONTEXT gcm;
  42     unsigned char *iv;          /* Temporary IV store */
  43     int ivlen;                  /* IV length */
  44     int taglen;
  45     int iv_gen;                 /* It is OK to generate IVs */
  46     int tls_aad_len;            /* TLS AAD length */
  47     ctr128_f ctr;
  48 } EVP_AES_GCM_CTX;
  49
  50 typedef struct {
  51     union {
  52         double align;
  53         AES_KEY ks;
  54     } ks1, ks2;                 /* AES key schedules to use */
  55     XTS128_CONTEXT xts;
  56     void (*stream) (const unsigned char *in,
  57                     unsigned char *out, size_t length,
  58                     const AES_KEY *key1, const AES_KEY *key2,
  59                     const unsigned char iv[16]);
  60 } EVP_AES_XTS_CTX;
  61
  62 typedef struct {
  63     union {
  64         double align;
  65         AES_KEY ks;
  66     } ks;                       /* AES key schedule to use */
  67     int key_set;                /* Set if key initialised */
  68     int iv_set;                 /* Set if an iv is set */
  69     int tag_set;                /* Set if tag is valid */
  70     int len_set;                /* Set if message length set */
  71     int L, M;                   /* L and M parameters from RFC3610 */
  72     int tls_aad_len;            /* TLS AAD length */
  73     CCM128_CONTEXT ccm;
  74     ccm128_f str;
  75 } EVP_AES_CCM_CTX;
  76
  77 #ifndef OPENSSL_NO_OCB
  78 typedef struct {
  79     union {
  80         double align;
  81         AES_KEY ks;
  82     } ksenc;                    /* AES key schedule to use for encryption */
  83     union {
  84         double align;
  85         AES_KEY ks;
  86     } ksdec;                    /* AES key schedule to use for decryption */
  87     int key_set;                /* Set if key initialised */
  88     int iv_set;                 /* Set if an iv is set */
  89     OCB128_CONTEXT ocb;
  90     unsigned char *iv;          /* Temporary IV store */
  91     unsigned char tag[16];
  92     unsigned char data_buf[16]; /* Store partial data blocks */
  93     unsigned char aad_buf[16];  /* Store partial AAD blocks */
  94     int data_buf_len;
  95     int aad_buf_len;
  96     int ivlen;                  /* IV length */
  97     int taglen;
  98 } EVP_AES_OCB_CTX;
  99 #endif
 100
 101 #define MAXBITCHUNK     ((size_t)1<<(sizeof(size_t)*8-4))
 102
 103 #ifdef VPAES_ASM
 104 int vpaes_set_encrypt_key(const unsigned char *userKey, int bits,
 105                           AES_KEY *key);
 106 int vpaes_set_decrypt_key(const unsigned char *userKey, int bits,
 107                           AES_KEY *key);
 108
 109 void vpaes_encrypt(const unsigned char *in, unsigned char *out,
 110                    const AES_KEY *key);
 111 void vpaes_decrypt(const unsigned char *in, unsigned char *out,
 112                    const AES_KEY *key);
 113
 114 void vpaes_cbc_encrypt(const unsigned char *in,
 115                        unsigned char *out,
 116                        size_t length,
 117                        const AES_KEY *key, unsigned char *ivec, int enc);
 118 #endif
 119 #ifdef BSAES_ASM
 120 void bsaes_cbc_encrypt(const unsigned char *in, unsigned char *out,
 121                        size_t length, const AES_KEY *key,
 122                        unsigned char ivec[16], int enc);
 123 void bsaes_ctr32_encrypt_blocks(const unsigned char *in, unsigned char *out,
 124                                 size_t len, const AES_KEY *key,
 125                                 const unsigned char ivec[16]);
 126 void bsaes_xts_encrypt(const unsigned char *inp, unsigned char *out,
 127                        size_t len, const AES_KEY *key1,
 128                        const AES_KEY *key2, const unsigned char iv[16]);
 129 void bsaes_xts_decrypt(const unsigned char *inp, unsigned char *out,
 130                        size_t len, const AES_KEY *key1,
 131                        const AES_KEY *key2, const unsigned char iv[16]);
 132 #endif
 133 #ifdef AES_CTR_ASM
 134 void AES_ctr32_encrypt(const unsigned char *in, unsigned char *out,
 135                        size_t blocks, const AES_KEY *key,
 136                        const unsigned char ivec[AES_BLOCK_SIZE]);
 137 #endif
 138 #ifdef AES_XTS_ASM
 139 void AES_xts_encrypt(const unsigned char *inp, unsigned char *out, size_t len,
 140                      const AES_KEY *key1, const AES_KEY *key2,
 141                      const unsigned char iv[16]);
 142 void AES_xts_decrypt(const unsigned char *inp, unsigned char *out, size_t len,
 143                      const AES_KEY *key1, const AES_KEY *key2,
 144                      const unsigned char iv[16]);
 145 #endif
 146
 147 #if defined(OPENSSL_CPUID_OBJ) && (defined(__powerpc__) || defined(__ppc__) || defined(_ARCH_PPC))
 148 # include "ppc_arch.h"
 149 # ifdef VPAES_ASM
 150 #  define VPAES_CAPABLE (OPENSSL_ppccap_P & PPC_ALTIVEC)
 151 # endif
 152 # define HWAES_CAPABLE  (OPENSSL_ppccap_P & PPC_CRYPTO207)
 153 # define HWAES_set_encrypt_key aes_p8_set_encrypt_key
 154 # define HWAES_set_decrypt_key aes_p8_set_decrypt_key
 155 # define HWAES_encrypt aes_p8_encrypt
 156 # define HWAES_decrypt aes_p8_decrypt
 157 # define HWAES_cbc_encrypt aes_p8_cbc_encrypt
 158 # define HWAES_ctr32_encrypt_blocks aes_p8_ctr32_encrypt_blocks
 159 # define HWAES_xts_encrypt aes_p8_xts_encrypt
 160 # define HWAES_xts_decrypt aes_p8_xts_decrypt
 161 #endif
 162
 163 #if     defined(AES_ASM) && !defined(I386_ONLY) &&      (  \
 164         ((defined(__i386)       || defined(__i386__)    || \
 165           defined(_M_IX86)) && defined(OPENSSL_IA32_SSE2))|| \
 166         defined(__x86_64)       || defined(__x86_64__)  || \
 167         defined(_M_AMD64)       || defined(_M_X64)      )
 168
 169 extern unsigned int OPENSSL_ia32cap_P[];
 170
 171 # ifdef VPAES_ASM
 172 #  define VPAES_CAPABLE   (OPENSSL_ia32cap_P[1]&(1<<(41-32)))
 173 # endif
 174 # ifdef BSAES_ASM
 175 #  define BSAES_CAPABLE   (OPENSSL_ia32cap_P[1]&(1<<(41-32)))
 176 # endif
 177 /*
 178  * AES-NI section
 179  */
 180 # define AESNI_CAPABLE   (OPENSSL_ia32cap_P[1]&(1<<(57-32)))
 181
 182 int aesni_set_encrypt_key(const unsigned char *userKey, int bits,
 183                           AES_KEY *key);
 184 int aesni_set_decrypt_key(const unsigned char *userKey, int bits,
 185                           AES_KEY *key);
 186
 187 void aesni_encrypt(const unsigned char *in, unsigned char *out,
 188                    const AES_KEY *key);
 189 void aesni_decrypt(const unsigned char *in, unsigned char *out,
 190                    const AES_KEY *key);
 191
 192 void aesni_ecb_encrypt(const unsigned char *in,
 193                        unsigned char *out,
 194                        size_t length, const AES_KEY *key, int enc);
 195 void aesni_cbc_encrypt(const unsigned char *in,
 196                        unsigned char *out,
 197                        size_t length,
 198                        const AES_KEY *key, unsigned char *ivec, int enc);
 199
 200 void aesni_ctr32_encrypt_blocks(const unsigned char *in,
 201                                 unsigned char *out,
 202                                 size_t blocks,
 203                                 const void *key, const unsigned char *ivec);
 204
 205 void aesni_xts_encrypt(const unsigned char *in,
 206                        unsigned char *out,
 207                        size_t length,
 208                        const AES_KEY *key1, const AES_KEY *key2,
 209                        const unsigned char iv[16]);
 210
 211 void aesni_xts_decrypt(const unsigned char *in,
 212                        unsigned char *out,
 213                        size_t length,
 214                        const AES_KEY *key1, const AES_KEY *key2,
 215                        const unsigned char iv[16]);
 216
 217 void aesni_ccm64_encrypt_blocks(const unsigned char *in,
 218                                 unsigned char *out,
 219                                 size_t blocks,
 220                                 const void *key,
 221                                 const unsigned char ivec[16],
 222                                 unsigned char cmac[16]);
 223
 224 void aesni_ccm64_decrypt_blocks(const unsigned char *in,
 225                                 unsigned char *out,
 226                                 size_t blocks,
 227                                 const void *key,
 228                                 const unsigned char ivec[16],
 229                                 unsigned char cmac[16]);
 230
 231 # if defined(__x86_64) || defined(__x86_64__) || defined(_M_AMD64) || defined(_M_X64)
 232 size_t aesni_gcm_encrypt(const unsigned char *in,
 233                          unsigned char *out,
 234                          size_t len,
 235                          const void *key, unsigned char ivec[16], u64 *Xi);
 236 #  define AES_gcm_encrypt aesni_gcm_encrypt
 237 size_t aesni_gcm_decrypt(const unsigned char *in,
 238                          unsigned char *out,
 239                          size_t len,
 240                          const void *key, unsigned char ivec[16], u64 *Xi);
 241 #  define AES_gcm_decrypt aesni_gcm_decrypt
 242 void gcm_ghash_avx(u64 Xi[2], const u128 Htable[16], const u8 *in,
 243                    size_t len);
 244 #  define AES_GCM_ASM(gctx)       (gctx->ctr==aesni_ctr32_encrypt_blocks && \
 245                                  gctx->gcm.ghash==gcm_ghash_avx)
 246 #  define AES_GCM_ASM2(gctx)      (gctx->gcm.block==(block128_f)aesni_encrypt && \
 247                                  gctx->gcm.ghash==gcm_ghash_avx)
 248 #  undef AES_GCM_ASM2          /* minor size optimization */
 249 # endif
 250
 251 static int aesni_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
 252                           const unsigned char *iv, int enc)
 253 {
 254     int ret, mode;
 255     EVP_AES_KEY *dat = EVP_C_DATA(EVP_AES_KEY,ctx);
 256
 257     mode = EVP_CIPHER_CTX_mode(ctx);
 258     if ((mode == EVP_CIPH_ECB_MODE || mode == EVP_CIPH_CBC_MODE)
 259         && !enc) {
 260         ret = aesni_set_decrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
 261                                     &dat->ks.ks);
 262         dat->block = (block128_f) aesni_decrypt;
 263         dat->stream.cbc = mode == EVP_CIPH_CBC_MODE ?
 264             (cbc128_f) aesni_cbc_encrypt : NULL;
 265     } else {
 266         ret = aesni_set_encrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
 267                                     &dat->ks.ks);
 268         dat->block = (block128_f) aesni_encrypt;
 269         if (mode == EVP_CIPH_CBC_MODE)
 270             dat->stream.cbc = (cbc128_f) aesni_cbc_encrypt;
 271         else if (mode == EVP_CIPH_CTR_MODE)
 272             dat->stream.ctr = (ctr128_f) aesni_ctr32_encrypt_blocks;
 273         else
 274             dat->stream.cbc = NULL;
 275     }
 276
 277     if (ret < 0) {
 278         EVPerr(EVP_F_AESNI_INIT_KEY, EVP_R_AES_KEY_SETUP_FAILED);
 279         return 0;
 280     }
 281
 282     return 1;
 283 }
 284
 285 static int aesni_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 286                             const unsigned char *in, size_t len)
 287 {
 288     aesni_cbc_encrypt(in, out, len, &EVP_C_DATA(EVP_AES_KEY,ctx)->ks.ks,
 289                       EVP_CIPHER_CTX_iv_noconst(ctx),
 290                       EVP_CIPHER_CTX_encrypting(ctx));
 291
 292     return 1;
 293 }
 294
 295 static int aesni_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 296                             const unsigned char *in, size_t len)
 297 {
 298     size_t bl = EVP_CIPHER_CTX_block_size(ctx);
 299
 300     if (len < bl)
 301         return 1;
 302
 303     aesni_ecb_encrypt(in, out, len, &EVP_C_DATA(EVP_AES_KEY,ctx)->ks.ks,
 304                       EVP_CIPHER_CTX_encrypting(ctx));
 305
 306     return 1;
 307 }
 308
 309 # define aesni_ofb_cipher aes_ofb_cipher
 310 static int aesni_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 311                             const unsigned char *in, size_t len);
 312
 313 # define aesni_cfb_cipher aes_cfb_cipher
 314 static int aesni_cfb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 315                             const unsigned char *in, size_t len);
 316
 317 # define aesni_cfb8_cipher aes_cfb8_cipher
 318 static int aesni_cfb8_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 319                              const unsigned char *in, size_t len);
 320
 321 # define aesni_cfb1_cipher aes_cfb1_cipher
 322 static int aesni_cfb1_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 323                              const unsigned char *in, size_t len);
 324
 325 # define aesni_ctr_cipher aes_ctr_cipher
 326 static int aesni_ctr_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 327                             const unsigned char *in, size_t len);
 328
 329 static int aesni_gcm_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
 330                               const unsigned char *iv, int enc)
 331 {
 332     EVP_AES_GCM_CTX *gctx = EVP_C_DATA(EVP_AES_GCM_CTX,ctx);
 333     if (!iv && !key)
 334         return 1;
 335     if (key) {
 336         aesni_set_encrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
 337                               &gctx->ks.ks);
 338         CRYPTO_gcm128_init(&gctx->gcm, &gctx->ks, (block128_f) aesni_encrypt);
 339         gctx->ctr = (ctr128_f) aesni_ctr32_encrypt_blocks;
 340         /*
 341          * If we have an iv can set it directly, otherwise use saved IV.
 342          */
 343         if (iv == NULL && gctx->iv_set)
 344             iv = gctx->iv;
 345         if (iv) {
 346             CRYPTO_gcm128_setiv(&gctx->gcm, iv, gctx->ivlen);
 347             gctx->iv_set = 1;
 348         }
 349         gctx->key_set = 1;
 350     } else {
 351         /* If key set use IV, otherwise copy */
 352         if (gctx->key_set)
 353             CRYPTO_gcm128_setiv(&gctx->gcm, iv, gctx->ivlen);
 354         else
 355             memcpy(gctx->iv, iv, gctx->ivlen);
 356         gctx->iv_set = 1;
 357         gctx->iv_gen = 0;
 358     }
 359     return 1;
 360 }
 361
 362 # define aesni_gcm_cipher aes_gcm_cipher
 363 static int aesni_gcm_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 364                             const unsigned char *in, size_t len);
 365
 366 static int aesni_xts_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
 367                               const unsigned char *iv, int enc)
 368 {
 369     EVP_AES_XTS_CTX *xctx = EVP_C_DATA(EVP_AES_XTS_CTX,ctx);
 370     if (!iv && !key)
 371         return 1;
 372
 373     if (key) {
 374         /* key_len is two AES keys */
 375         if (enc) {
 376             aesni_set_encrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 4,
 377                                   &xctx->ks1.ks);
 378             xctx->xts.block1 = (block128_f) aesni_encrypt;
 379             xctx->stream = aesni_xts_encrypt;
 380         } else {
 381             aesni_set_decrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 4,
 382                                   &xctx->ks1.ks);
 383             xctx->xts.block1 = (block128_f) aesni_decrypt;
 384             xctx->stream = aesni_xts_decrypt;
 385         }
 386
 387         aesni_set_encrypt_key(key + EVP_CIPHER_CTX_key_length(ctx) / 2,
 388                               EVP_CIPHER_CTX_key_length(ctx) * 4,
 389                               &xctx->ks2.ks);
 390         xctx->xts.block2 = (block128_f) aesni_encrypt;
 391
 392         xctx->xts.key1 = &xctx->ks1;
 393     }
 394
 395     if (iv) {
 396         xctx->xts.key2 = &xctx->ks2;
 397         memcpy(EVP_CIPHER_CTX_iv_noconst(ctx), iv, 16);
 398     }
 399
 400     return 1;
 401 }
 402
 403 # define aesni_xts_cipher aes_xts_cipher
 404 static int aesni_xts_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 405                             const unsigned char *in, size_t len);
 406
 407 static int aesni_ccm_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
 408                               const unsigned char *iv, int enc)
 409 {
 410     EVP_AES_CCM_CTX *cctx = EVP_C_DATA(EVP_AES_CCM_CTX,ctx);
 411     if (!iv && !key)
 412         return 1;
 413     if (key) {
 414         aesni_set_encrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
 415                               &cctx->ks.ks);
 416         CRYPTO_ccm128_init(&cctx->ccm, cctx->M, cctx->L,
 417                            &cctx->ks, (block128_f) aesni_encrypt);
 418         cctx->str = enc ? (ccm128_f) aesni_ccm64_encrypt_blocks :
 419             (ccm128_f) aesni_ccm64_decrypt_blocks;
 420         cctx->key_set = 1;
 421     }
 422     if (iv) {
 423         memcpy(EVP_CIPHER_CTX_iv_noconst(ctx), iv, 15 - cctx->L);
 424         cctx->iv_set = 1;
 425     }
 426     return 1;
 427 }
 428
 429 # define aesni_ccm_cipher aes_ccm_cipher
 430 static int aesni_ccm_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 431                             const unsigned char *in, size_t len);
 432
 433 # ifndef OPENSSL_NO_OCB
 434 void aesni_ocb_encrypt(const unsigned char *in, unsigned char *out,
 435                        size_t blocks, const void *key,
 436                        size_t start_block_num,
 437                        unsigned char offset_i[16],
 438                        const unsigned char L_[][16],
 439                        unsigned char checksum[16]);
 440 void aesni_ocb_decrypt(const unsigned char *in, unsigned char *out,
 441                        size_t blocks, const void *key,
 442                        size_t start_block_num,
 443                        unsigned char offset_i[16],
 444                        const unsigned char L_[][16],
 445                        unsigned char checksum[16]);
 446
 447 static int aesni_ocb_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
 448                               const unsigned char *iv, int enc)
 449 {
 450     EVP_AES_OCB_CTX *octx = EVP_C_DATA(EVP_AES_OCB_CTX,ctx);
 451     if (!iv && !key)
 452         return 1;
 453     if (key) {
 454         do {
 455             /*
 456              * We set both the encrypt and decrypt key here because decrypt
 457              * needs both. We could possibly optimise to remove setting the
 458              * decrypt for an encryption operation.
 459              */
 460             aesni_set_encrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
 461                                   &octx->ksenc.ks);
 462             aesni_set_decrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
 463                                   &octx->ksdec.ks);
 464             if (!CRYPTO_ocb128_init(&octx->ocb,
 465                                     &octx->ksenc.ks, &octx->ksdec.ks,
 466                                     (block128_f) aesni_encrypt,
 467                                     (block128_f) aesni_decrypt,
 468                                     enc ? aesni_ocb_encrypt
 469                                         : aesni_ocb_decrypt))
 470                 return 0;
 471         }
 472         while (0);
 473
 474         /*
 475          * If we have an iv we can set it directly, otherwise use saved IV.
 476          */
 477         if (iv == NULL && octx->iv_set)
 478             iv = octx->iv;
 479         if (iv) {
 480             if (CRYPTO_ocb128_setiv(&octx->ocb, iv, octx->ivlen, octx->taglen)
 481                 != 1)
 482                 return 0;
 483             octx->iv_set = 1;
 484         }
 485         octx->key_set = 1;
 486     } else {
 487         /* If key set use IV, otherwise copy */
 488         if (octx->key_set)
 489             CRYPTO_ocb128_setiv(&octx->ocb, iv, octx->ivlen, octx->taglen);
 490         else
 491             memcpy(octx->iv, iv, octx->ivlen);
 492         octx->iv_set = 1;
 493     }
 494     return 1;
 495 }
 496
 497 #  define aesni_ocb_cipher aes_ocb_cipher
 498 static int aesni_ocb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 499                             const unsigned char *in, size_t len);
 500 # endif                        /* OPENSSL_NO_OCB */
 501
 502 # define BLOCK_CIPHER_generic(nid,keylen,blocksize,ivlen,nmode,mode,MODE,flags) \
 503 static const EVP_CIPHER aesni_##keylen##_##mode = { \
 504         nid##_##keylen##_##nmode,blocksize,keylen/8,ivlen, \
 505         flags|EVP_CIPH_##MODE##_MODE,   \
 506         aesni_init_key,                 \
 507         aesni_##mode##_cipher,          \
 508         NULL,                           \
 509         sizeof(EVP_AES_KEY),            \
 510         NULL,NULL,NULL,NULL }; \
 511 static const EVP_CIPHER aes_##keylen##_##mode = { \
 512         nid##_##keylen##_##nmode,blocksize,     \
 513         keylen/8,ivlen, \
 514         flags|EVP_CIPH_##MODE##_MODE,   \
 515         aes_init_key,                   \
 516         aes_##mode##_cipher,            \
 517         NULL,                           \
 518         sizeof(EVP_AES_KEY),            \
 519         NULL,NULL,NULL,NULL }; \
 520 const EVP_CIPHER *EVP_aes_##keylen##_##mode(void) \
 521 { return AESNI_CAPABLE?&aesni_##keylen##_##mode:&aes_##keylen##_##mode; }
 522
 523 # define BLOCK_CIPHER_custom(nid,keylen,blocksize,ivlen,mode,MODE,flags) \
 524 static const EVP_CIPHER aesni_##keylen##_##mode = { \
 525         nid##_##keylen##_##mode,blocksize, \
 526         (EVP_CIPH_##MODE##_MODE==EVP_CIPH_XTS_MODE?2:1)*keylen/8, ivlen, \
 527         flags|EVP_CIPH_##MODE##_MODE,   \
 528         aesni_##mode##_init_key,        \
 529         aesni_##mode##_cipher,          \
 530         aes_##mode##_cleanup,           \
 531         sizeof(EVP_AES_##MODE##_CTX),   \
 532         NULL,NULL,aes_##mode##_ctrl,NULL }; \
 533 static const EVP_CIPHER aes_##keylen##_##mode = { \
 534         nid##_##keylen##_##mode,blocksize, \
 535         (EVP_CIPH_##MODE##_MODE==EVP_CIPH_XTS_MODE?2:1)*keylen/8, ivlen, \
 536         flags|EVP_CIPH_##MODE##_MODE,   \
 537         aes_##mode##_init_key,          \
 538         aes_##mode##_cipher,            \
 539         aes_##mode##_cleanup,           \
 540         sizeof(EVP_AES_##MODE##_CTX),   \
 541         NULL,NULL,aes_##mode##_ctrl,NULL }; \
 542 const EVP_CIPHER *EVP_aes_##keylen##_##mode(void) \
 543 { return AESNI_CAPABLE?&aesni_##keylen##_##mode:&aes_##keylen##_##mode; }
 544
 545 #elif   defined(AES_ASM) && (defined(__sparc) || defined(__sparc__))
 546
 547 # include "sparc_arch.h"
 548
 549 extern unsigned int OPENSSL_sparcv9cap_P[];
 550
 551 /*
 552  * Initial Fujitsu SPARC64 X support
 553  */
 554 # define HWAES_CAPABLE           (OPENSSL_sparcv9cap_P[0] & SPARCV9_FJAESX)
 555 # define HWAES_set_encrypt_key aes_fx_set_encrypt_key
 556 # define HWAES_set_decrypt_key aes_fx_set_decrypt_key
 557 # define HWAES_encrypt aes_fx_encrypt
 558 # define HWAES_decrypt aes_fx_decrypt
 559 # define HWAES_cbc_encrypt aes_fx_cbc_encrypt
 560 # define HWAES_ctr32_encrypt_blocks aes_fx_ctr32_encrypt_blocks
 561
 562 # define SPARC_AES_CAPABLE       (OPENSSL_sparcv9cap_P[1] & CFR_AES)
 563
 564 void aes_t4_set_encrypt_key(const unsigned char *key, int bits, AES_KEY *ks);
 565 void aes_t4_set_decrypt_key(const unsigned char *key, int bits, AES_KEY *ks);
 566 void aes_t4_encrypt(const unsigned char *in, unsigned char *out,
 567                     const AES_KEY *key);
 568 void aes_t4_decrypt(const unsigned char *in, unsigned char *out,
 569                     const AES_KEY *key);
 570 /*
 571  * Key-length specific subroutines were chosen for following reason.
 572  * Each SPARC T4 core can execute up to 8 threads which share core's
 573  * resources. Loading as much key material to registers allows to
 574  * minimize references to shared memory interface, as well as amount
 575  * of instructions in inner loops [much needed on T4]. But then having
 576  * non-key-length specific routines would require conditional branches
 577  * either in inner loops or on subroutines' entries. Former is hardly
 578  * acceptable, while latter means code size increase to size occupied
 579  * by multiple key-length specific subroutines, so why fight?
 580  */
 581 void aes128_t4_cbc_encrypt(const unsigned char *in, unsigned char *out,
 582                            size_t len, const AES_KEY *key,
 583                            unsigned char *ivec);
 584 void aes128_t4_cbc_decrypt(const unsigned char *in, unsigned char *out,
 585                            size_t len, const AES_KEY *key,
 586                            unsigned char *ivec);
 587 void aes192_t4_cbc_encrypt(const unsigned char *in, unsigned char *out,
 588                            size_t len, const AES_KEY *key,
 589                            unsigned char *ivec);
 590 void aes192_t4_cbc_decrypt(const unsigned char *in, unsigned char *out,
 591                            size_t len, const AES_KEY *key,
 592                            unsigned char *ivec);
 593 void aes256_t4_cbc_encrypt(const unsigned char *in, unsigned char *out,
 594                            size_t len, const AES_KEY *key,
 595                            unsigned char *ivec);
 596 void aes256_t4_cbc_decrypt(const unsigned char *in, unsigned char *out,
 597                            size_t len, const AES_KEY *key,
 598                            unsigned char *ivec);
 599 void aes128_t4_ctr32_encrypt(const unsigned char *in, unsigned char *out,
 600                              size_t blocks, const AES_KEY *key,
 601                              unsigned char *ivec);
 602 void aes192_t4_ctr32_encrypt(const unsigned char *in, unsigned char *out,
 603                              size_t blocks, const AES_KEY *key,
 604                              unsigned char *ivec);
 605 void aes256_t4_ctr32_encrypt(const unsigned char *in, unsigned char *out,
 606                              size_t blocks, const AES_KEY *key,
 607                              unsigned char *ivec);
 608 void aes128_t4_xts_encrypt(const unsigned char *in, unsigned char *out,
 609                            size_t blocks, const AES_KEY *key1,
 610                            const AES_KEY *key2, const unsigned char *ivec);
 611 void aes128_t4_xts_decrypt(const unsigned char *in, unsigned char *out,
 612                            size_t blocks, const AES_KEY *key1,
 613                            const AES_KEY *key2, const unsigned char *ivec);
 614 void aes256_t4_xts_encrypt(const unsigned char *in, unsigned char *out,
 615                            size_t blocks, const AES_KEY *key1,
 616                            const AES_KEY *key2, const unsigned char *ivec);
 617 void aes256_t4_xts_decrypt(const unsigned char *in, unsigned char *out,
 618                            size_t blocks, const AES_KEY *key1,
 619                            const AES_KEY *key2, const unsigned char *ivec);
 620
 621 static int aes_t4_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
 622                            const unsigned char *iv, int enc)
 623 {
 624     int ret, mode, bits;
 625     EVP_AES_KEY *dat = EVP_C_DATA(EVP_AES_KEY,ctx);
 626
 627     mode = EVP_CIPHER_CTX_mode(ctx);
 628     bits = EVP_CIPHER_CTX_key_length(ctx) * 8;
 629     if ((mode == EVP_CIPH_ECB_MODE || mode == EVP_CIPH_CBC_MODE)
 630         && !enc) {
 631         ret = 0;
 632         aes_t4_set_decrypt_key(key, bits, &dat->ks.ks);
 633         dat->block = (block128_f) aes_t4_decrypt;
 634         switch (bits) {
 635         case 128:
 636             dat->stream.cbc = mode == EVP_CIPH_CBC_MODE ?
 637                 (cbc128_f) aes128_t4_cbc_decrypt : NULL;
 638             break;
 639         case 192:
 640             dat->stream.cbc = mode == EVP_CIPH_CBC_MODE ?
 641                 (cbc128_f) aes192_t4_cbc_decrypt : NULL;
 642             break;
 643         case 256:
 644             dat->stream.cbc = mode == EVP_CIPH_CBC_MODE ?
 645                 (cbc128_f) aes256_t4_cbc_decrypt : NULL;
 646             break;
 647         default:
 648             ret = -1;
 649         }
 650     } else {
 651         ret = 0;
 652         aes_t4_set_encrypt_key(key, bits, &dat->ks.ks);
 653         dat->block = (block128_f) aes_t4_encrypt;
 654         switch (bits) {
 655         case 128:
 656             if (mode == EVP_CIPH_CBC_MODE)
 657                 dat->stream.cbc = (cbc128_f) aes128_t4_cbc_encrypt;
 658             else if (mode == EVP_CIPH_CTR_MODE)
 659                 dat->stream.ctr = (ctr128_f) aes128_t4_ctr32_encrypt;
 660             else
 661                 dat->stream.cbc = NULL;
 662             break;
 663         case 192:
 664             if (mode == EVP_CIPH_CBC_MODE)
 665                 dat->stream.cbc = (cbc128_f) aes192_t4_cbc_encrypt;
 666             else if (mode == EVP_CIPH_CTR_MODE)
 667                 dat->stream.ctr = (ctr128_f) aes192_t4_ctr32_encrypt;
 668             else
 669                 dat->stream.cbc = NULL;
 670             break;
 671         case 256:
 672             if (mode == EVP_CIPH_CBC_MODE)
 673                 dat->stream.cbc = (cbc128_f) aes256_t4_cbc_encrypt;
 674             else if (mode == EVP_CIPH_CTR_MODE)
 675                 dat->stream.ctr = (ctr128_f) aes256_t4_ctr32_encrypt;
 676             else
 677                 dat->stream.cbc = NULL;
 678             break;
 679         default:
 680             ret = -1;
 681         }
 682     }
 683
 684     if (ret < 0) {
 685         EVPerr(EVP_F_AES_T4_INIT_KEY, EVP_R_AES_KEY_SETUP_FAILED);
 686         return 0;
 687     }
 688
 689     return 1;
 690 }
 691
 692 # define aes_t4_cbc_cipher aes_cbc_cipher
 693 static int aes_t4_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 694                              const unsigned char *in, size_t len);
 695
 696 # define aes_t4_ecb_cipher aes_ecb_cipher
 697 static int aes_t4_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 698                              const unsigned char *in, size_t len);
 699
 700 # define aes_t4_ofb_cipher aes_ofb_cipher
 701 static int aes_t4_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 702                              const unsigned char *in, size_t len);
 703
 704 # define aes_t4_cfb_cipher aes_cfb_cipher
 705 static int aes_t4_cfb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 706                              const unsigned char *in, size_t len);
 707
 708 # define aes_t4_cfb8_cipher aes_cfb8_cipher
 709 static int aes_t4_cfb8_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 710                               const unsigned char *in, size_t len);
 711
 712 # define aes_t4_cfb1_cipher aes_cfb1_cipher
 713 static int aes_t4_cfb1_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 714                               const unsigned char *in, size_t len);
 715
 716 # define aes_t4_ctr_cipher aes_ctr_cipher
 717 static int aes_t4_ctr_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 718                              const unsigned char *in, size_t len);
 719
 720 static int aes_t4_gcm_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
 721                                const unsigned char *iv, int enc)
 722 {
 723     EVP_AES_GCM_CTX *gctx = EVP_C_DATA(EVP_AES_GCM_CTX,ctx);
 724     if (!iv && !key)
 725         return 1;
 726     if (key) {
 727         int bits = EVP_CIPHER_CTX_key_length(ctx) * 8;
 728         aes_t4_set_encrypt_key(key, bits, &gctx->ks.ks);
 729         CRYPTO_gcm128_init(&gctx->gcm, &gctx->ks,
 730                            (block128_f) aes_t4_encrypt);
 731         switch (bits) {
 732         case 128:
 733             gctx->ctr = (ctr128_f) aes128_t4_ctr32_encrypt;
 734             break;
 735         case 192:
 736             gctx->ctr = (ctr128_f) aes192_t4_ctr32_encrypt;
 737             break;
 738         case 256:
 739             gctx->ctr = (ctr128_f) aes256_t4_ctr32_encrypt;
 740             break;
 741         default:
 742             return 0;
 743         }
 744         /*
 745          * If we have an iv can set it directly, otherwise use saved IV.
 746          */
 747         if (iv == NULL && gctx->iv_set)
 748             iv = gctx->iv;
 749         if (iv) {
 750             CRYPTO_gcm128_setiv(&gctx->gcm, iv, gctx->ivlen);
 751             gctx->iv_set = 1;
 752         }
 753         gctx->key_set = 1;
 754     } else {
 755         /* If key set use IV, otherwise copy */
 756         if (gctx->key_set)
 757             CRYPTO_gcm128_setiv(&gctx->gcm, iv, gctx->ivlen);
 758         else
 759             memcpy(gctx->iv, iv, gctx->ivlen);
 760         gctx->iv_set = 1;
 761         gctx->iv_gen = 0;
 762     }
 763     return 1;
 764 }
 765
 766 # define aes_t4_gcm_cipher aes_gcm_cipher
 767 static int aes_t4_gcm_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 768                              const unsigned char *in, size_t len);
 769
 770 static int aes_t4_xts_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
 771                                const unsigned char *iv, int enc)
 772 {
 773     EVP_AES_XTS_CTX *xctx = EVP_C_DATA(EVP_AES_XTS_CTX,ctx);
 774     if (!iv && !key)
 775         return 1;
 776
 777     if (key) {
 778         int bits = EVP_CIPHER_CTX_key_length(ctx) * 4;
 779         xctx->stream = NULL;
 780         /* key_len is two AES keys */
 781         if (enc) {
 782             aes_t4_set_encrypt_key(key, bits, &xctx->ks1.ks);
 783             xctx->xts.block1 = (block128_f) aes_t4_encrypt;
 784             switch (bits) {
 785             case 128:
 786                 xctx->stream = aes128_t4_xts_encrypt;
 787                 break;
 788             case 256:
 789                 xctx->stream = aes256_t4_xts_encrypt;
 790                 break;
 791             default:
 792                 return 0;
 793             }
 794         } else {
 795             aes_t4_set_decrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 4,
 796                                    &xctx->ks1.ks);
 797             xctx->xts.block1 = (block128_f) aes_t4_decrypt;
 798             switch (bits) {
 799             case 128:
 800                 xctx->stream = aes128_t4_xts_decrypt;
 801                 break;
 802             case 256:
 803                 xctx->stream = aes256_t4_xts_decrypt;
 804                 break;
 805             default:
 806                 return 0;
 807             }
 808         }
 809
 810         aes_t4_set_encrypt_key(key + EVP_CIPHER_CTX_key_length(ctx) / 2,
 811                                EVP_CIPHER_CTX_key_length(ctx) * 4,
 812                                &xctx->ks2.ks);
 813         xctx->xts.block2 = (block128_f) aes_t4_encrypt;
 814
 815         xctx->xts.key1 = &xctx->ks1;
 816     }
 817
 818     if (iv) {
 819         xctx->xts.key2 = &xctx->ks2;
 820         memcpy(EVP_CIPHER_CTX_iv_noconst(ctx), iv, 16);
 821     }
 822
 823     return 1;
 824 }
 825
 826 # define aes_t4_xts_cipher aes_xts_cipher
 827 static int aes_t4_xts_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 828                              const unsigned char *in, size_t len);
 829
 830 static int aes_t4_ccm_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
 831                                const unsigned char *iv, int enc)
 832 {
 833     EVP_AES_CCM_CTX *cctx = EVP_C_DATA(EVP_AES_CCM_CTX,ctx);
 834     if (!iv && !key)
 835         return 1;
 836     if (key) {
 837         int bits = EVP_CIPHER_CTX_key_length(ctx) * 8;
 838         aes_t4_set_encrypt_key(key, bits, &cctx->ks.ks);
 839         CRYPTO_ccm128_init(&cctx->ccm, cctx->M, cctx->L,
 840                            &cctx->ks, (block128_f) aes_t4_encrypt);
 841         cctx->str = NULL;
 842         cctx->key_set = 1;
 843     }
 844     if (iv) {
 845         memcpy(EVP_CIPHER_CTX_iv_noconst(ctx), iv, 15 - cctx->L);
 846         cctx->iv_set = 1;
 847     }
 848     return 1;
 849 }
 850
 851 # define aes_t4_ccm_cipher aes_ccm_cipher
 852 static int aes_t4_ccm_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 853                              const unsigned char *in, size_t len);
 854
 855 # ifndef OPENSSL_NO_OCB
 856 static int aes_t4_ocb_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
 857                                const unsigned char *iv, int enc)
 858 {
 859     EVP_AES_OCB_CTX *octx = EVP_C_DATA(EVP_AES_OCB_CTX,ctx);
 860     if (!iv && !key)
 861         return 1;
 862     if (key) {
 863         do {
 864             /*
 865              * We set both the encrypt and decrypt key here because decrypt
 866              * needs both. We could possibly optimise to remove setting the
 867              * decrypt for an encryption operation.
 868              */
 869             aes_t4_set_encrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
 870                                    &octx->ksenc.ks);
 871             aes_t4_set_decrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
 872                                    &octx->ksdec.ks);
 873             if (!CRYPTO_ocb128_init(&octx->ocb,
 874                                     &octx->ksenc.ks, &octx->ksdec.ks,
 875                                     (block128_f) aes_t4_encrypt,
 876                                     (block128_f) aes_t4_decrypt,
 877                                     NULL))
 878                 return 0;
 879         }
 880         while (0);
 881
 882         /*
 883          * If we have an iv we can set it directly, otherwise use saved IV.
 884          */
 885         if (iv == NULL && octx->iv_set)
 886             iv = octx->iv;
 887         if (iv) {
 888             if (CRYPTO_ocb128_setiv(&octx->ocb, iv, octx->ivlen, octx->taglen)
 889                 != 1)
 890                 return 0;
 891             octx->iv_set = 1;
 892         }
 893         octx->key_set = 1;
 894     } else {
 895         /* If key set use IV, otherwise copy */
 896         if (octx->key_set)
 897             CRYPTO_ocb128_setiv(&octx->ocb, iv, octx->ivlen, octx->taglen);
 898         else
 899             memcpy(octx->iv, iv, octx->ivlen);
 900         octx->iv_set = 1;
 901     }
 902     return 1;
 903 }
 904
 905 #  define aes_t4_ocb_cipher aes_ocb_cipher
 906 static int aes_t4_ocb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
 907                              const unsigned char *in, size_t len);
 908 # endif                        /* OPENSSL_NO_OCB */
 909
 910 # define BLOCK_CIPHER_generic(nid,keylen,blocksize,ivlen,nmode,mode,MODE,flags) \
 911 static const EVP_CIPHER aes_t4_##keylen##_##mode = { \
 912         nid##_##keylen##_##nmode,blocksize,keylen/8,ivlen, \
 913         flags|EVP_CIPH_##MODE##_MODE,   \
 914         aes_t4_init_key,                \
 915         aes_t4_##mode##_cipher,         \
 916         NULL,                           \
 917         sizeof(EVP_AES_KEY),            \
 918         NULL,NULL,NULL,NULL }; \
 919 static const EVP_CIPHER aes_##keylen##_##mode = { \
 920         nid##_##keylen##_##nmode,blocksize,     \
 921         keylen/8,ivlen, \
 922         flags|EVP_CIPH_##MODE##_MODE,   \
 923         aes_init_key,                   \
 924         aes_##mode##_cipher,            \
 925         NULL,                           \
 926         sizeof(EVP_AES_KEY),            \
 927         NULL,NULL,NULL,NULL }; \
 928 const EVP_CIPHER *EVP_aes_##keylen##_##mode(void) \
 929 { return SPARC_AES_CAPABLE?&aes_t4_##keylen##_##mode:&aes_##keylen##_##mode; }
 930
 931 # define BLOCK_CIPHER_custom(nid,keylen,blocksize,ivlen,mode,MODE,flags) \
 932 static const EVP_CIPHER aes_t4_##keylen##_##mode = { \
 933         nid##_##keylen##_##mode,blocksize, \
 934         (EVP_CIPH_##MODE##_MODE==EVP_CIPH_XTS_MODE?2:1)*keylen/8, ivlen, \
 935         flags|EVP_CIPH_##MODE##_MODE,   \
 936         aes_t4_##mode##_init_key,       \
 937         aes_t4_##mode##_cipher,         \
 938         aes_##mode##_cleanup,           \
 939         sizeof(EVP_AES_##MODE##_CTX),   \
 940         NULL,NULL,aes_##mode##_ctrl,NULL }; \
 941 static const EVP_CIPHER aes_##keylen##_##mode = { \
 942         nid##_##keylen##_##mode,blocksize, \
 943         (EVP_CIPH_##MODE##_MODE==EVP_CIPH_XTS_MODE?2:1)*keylen/8, ivlen, \
 944         flags|EVP_CIPH_##MODE##_MODE,   \
 945         aes_##mode##_init_key,          \
 946         aes_##mode##_cipher,            \
 947         aes_##mode##_cleanup,           \
 948         sizeof(EVP_AES_##MODE##_CTX),   \
 949         NULL,NULL,aes_##mode##_ctrl,NULL }; \
 950 const EVP_CIPHER *EVP_aes_##keylen##_##mode(void) \
 951 { return SPARC_AES_CAPABLE?&aes_t4_##keylen##_##mode:&aes_##keylen##_##mode; }
 952
 953 #elif defined(OPENSSL_CPUID_OBJ) && defined(__s390__)
 954 /*
 955  * IBM S390X support
 956  */
 957 # include "s390x_arch.h"
 958
 959 typedef struct {
 960     union {
 961         double align;
 962         /*-
 963          * KM-AES parameter block - begin
 964          * (see z/Architecture Principles of Operation >= SA22-7832-06)
 965          */
 966         struct {
 967             unsigned char k[32];
 968         } param;
 969         /* KM-AES parameter block - end */
 970     } km;
 971     unsigned int fc;
 972 } S390X_AES_ECB_CTX;
 973
 974 typedef struct {
 975     union {
 976         double align;
 977         /*-
 978          * KMO-AES parameter block - begin
 979          * (see z/Architecture Principles of Operation >= SA22-7832-08)
 980          */
 981         struct {
 982             unsigned char cv[16];
 983             unsigned char k[32];
 984         } param;
 985         /* KMO-AES parameter block - end */
 986     } kmo;
 987     unsigned int fc;
 988
 989     int res;
 990 } S390X_AES_OFB_CTX;
 991
 992 typedef struct {
 993     union {
 994         double align;
 995         /*-
 996          * KMF-AES parameter block - begin
 997          * (see z/Architecture Principles of Operation >= SA22-7832-08)
 998          */
 999         struct {
1000             unsigned char cv[16];
1001             unsigned char k[32];
1002         } param;
1003         /* KMF-AES parameter block - end */
1004     } kmf;
1005     unsigned int fc;
1006
1007     int res;
1008 } S390X_AES_CFB_CTX;
1009
1010 typedef struct {
1011     union {
1012         double align;
1013         /*-
1014          * KMA-GCM-AES parameter block - begin
1015          * (see z/Architecture Principles of Operation >= SA22-7832-11)
1016          */
1017         struct {
1018             unsigned char reserved[12];
1019             union {
1020                 unsigned int w;
1021                 unsigned char b[4];
1022             } cv;
1023             union {
1024                 unsigned long long g[2];
1025                 unsigned char b[16];
1026             } t;
1027             unsigned char h[16];
1028             unsigned long long taadl;
1029             unsigned long long tpcl;
1030             union {
1031                 unsigned long long g[2];
1032                 unsigned int w[4];
1033             } j0;
1034             unsigned char k[32];
1035         } param;
1036         /* KMA-GCM-AES parameter block - end */
1037     } kma;
1038     unsigned int fc;
1039     int key_set;
1040
1041     unsigned char *iv;
1042     int ivlen;
1043     int iv_set;
1044     int iv_gen;
1045
1046     int taglen;
1047
1048     unsigned char ares[16];
1049     unsigned char mres[16];
1050     unsigned char kres[16];
1051     int areslen;
1052     int mreslen;
1053     int kreslen;
1054
1055     int tls_aad_len;
1056 } S390X_AES_GCM_CTX;
1057
1058 typedef struct {
1059     union {
1060         double align;
1061         /*-
1062          * Padding is chosen so that ccm.kmac_param.k overlaps with key.k and
1063          * ccm.fc with key.k.rounds. Remember that on s390x, an AES_KEY's
1064          * rounds field is used to store the function code and that the key
1065          * schedule is not stored (if aes hardware support is detected).
1066          */
1067         struct {
1068             unsigned char pad[16];
1069             AES_KEY k;
1070         } key;
1071
1072         struct {
1073             /*-
1074              * KMAC-AES parameter block - begin
1075              * (see z/Architecture Principles of Operation >= SA22-7832-08)
1076              */
1077             struct {
1078                 union {
1079                     unsigned long long g[2];
1080                     unsigned char b[16];
1081                 } icv;
1082                 unsigned char k[32];
1083             } kmac_param;
1084             /* KMAC-AES paramater block - end */
1085
1086             union {
1087                 unsigned long long g[2];
1088                 unsigned char b[16];
1089             } nonce;
1090             union {
1091                 unsigned long long g[2];
1092                 unsigned char b[16];
1093             } buf;
1094
1095             unsigned long long blocks;
1096             int l;
1097             int m;
1098             int tls_aad_len;
1099             int iv_set;
1100             int tag_set;
1101             int len_set;
1102             int key_set;
1103
1104             unsigned char pad[140];
1105             unsigned int fc;
1106         } ccm;
1107     } aes;
1108 } S390X_AES_CCM_CTX;
1109
1110 /* Convert key size to function code: [16,24,32] -> [18,19,20]. */
1111 # define S390X_AES_FC(keylen)  (S390X_AES_128 + ((((keylen) << 3) - 128) >> 6))
1112
1113 /* Most modes of operation need km for partial block processing. */
1114 # define S390X_aes_128_CAPABLE (OPENSSL_s390xcap_P.km[0] &      \
1115                                 S390X_CAPBIT(S390X_AES_128))
1116 # define S390X_aes_192_CAPABLE (OPENSSL_s390xcap_P.km[0] &      \
1117                                 S390X_CAPBIT(S390X_AES_192))
1118 # define S390X_aes_256_CAPABLE (OPENSSL_s390xcap_P.km[0] &      \
1119                                 S390X_CAPBIT(S390X_AES_256))
1120
1121 # define s390x_aes_init_key aes_init_key
1122 static int s390x_aes_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
1123                               const unsigned char *iv, int enc);
1124
1125 # define S390X_aes_128_cbc_CAPABLE      1       /* checked by callee */
1126 # define S390X_aes_192_cbc_CAPABLE      1
1127 # define S390X_aes_256_cbc_CAPABLE      1
1128 # define S390X_AES_CBC_CTX              EVP_AES_KEY
1129
1130 # define s390x_aes_cbc_init_key aes_init_key
1131
1132 # define s390x_aes_cbc_cipher aes_cbc_cipher
1133 static int s390x_aes_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
1134                                 const unsigned char *in, size_t len);
1135
1136 # define S390X_aes_128_ecb_CAPABLE      S390X_aes_128_CAPABLE
1137 # define S390X_aes_192_ecb_CAPABLE      S390X_aes_192_CAPABLE
1138 # define S390X_aes_256_ecb_CAPABLE      S390X_aes_256_CAPABLE
1139
1140 static int s390x_aes_ecb_init_key(EVP_CIPHER_CTX *ctx,
1141                                   const unsigned char *key,
1142                                   const unsigned char *iv, int enc)
1143 {
1144     S390X_AES_ECB_CTX *cctx = EVP_C_DATA(S390X_AES_ECB_CTX, ctx);
1145     const int keylen = EVP_CIPHER_CTX_key_length(ctx);
1146
1147     cctx->fc = S390X_AES_FC(keylen);
1148     if (!enc)
1149         cctx->fc |= S390X_DECRYPT;
1150
1151     memcpy(cctx->km.param.k, key, keylen);
1152     return 1;
1153 }
1154
1155 static int s390x_aes_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
1156                                 const unsigned char *in, size_t len)
1157 {
1158     S390X_AES_ECB_CTX *cctx = EVP_C_DATA(S390X_AES_ECB_CTX, ctx);
1159
1160     s390x_km(in, len, out, cctx->fc, &cctx->km.param);
1161     return 1;
1162 }
1163
1164 # define S390X_aes_128_ofb_CAPABLE (S390X_aes_128_CAPABLE &&            \
1165                                     (OPENSSL_s390xcap_P.kmo[0] &        \
1166                                      S390X_CAPBIT(S390X_AES_128)))
1167 # define S390X_aes_192_ofb_CAPABLE (S390X_aes_192_CAPABLE &&            \
1168                                     (OPENSSL_s390xcap_P.kmo[0] &        \
1169                                      S390X_CAPBIT(S390X_AES_192)))
1170 # define S390X_aes_256_ofb_CAPABLE (S390X_aes_256_CAPABLE &&            \
1171                                     (OPENSSL_s390xcap_P.kmo[0] &        \
1172                                      S390X_CAPBIT(S390X_AES_256)))
1173
1174 static int s390x_aes_ofb_init_key(EVP_CIPHER_CTX *ctx,
1175                                   const unsigned char *key,
1176                                   const unsigned char *ivec, int enc)
1177 {
1178     S390X_AES_OFB_CTX *cctx = EVP_C_DATA(S390X_AES_OFB_CTX, ctx);
1179     const unsigned char *iv = EVP_CIPHER_CTX_original_iv(ctx);
1180     const int keylen = EVP_CIPHER_CTX_key_length(ctx);
1181     const int ivlen = EVP_CIPHER_CTX_iv_length(ctx);
1182
1183     memcpy(cctx->kmo.param.cv, iv, ivlen);
1184     memcpy(cctx->kmo.param.k, key, keylen);
1185     cctx->fc = S390X_AES_FC(keylen);
1186     cctx->res = 0;
1187     return 1;
1188 }
1189
1190 static int s390x_aes_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
1191                                 const unsigned char *in, size_t len)
1192 {
1193     S390X_AES_OFB_CTX *cctx = EVP_C_DATA(S390X_AES_OFB_CTX, ctx);
1194     int n = cctx->res;
1195     int rem;
1196
1197     while (n && len) {
1198         *out = *in ^ cctx->kmo.param.cv[n];
1199         n = (n + 1) & 0xf;
1200         --len;
1201         ++in;
1202         ++out;
1203     }
1204
1205     rem = len & 0xf;
1206
1207     len &= ~(size_t)0xf;
1208     if (len) {
1209         s390x_kmo(in, len, out, cctx->fc, &cctx->kmo.param);
1210
1211         out += len;
1212         in += len;
1213     }
1214
1215     if (rem) {
1216         s390x_km(cctx->kmo.param.cv, 16, cctx->kmo.param.cv, cctx->fc,
1217                  cctx->kmo.param.k);
1218
1219         while (rem--) {
1220             out[n] = in[n] ^ cctx->kmo.param.cv[n];
1221             ++n;
1222         }
1223     }
1224
1225     cctx->res = n;
1226     return 1;
1227 }
1228
1229 # define S390X_aes_128_cfb_CAPABLE (S390X_aes_128_CAPABLE &&            \
1230                                     (OPENSSL_s390xcap_P.kmf[0] &        \
1231                                      S390X_CAPBIT(S390X_AES_128)))
1232 # define S390X_aes_192_cfb_CAPABLE (S390X_aes_192_CAPABLE &&            \
1233                                     (OPENSSL_s390xcap_P.kmf[0] &        \
1234                                      S390X_CAPBIT(S390X_AES_192)))
1235 # define S390X_aes_256_cfb_CAPABLE (S390X_aes_256_CAPABLE &&            \
1236                                     (OPENSSL_s390xcap_P.kmf[0] &        \
1237                                      S390X_CAPBIT(S390X_AES_256)))
1238
1239 static int s390x_aes_cfb_init_key(EVP_CIPHER_CTX *ctx,
1240                                   const unsigned char *key,
1241                                   const unsigned char *ivec, int enc)
1242 {
1243     S390X_AES_CFB_CTX *cctx = EVP_C_DATA(S390X_AES_CFB_CTX, ctx);
1244     const unsigned char *iv = EVP_CIPHER_CTX_original_iv(ctx);
1245     const int keylen = EVP_CIPHER_CTX_key_length(ctx);
1246     const int ivlen = EVP_CIPHER_CTX_iv_length(ctx);
1247
1248     cctx->fc = S390X_AES_FC(keylen);
1249     cctx->fc |= 16 << 24;   /* 16 bytes cipher feedback */
1250     if (!enc)
1251         cctx->fc |= S390X_DECRYPT;
1252
1253     cctx->res = 0;
1254     memcpy(cctx->kmf.param.cv, iv, ivlen);
1255     memcpy(cctx->kmf.param.k, key, keylen);
1256     return 1;
1257 }
1258
1259 static int s390x_aes_cfb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
1260                                 const unsigned char *in, size_t len)
1261 {
1262     S390X_AES_CFB_CTX *cctx = EVP_C_DATA(S390X_AES_CFB_CTX, ctx);
1263     const int keylen = EVP_CIPHER_CTX_key_length(ctx);
1264     const int enc = EVP_CIPHER_CTX_encrypting(ctx);
1265     int n = cctx->res;
1266     int rem;
1267     unsigned char tmp;
1268
1269     while (n && len) {
1270         tmp = *in;
1271         *out = cctx->kmf.param.cv[n] ^ tmp;
1272         cctx->kmf.param.cv[n] = enc ? *out : tmp;
1273         n = (n + 1) & 0xf;
1274         --len;
1275         ++in;
1276         ++out;
1277     }
1278
1279     rem = len & 0xf;
1280
1281     len &= ~(size_t)0xf;
1282     if (len) {
1283         s390x_kmf(in, len, out, cctx->fc, &cctx->kmf.param);
1284
1285         out += len;
1286         in += len;
1287     }
1288
1289     if (rem) {
1290         s390x_km(cctx->kmf.param.cv, 16, cctx->kmf.param.cv,
1291                  S390X_AES_FC(keylen), cctx->kmf.param.k);
1292
1293         while (rem--) {
1294             tmp = in[n];
1295             out[n] = cctx->kmf.param.cv[n] ^ tmp;
1296             cctx->kmf.param.cv[n] = enc ? out[n] : tmp;
1297             ++n;
1298         }
1299     }
1300
1301     cctx->res = n;
1302     return 1;
1303 }
1304
1305 # define S390X_aes_128_cfb8_CAPABLE (OPENSSL_s390xcap_P.kmf[0] &        \
1306                                      S390X_CAPBIT(S390X_AES_128))
1307 # define S390X_aes_192_cfb8_CAPABLE (OPENSSL_s390xcap_P.kmf[0] &        \
1308                                      S390X_CAPBIT(S390X_AES_192))
1309 # define S390X_aes_256_cfb8_CAPABLE (OPENSSL_s390xcap_P.kmf[0] &        \
1310                                      S390X_CAPBIT(S390X_AES_256))
1311
1312 static int s390x_aes_cfb8_init_key(EVP_CIPHER_CTX *ctx,
1313                                    const unsigned char *key,
1314                                    const unsigned char *ivec, int enc)
1315 {
1316     S390X_AES_CFB_CTX *cctx = EVP_C_DATA(S390X_AES_CFB_CTX, ctx);
1317     const unsigned char *iv = EVP_CIPHER_CTX_original_iv(ctx);
1318     const int keylen = EVP_CIPHER_CTX_key_length(ctx);
1319     const int ivlen = EVP_CIPHER_CTX_iv_length(ctx);
1320
1321     cctx->fc = S390X_AES_FC(keylen);
1322     cctx->fc |= 1 << 24;   /* 1 byte cipher feedback */
1323     if (!enc)
1324         cctx->fc |= S390X_DECRYPT;
1325
1326     memcpy(cctx->kmf.param.cv, iv, ivlen);
1327     memcpy(cctx->kmf.param.k, key, keylen);
1328     return 1;
1329 }
1330
1331 static int s390x_aes_cfb8_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
1332                                  const unsigned char *in, size_t len)
1333 {
1334     S390X_AES_CFB_CTX *cctx = EVP_C_DATA(S390X_AES_CFB_CTX, ctx);
1335
1336     s390x_kmf(in, len, out, cctx->fc, &cctx->kmf.param);
1337     return 1;
1338 }
1339
1340 # define S390X_aes_128_cfb1_CAPABLE     0
1341 # define S390X_aes_192_cfb1_CAPABLE     0
1342 # define S390X_aes_256_cfb1_CAPABLE     0
1343
1344 # define s390x_aes_cfb1_init_key aes_init_key
1345
1346 # define s390x_aes_cfb1_cipher aes_cfb1_cipher
1347 static int s390x_aes_cfb1_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
1348                                  const unsigned char *in, size_t len);
1349
1350 # define S390X_aes_128_ctr_CAPABLE      1       /* checked by callee */
1351 # define S390X_aes_192_ctr_CAPABLE      1
1352 # define S390X_aes_256_ctr_CAPABLE      1
1353 # define S390X_AES_CTR_CTX              EVP_AES_KEY
1354
1355 # define s390x_aes_ctr_init_key aes_init_key
1356
1357 # define s390x_aes_ctr_cipher aes_ctr_cipher
1358 static int s390x_aes_ctr_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
1359                                 const unsigned char *in, size_t len);
1360
1361 # define S390X_aes_128_gcm_CAPABLE (S390X_aes_128_CAPABLE &&            \
1362                                     (OPENSSL_s390xcap_P.kma[0] &        \
1363                                      S390X_CAPBIT(S390X_AES_128)))
1364 # define S390X_aes_192_gcm_CAPABLE (S390X_aes_192_CAPABLE &&            \
1365                                     (OPENSSL_s390xcap_P.kma[0] &        \
1366                                      S390X_CAPBIT(S390X_AES_192)))
1367 # define S390X_aes_256_gcm_CAPABLE (S390X_aes_256_CAPABLE &&            \
1368                                     (OPENSSL_s390xcap_P.kma[0] &        \
1369                                      S390X_CAPBIT(S390X_AES_256)))
1370
1371 /* iv + padding length for iv lenghts != 12 */
1372 # define S390X_gcm_ivpadlen(i)  ((((i) + 15) >> 4 << 4) + 16)
1373
1374 /*-
1375  * Process additional authenticated data. Returns 0 on success. Code is
1376  * big-endian.
1377  */
1378 static int s390x_aes_gcm_aad(S390X_AES_GCM_CTX *ctx, const unsigned char *aad,
1379                              size_t len)
1380 {
1381     unsigned long long alen;
1382     int n, rem;
1383
1384     if (ctx->kma.param.tpcl)
1385         return -2;
1386
1387     alen = ctx->kma.param.taadl + len;
1388     if (alen > (U64(1) << 61) || (sizeof(len) == 8 && alen < len))
1389         return -1;
1390     ctx->kma.param.taadl = alen;
1391
1392     n = ctx->areslen;
1393     if (n) {
1394         while (n && len) {
1395             ctx->ares[n] = *aad;
1396             n = (n + 1) & 0xf;
1397             ++aad;
1398             --len;
1399         }
1400         /* ctx->ares contains a complete block if offset has wrapped around */
1401         if (!n) {
1402             s390x_kma(ctx->ares, 16, NULL, 0, NULL, ctx->fc, &ctx->kma.param);
1403             ctx->fc |= S390X_KMA_HS;
1404         }
1405         ctx->areslen = n;
1406     }
1407
1408     rem = len & 0xf;
1409
1410     len &= ~(size_t)0xf;
1411     if (len) {
1412         s390x_kma(aad, len, NULL, 0, NULL, ctx->fc, &ctx->kma.param);
1413         aad += len;
1414         ctx->fc |= S390X_KMA_HS;
1415     }
1416
1417     if (rem) {
1418         ctx->areslen = rem;
1419
1420         do {
1421             --rem;
1422             ctx->ares[rem] = aad[rem];
1423         } while (rem);
1424     }
1425     return 0;
1426 }
1427
1428 /*-
1429  * En/de-crypt plain/cipher-text and authenticate ciphertext. Returns 0 for
1430  * success. Code is big-endian.
1431  */
1432 static int s390x_aes_gcm(S390X_AES_GCM_CTX *ctx, const unsigned char *in,
1433                          unsigned char *out, size_t len)
1434 {
1435     const unsigned char *inptr;
1436     unsigned long long mlen;
1437     union {
1438         unsigned int w[4];
1439         unsigned char b[16];
1440     } buf;
1441     size_t inlen;
1442     int n, rem, i;
1443
1444     mlen = ctx->kma.param.tpcl + len;
1445     if (mlen > ((U64(1) << 36) - 32) || (sizeof(len) == 8 && mlen < len))
1446         return -1;
1447     ctx->kma.param.tpcl = mlen;
1448
1449     n = ctx->mreslen;
1450     if (n) {
1451         inptr = in;
1452         inlen = len;
1453         while (n && inlen) {
1454             ctx->mres[n] = *inptr;
1455             n = (n + 1) & 0xf;
1456             ++inptr;
1457             --inlen;
1458         }
1459         /* ctx->mres contains a complete block if offset has wrapped around */
1460         if (!n) {
1461             s390x_kma(ctx->ares, ctx->areslen, ctx->mres, 16, buf.b,
1462                       ctx->fc | S390X_KMA_LAAD, &ctx->kma.param);
1463             ctx->fc |= S390X_KMA_HS;
1464             ctx->areslen = 0;
1465
1466             /* previous call already encrypted/decrypted its remainder,
1467              * see comment below */
1468             n = ctx->mreslen;
1469             while (n) {
1470                 *out = buf.b[n];
1471                 n = (n + 1) & 0xf;
1472                 ++out;
1473                 ++in;
1474                 --len;
1475             }
1476             ctx->mreslen = 0;
1477         }
1478     }
1479
1480     rem = len & 0xf;
1481
1482     len &= ~(size_t)0xf;
1483     if (len) {
1484         s390x_kma(ctx->ares, ctx->areslen, in, len, out,
1485                   ctx->fc | S390X_KMA_LAAD, &ctx->kma.param);
1486         in += len;
1487         out += len;
1488         ctx->fc |= S390X_KMA_HS;
1489         ctx->areslen = 0;
1490     }
1491
1492     /*-
1493      * If there is a remainder, it has to be saved such that it can be
1494      * processed by kma later. However, we also have to do the for-now
1495      * unauthenticated encryption/decryption part here and now...
1496      */
1497     if (rem) {
1498         if (!ctx->mreslen) {
1499             buf.w[0] = ctx->kma.param.j0.w[0];
1500             buf.w[1] = ctx->kma.param.j0.w[1];
1501             buf.w[2] = ctx->kma.param.j0.w[2];
1502             buf.w[3] = ctx->kma.param.cv.w + 1;
1503             s390x_km(buf.b, 16, ctx->kres, ctx->fc & 0x1f, &ctx->kma.param.k);
1504         }
1505
1506         n = ctx->mreslen;
1507         for (i = 0; i < rem; i++) {
1508             ctx->mres[n + i] = in[i];
1509             out[i] = in[i] ^ ctx->kres[n + i];
1510         }
1511
1512         ctx->mreslen += rem;
1513     }
1514     return 0;
1515 }
1516
1517 /*-
1518  * Initialize context structure. Code is big-endian.
1519  */
1520 static void s390x_aes_gcm_setiv(S390X_AES_GCM_CTX *ctx,
1521                                 const unsigned char *iv)
1522 {
1523     ctx->kma.param.t.g[0] = 0;
1524     ctx->kma.param.t.g[1] = 0;
1525     ctx->kma.param.tpcl = 0;
1526     ctx->kma.param.taadl = 0;
1527     ctx->mreslen = 0;
1528     ctx->areslen = 0;
1529     ctx->kreslen = 0;
1530
1531     if (ctx->ivlen == 12) {
1532         memcpy(&ctx->kma.param.j0, iv, ctx->ivlen);
1533         ctx->kma.param.j0.w[3] = 1;
1534         ctx->kma.param.cv.w = 1;
1535     } else {
1536         /* ctx->iv has the right size and is already padded. */
1537         memcpy(ctx->iv, iv, ctx->ivlen);
1538         s390x_kma(ctx->iv, S390X_gcm_ivpadlen(ctx->ivlen), NULL, 0, NULL,
1539                   ctx->fc, &ctx->kma.param);
1540         ctx->fc |= S390X_KMA_HS;
1541
1542         ctx->kma.param.j0.g[0] = ctx->kma.param.t.g[0];
1543         ctx->kma.param.j0.g[1] = ctx->kma.param.t.g[1];
1544         ctx->kma.param.cv.w = ctx->kma.param.j0.w[3];
1545         ctx->kma.param.t.g[0] = 0;
1546         ctx->kma.param.t.g[1] = 0;
1547     }
1548 }
1549
1550 /*-
1551  * Performs various operations on the context structure depending on control
1552  * type. Returns 1 for success, 0 for failure and -1 for unknown control type.
1553  * Code is big-endian.
1554  */
1555 static int s390x_aes_gcm_ctrl(EVP_CIPHER_CTX *c, int type, int arg, void *ptr)
1556 {
1557     S390X_AES_GCM_CTX *gctx = EVP_C_DATA(S390X_AES_GCM_CTX, c);
1558     S390X_AES_GCM_CTX *gctx_out;
1559     EVP_CIPHER_CTX *out;
1560     unsigned char *buf, *iv;
1561     int ivlen, enc, len;
1562
1563     switch (type) {
1564     case EVP_CTRL_INIT:
1565         ivlen = EVP_CIPHER_CTX_iv_length(c);
1566         iv = EVP_CIPHER_CTX_iv_noconst(c);
1567         gctx->key_set = 0;
1568         gctx->iv_set = 0;
1569         gctx->ivlen = ivlen;
1570         gctx->iv = iv;
1571         gctx->taglen = -1;
1572         gctx->iv_gen = 0;
1573         gctx->tls_aad_len = -1;
1574         return 1;
1575
1576     case EVP_CTRL_AEAD_SET_IVLEN:
1577         if (arg <= 0)
1578             return 0;
1579
1580         if (arg != 12) {
1581             iv = EVP_CIPHER_CTX_iv_noconst(c);
1582             len = S390X_gcm_ivpadlen(arg);
1583
1584             /* Allocate memory for iv if needed. */
1585             if (gctx->ivlen == 12 || len > S390X_gcm_ivpadlen(gctx->ivlen)) {
1586                 if (gctx->iv != iv)
1587                     OPENSSL_free(gctx->iv);
1588
1589                 if ((gctx->iv = OPENSSL_malloc(len)) == NULL) {
1590                     EVPerr(EVP_F_S390X_AES_GCM_CTRL, ERR_R_MALLOC_FAILURE);
1591                     return 0;
1592                 }
1593             }
1594             /* Add padding. */
1595             memset(gctx->iv + arg, 0, len - arg - 8);
1596             *((unsigned long long *)(gctx->iv + len - 8)) = arg << 3;
1597         }
1598         gctx->ivlen = arg;
1599         return 1;
1600
1601     case EVP_CTRL_AEAD_SET_TAG:
1602         buf = EVP_CIPHER_CTX_buf_noconst(c);
1603         enc = EVP_CIPHER_CTX_encrypting(c);
1604         if (arg <= 0 || arg > 16 || enc)
1605             return 0;
1606
1607         memcpy(buf, ptr, arg);
1608         gctx->taglen = arg;
1609         return 1;
1610
1611     case EVP_CTRL_AEAD_GET_TAG:
1612         enc = EVP_CIPHER_CTX_encrypting(c);
1613         if (arg <= 0 || arg > 16 || !enc || gctx->taglen < 0)
1614             return 0;
1615
1616         memcpy(ptr, gctx->kma.param.t.b, arg);
1617         return 1;
1618
1619     case EVP_CTRL_GCM_SET_IV_FIXED:
1620         /* Special case: -1 length restores whole iv */
1621         if (arg == -1) {
1622             memcpy(gctx->iv, ptr, gctx->ivlen);
1623             gctx->iv_gen = 1;
1624             return 1;
1625         }
1626         /*
1627          * Fixed field must be at least 4 bytes and invocation field at least
1628          * 8.
1629          */
1630         if ((arg < 4) || (gctx->ivlen - arg) < 8)
1631             return 0;
1632
1633         if (arg)
1634             memcpy(gctx->iv, ptr, arg);
1635
1636         enc = EVP_CIPHER_CTX_encrypting(c);
1637         if (enc && RAND_bytes(gctx->iv + arg, gctx->ivlen - arg) <= 0)
1638             return 0;
1639
1640         gctx->iv_gen = 1;
1641         return 1;
1642
1643     case EVP_CTRL_GCM_IV_GEN:
1644         if (gctx->iv_gen == 0 || gctx->key_set == 0)
1645             return 0;
1646
1647         s390x_aes_gcm_setiv(gctx, gctx->iv);
1648
1649         if (arg <= 0 || arg > gctx->ivlen)
1650             arg = gctx->ivlen;
1651
1652         memcpy(ptr, gctx->iv + gctx->ivlen - arg, arg);
1653         /*
1654          * Invocation field will be at least 8 bytes in size and so no need
1655          * to check wrap around or increment more than last 8 bytes.
1656          */
1657         (*(unsigned long long *)(gctx->iv + gctx->ivlen - 8))++;
1658         gctx->iv_set = 1;
1659         return 1;
1660
1661     case EVP_CTRL_GCM_SET_IV_INV:
1662         enc = EVP_CIPHER_CTX_encrypting(c);
1663         if (gctx->iv_gen == 0 || gctx->key_set == 0 || enc)
1664             return 0;
1665
1666         memcpy(gctx->iv + gctx->ivlen - arg, ptr, arg);
1667         s390x_aes_gcm_setiv(gctx, gctx->iv);
1668         gctx->iv_set = 1;
1669         return 1;
1670
1671     case EVP_CTRL_AEAD_TLS1_AAD:
1672         /* Save the aad for later use. */
1673         if (arg != EVP_AEAD_TLS1_AAD_LEN)
1674             return 0;
1675
1676         buf = EVP_CIPHER_CTX_buf_noconst(c);
1677         memcpy(buf, ptr, arg);
1678         gctx->tls_aad_len = arg;
1679
1680         len = buf[arg - 2] << 8 | buf[arg - 1];
1681         /* Correct length for explicit iv. */
1682         if (len < EVP_GCM_TLS_EXPLICIT_IV_LEN)
1683             return 0;
1684         len -= EVP_GCM_TLS_EXPLICIT_IV_LEN;
1685
1686         /* If decrypting correct for tag too. */
1687         enc = EVP_CIPHER_CTX_encrypting(c);
1688         if (!enc) {
1689             if (len < EVP_GCM_TLS_TAG_LEN)
1690                 return 0;
1691             len -= EVP_GCM_TLS_TAG_LEN;
1692         }
1693         buf[arg - 2] = len >> 8;
1694         buf[arg - 1] = len & 0xff;
1695         /* Extra padding: tag appended to record. */
1696         return EVP_GCM_TLS_TAG_LEN;
1697
1698     case EVP_CTRL_COPY:
1699         out = ptr;
1700         gctx_out = EVP_C_DATA(S390X_AES_GCM_CTX, out);
1701         iv = EVP_CIPHER_CTX_iv_noconst(c);
1702
1703         if (gctx->iv == iv) {
1704             gctx_out->iv = EVP_CIPHER_CTX_iv_noconst(out);
1705         } else {
1706             len = S390X_gcm_ivpadlen(gctx->ivlen);
1707
1708             if ((gctx_out->iv = OPENSSL_malloc(len)) == NULL) {
1709                 EVPerr(EVP_F_S390X_AES_GCM_CTRL, ERR_R_MALLOC_FAILURE);
1710                 return 0;
1711             }
1712
1713             memcpy(gctx_out->iv, gctx->iv, len);
1714         }
1715         return 1;
1716
1717     default:
1718         return -1;
1719     }
1720 }
1721
1722 /*-
1723  * Set key and/or iv. Returns 1 on success. Otherwise 0 is returned.
1724  */
1725 static int s390x_aes_gcm_init_key(EVP_CIPHER_CTX *ctx,
1726                                   const unsigned char *key,
1727                                   const unsigned char *iv, int enc)
1728 {
1729     S390X_AES_GCM_CTX *gctx = EVP_C_DATA(S390X_AES_GCM_CTX, ctx);
1730     int keylen;
1731
1732     if (iv == NULL && key == NULL)
1733         return 1;
1734
1735     if (key != NULL) {
1736         keylen = EVP_CIPHER_CTX_key_length(ctx);
1737         memcpy(&gctx->kma.param.k, key, keylen);
1738
1739         gctx->fc = S390X_AES_FC(keylen);
1740         if (!enc)
1741             gctx->fc |= S390X_DECRYPT;
1742
1743         if (iv == NULL && gctx->iv_set)
1744             iv = gctx->iv;
1745
1746         if (iv != NULL) {
1747             s390x_aes_gcm_setiv(gctx, iv);
1748             gctx->iv_set = 1;
1749         }
1750         gctx->key_set = 1;
1751     } else {
1752         if (gctx->key_set)
1753             s390x_aes_gcm_setiv(gctx, iv);
1754         else
1755             memcpy(gctx->iv, iv, gctx->ivlen);
1756
1757         gctx->iv_set = 1;
1758         gctx->iv_gen = 0;
1759     }
1760     return 1;
1761 }
1762
1763 /*-
1764  * En/de-crypt and authenticate TLS packet. Returns the number of bytes written
1765  * if successful. Otherwise -1 is returned. Code is big-endian.
1766  */
1767 static int s390x_aes_gcm_tls_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
1768                                     const unsigned char *in, size_t len)
1769 {
1770     S390X_AES_GCM_CTX *gctx = EVP_C_DATA(S390X_AES_GCM_CTX, ctx);
1771     const unsigned char *buf = EVP_CIPHER_CTX_buf_noconst(ctx);
1772     const int enc = EVP_CIPHER_CTX_encrypting(ctx);
1773     int rv = -1;
1774
1775     if (out != in || len < (EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN))
1776         return -1;
1777
1778     if (EVP_CIPHER_CTX_ctrl(ctx, enc ? EVP_CTRL_GCM_IV_GEN
1779                                      : EVP_CTRL_GCM_SET_IV_INV,
1780                             EVP_GCM_TLS_EXPLICIT_IV_LEN, out) <= 0)
1781         goto err;
1782
1783     in += EVP_GCM_TLS_EXPLICIT_IV_LEN;
1784     out += EVP_GCM_TLS_EXPLICIT_IV_LEN;
1785     len -= EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN;
1786
1787     gctx->kma.param.taadl = gctx->tls_aad_len << 3;
1788     gctx->kma.param.tpcl = len << 3;
1789     s390x_kma(buf, gctx->tls_aad_len, in, len, out,
1790               gctx->fc | S390X_KMA_LAAD | S390X_KMA_LPC, &gctx->kma.param);
1791
1792     if (enc) {
1793         memcpy(out + len, gctx->kma.param.t.b, EVP_GCM_TLS_TAG_LEN);
1794         rv = len + EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN;
1795     } else {
1796         if (CRYPTO_memcmp(gctx->kma.param.t.b, in + len,
1797                           EVP_GCM_TLS_TAG_LEN)) {
1798             OPENSSL_cleanse(out, len);
1799             goto err;
1800         }
1801         rv = len;
1802     }
1803 err:
1804     gctx->iv_set = 0;
1805     gctx->tls_aad_len = -1;
1806     return rv;
1807 }
1808
1809 /*-
1810  * Called from EVP layer to initialize context, process additional
1811  * authenticated data, en/de-crypt plain/cipher-text and authenticate
1812  * ciphertext or process a TLS packet, depending on context. Returns bytes
1813  * written on success. Otherwise -1 is returned. Code is big-endian.
1814  */
1815 static int s390x_aes_gcm_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
1816                                 const unsigned char *in, size_t len)
1817 {
1818     S390X_AES_GCM_CTX *gctx = EVP_C_DATA(S390X_AES_GCM_CTX, ctx);
1819     unsigned char *buf, tmp[16];
1820     int enc;
1821
1822     if (!gctx->key_set)
1823         return -1;
1824
1825     if (gctx->tls_aad_len >= 0)
1826         return s390x_aes_gcm_tls_cipher(ctx, out, in, len);
1827
1828     if (!gctx->iv_set)
1829         return -1;
1830
1831     if (in != NULL) {
1832         if (out == NULL) {
1833             if (s390x_aes_gcm_aad(gctx, in, len))
1834                 return -1;
1835         } else {
1836             if (s390x_aes_gcm(gctx, in, out, len))
1837                 return -1;
1838         }
1839         return len;
1840     } else {
1841         gctx->kma.param.taadl <<= 3;
1842         gctx->kma.param.tpcl <<= 3;
1843         s390x_kma(gctx->ares, gctx->areslen, gctx->mres, gctx->mreslen, tmp,
1844                   gctx->fc | S390X_KMA_LAAD | S390X_KMA_LPC, &gctx->kma.param);
1845         /* recall that we already did en-/decrypt gctx->mres
1846          * and returned it to caller... */
1847         OPENSSL_cleanse(tmp, gctx->mreslen);
1848         gctx->iv_set = 0;
1849
1850         enc = EVP_CIPHER_CTX_encrypting(ctx);
1851         if (enc) {
1852             gctx->taglen = 16;
1853         } else {
1854             if (gctx->taglen < 0)
1855                 return -1;
1856
1857             buf = EVP_CIPHER_CTX_buf_noconst(ctx);
1858             if (CRYPTO_memcmp(buf, gctx->kma.param.t.b, gctx->taglen))
1859                 return -1;
1860         }
1861         return 0;
1862     }
1863 }
1864
1865 static int s390x_aes_gcm_cleanup(EVP_CIPHER_CTX *c)
1866 {
1867     S390X_AES_GCM_CTX *gctx = EVP_C_DATA(S390X_AES_GCM_CTX, c);
1868     const unsigned char *iv;
1869
1870     if (gctx == NULL)
1871         return 0;
1872
1873     iv = EVP_CIPHER_CTX_iv(c);
1874     if (iv != gctx->iv)
1875         OPENSSL_free(gctx->iv);
1876
1877     OPENSSL_cleanse(gctx, sizeof(*gctx));
1878     return 1;
1879 }
1880
1881 # define S390X_AES_XTS_CTX              EVP_AES_XTS_CTX
1882 # define S390X_aes_128_xts_CAPABLE      1       /* checked by callee */
1883 # define S390X_aes_256_xts_CAPABLE      1
1884
1885 # define s390x_aes_xts_init_key aes_xts_init_key
1886 static int s390x_aes_xts_init_key(EVP_CIPHER_CTX *ctx,
1887                                   const unsigned char *key,
1888                                   const unsigned char *iv, int enc);
1889 # define s390x_aes_xts_cipher aes_xts_cipher
1890 static int s390x_aes_xts_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
1891                                 const unsigned char *in, size_t len);
1892 # define s390x_aes_xts_ctrl aes_xts_ctrl
1893 static int s390x_aes_xts_ctrl(EVP_CIPHER_CTX *, int type, int arg, void *ptr);
1894 # define s390x_aes_xts_cleanup aes_xts_cleanup
1895
1896 # define S390X_aes_128_ccm_CAPABLE (S390X_aes_128_CAPABLE &&            \
1897                                     (OPENSSL_s390xcap_P.kmac[0] &       \
1898                                      S390X_CAPBIT(S390X_AES_128)))
1899 # define S390X_aes_192_ccm_CAPABLE (S390X_aes_192_CAPABLE &&            \
1900                                     (OPENSSL_s390xcap_P.kmac[0] &       \
1901                                      S390X_CAPBIT(S390X_AES_192)))
1902 # define S390X_aes_256_ccm_CAPABLE (S390X_aes_256_CAPABLE &&            \
1903                                     (OPENSSL_s390xcap_P.kmac[0] &       \
1904                                      S390X_CAPBIT(S390X_AES_256)))
1905
1906 # define S390X_CCM_AAD_FLAG     0x40
1907
1908 /*-
1909  * Set nonce and length fields. Code is big-endian.
1910  */
1911 static inline void s390x_aes_ccm_setiv(S390X_AES_CCM_CTX *ctx,
1912                                           const unsigned char *nonce,
1913                                           size_t mlen)
1914 {
1915     ctx->aes.ccm.nonce.b[0] &= ~S390X_CCM_AAD_FLAG;
1916     ctx->aes.ccm.nonce.g[1] = mlen;
1917     memcpy(ctx->aes.ccm.nonce.b + 1, nonce, 15 - ctx->aes.ccm.l);
1918 }
1919
1920 /*-
1921  * Process additional authenticated data. Code is big-endian.
1922  */
1923 static void s390x_aes_ccm_aad(S390X_AES_CCM_CTX *ctx, const unsigned char *aad,
1924                               size_t alen)
1925 {
1926     unsigned char *ptr;
1927     int i, rem;
1928
1929     if (!alen)
1930         return;
1931
1932     ctx->aes.ccm.nonce.b[0] |= S390X_CCM_AAD_FLAG;
1933
1934     /* Suppress 'type-punned pointer dereference' warning. */
1935     ptr = ctx->aes.ccm.buf.b;
1936
1937     if (alen < ((1 << 16) - (1 << 8))) {
1938         *(uint16_t *)ptr = alen;
1939         i = 2;
1940     } else if (sizeof(alen) == 8
1941                && alen >= (size_t)1 << (32 % (sizeof(alen) * 8))) {
1942         *(uint16_t *)ptr = 0xffff;
1943         *(uint64_t *)(ptr + 2) = alen;
1944         i = 10;
1945     } else {
1946         *(uint16_t *)ptr = 0xfffe;
1947         *(uint32_t *)(ptr + 2) = alen;
1948         i = 6;
1949     }
1950
1951     while (i < 16 && alen) {
1952         ctx->aes.ccm.buf.b[i] = *aad;
1953         ++aad;
1954         --alen;
1955         ++i;
1956     }
1957     while (i < 16) {
1958         ctx->aes.ccm.buf.b[i] = 0;
1959         ++i;
1960     }
1961
1962     ctx->aes.ccm.kmac_param.icv.g[0] = 0;
1963     ctx->aes.ccm.kmac_param.icv.g[1] = 0;
1964     s390x_kmac(ctx->aes.ccm.nonce.b, 32, ctx->aes.ccm.fc,
1965                &ctx->aes.ccm.kmac_param);
1966     ctx->aes.ccm.blocks += 2;
1967
1968     rem = alen & 0xf;
1969     alen &= ~(size_t)0xf;
1970     if (alen) {
1971         s390x_kmac(aad, alen, ctx->aes.ccm.fc, &ctx->aes.ccm.kmac_param);
1972         ctx->aes.ccm.blocks += alen >> 4;
1973         aad += alen;
1974     }
1975     if (rem) {
1976         for (i = 0; i < rem; i++)
1977             ctx->aes.ccm.kmac_param.icv.b[i] ^= aad[i];
1978
1979         s390x_km(ctx->aes.ccm.kmac_param.icv.b, 16,
1980                  ctx->aes.ccm.kmac_param.icv.b, ctx->aes.ccm.fc,
1981                  ctx->aes.ccm.kmac_param.k);
1982         ctx->aes.ccm.blocks++;
1983     }
1984 }
1985
1986 /*-
1987  * En/de-crypt plain/cipher-text. Compute tag from plaintext. Returns 0 for
1988  * success.
1989  */
1990 static int s390x_aes_ccm(S390X_AES_CCM_CTX *ctx, const unsigned char *in,
1991                          unsigned char *out, size_t len, int enc)
1992 {
1993     size_t n, rem;
1994     unsigned int i, l, num;
1995     unsigned char flags;
1996
1997     flags = ctx->aes.ccm.nonce.b[0];
1998     if (!(flags & S390X_CCM_AAD_FLAG)) {
1999         s390x_km(ctx->aes.ccm.nonce.b, 16, ctx->aes.ccm.kmac_param.icv.b,
2000                  ctx->aes.ccm.fc, ctx->aes.ccm.kmac_param.k);
2001         ctx->aes.ccm.blocks++;
2002     }
2003     l = flags & 0x7;
2004     ctx->aes.ccm.nonce.b[0] = l;
2005
2006     /*-
2007      * Reconstruct length from encoded length field
2008      * and initialize it with counter value.
2009      */
2010     n = 0;
2011     for (i = 15 - l; i < 15; i++) {
2012         n |= ctx->aes.ccm.nonce.b[i];
2013         ctx->aes.ccm.nonce.b[i] = 0;
2014         n <<= 8;
2015     }
2016     n |= ctx->aes.ccm.nonce.b[15];
2017     ctx->aes.ccm.nonce.b[15] = 1;
2018
2019     if (n != len)
2020         return -1;              /* length mismatch */
2021
2022     if (enc) {
2023         /* Two operations per block plus one for tag encryption */
2024         ctx->aes.ccm.blocks += (((len + 15) >> 4) << 1) + 1;
2025         if (ctx->aes.ccm.blocks > (1ULL << 61))
2026             return -2;          /* too much data */
2027     }
2028
2029     num = 0;
2030     rem = len & 0xf;
2031     len &= ~(size_t)0xf;
2032
2033     if (enc) {
2034         /* mac-then-encrypt */
2035         if (len)
2036             s390x_kmac(in, len, ctx->aes.ccm.fc, &ctx->aes.ccm.kmac_param);
2037         if (rem) {
2038             for (i = 0; i < rem; i++)
2039                 ctx->aes.ccm.kmac_param.icv.b[i] ^= in[len + i];
2040
2041             s390x_km(ctx->aes.ccm.kmac_param.icv.b, 16,
2042                      ctx->aes.ccm.kmac_param.icv.b, ctx->aes.ccm.fc,
2043                      ctx->aes.ccm.kmac_param.k);
2044         }
2045
2046         CRYPTO_ctr128_encrypt_ctr32(in, out, len + rem, &ctx->aes.key.k,
2047                                     ctx->aes.ccm.nonce.b, ctx->aes.ccm.buf.b,
2048                                     &num, (ctr128_f)AES_ctr32_encrypt);
2049     } else {
2050         /* decrypt-then-mac */
2051         CRYPTO_ctr128_encrypt_ctr32(in, out, len + rem, &ctx->aes.key.k,
2052                                     ctx->aes.ccm.nonce.b, ctx->aes.ccm.buf.b,
2053                                     &num, (ctr128_f)AES_ctr32_encrypt);
2054
2055         if (len)
2056             s390x_kmac(out, len, ctx->aes.ccm.fc, &ctx->aes.ccm.kmac_param);
2057         if (rem) {
2058             for (i = 0; i < rem; i++)
2059                 ctx->aes.ccm.kmac_param.icv.b[i] ^= out[len + i];
2060
2061             s390x_km(ctx->aes.ccm.kmac_param.icv.b, 16,
2062                      ctx->aes.ccm.kmac_param.icv.b, ctx->aes.ccm.fc,
2063                      ctx->aes.ccm.kmac_param.k);
2064         }
2065     }
2066     /* encrypt tag */
2067     for (i = 15 - l; i < 16; i++)
2068         ctx->aes.ccm.nonce.b[i] = 0;
2069
2070     s390x_km(ctx->aes.ccm.nonce.b, 16, ctx->aes.ccm.buf.b, ctx->aes.ccm.fc,
2071              ctx->aes.ccm.kmac_param.k);
2072     ctx->aes.ccm.kmac_param.icv.g[0] ^= ctx->aes.ccm.buf.g[0];
2073     ctx->aes.ccm.kmac_param.icv.g[1] ^= ctx->aes.ccm.buf.g[1];
2074
2075     ctx->aes.ccm.nonce.b[0] = flags;    /* restore flags field */
2076     return 0;
2077 }
2078
2079 /*-
2080  * En/de-crypt and authenticate TLS packet. Returns the number of bytes written
2081  * if successful. Otherwise -1 is returned.
2082  */
2083 static int s390x_aes_ccm_tls_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
2084                                     const unsigned char *in, size_t len)
2085 {
2086     S390X_AES_CCM_CTX *cctx = EVP_C_DATA(S390X_AES_CCM_CTX, ctx);
2087     unsigned char *ivec = EVP_CIPHER_CTX_iv_noconst(ctx);
2088     unsigned char *buf = EVP_CIPHER_CTX_buf_noconst(ctx);
2089     const int enc = EVP_CIPHER_CTX_encrypting(ctx);
2090
2091     if (out != in
2092             || len < (EVP_CCM_TLS_EXPLICIT_IV_LEN + (size_t)cctx->aes.ccm.m))
2093         return -1;
2094
2095     if (enc) {
2096         /* Set explicit iv (sequence number). */
2097         memcpy(out, buf, EVP_CCM_TLS_EXPLICIT_IV_LEN);
2098     }
2099
2100     len -= EVP_CCM_TLS_EXPLICIT_IV_LEN + cctx->aes.ccm.m;
2101     /*-
2102      * Get explicit iv (sequence number). We already have fixed iv
2103      * (server/client_write_iv) here.
2104      */
2105     memcpy(ivec + EVP_CCM_TLS_FIXED_IV_LEN, in, EVP_CCM_TLS_EXPLICIT_IV_LEN);
2106     s390x_aes_ccm_setiv(cctx, ivec, len);
2107
2108     /* Process aad (sequence number|type|version|length) */
2109     s390x_aes_ccm_aad(cctx, buf, cctx->aes.ccm.tls_aad_len);
2110
2111     in += EVP_CCM_TLS_EXPLICIT_IV_LEN;
2112     out += EVP_CCM_TLS_EXPLICIT_IV_LEN;
2113
2114     if (enc) {
2115         if (s390x_aes_ccm(cctx, in, out, len, enc))
2116             return -1;
2117
2118         memcpy(out + len, cctx->aes.ccm.kmac_param.icv.b, cctx->aes.ccm.m);
2119         return len + EVP_CCM_TLS_EXPLICIT_IV_LEN + cctx->aes.ccm.m;
2120     } else {
2121         if (!s390x_aes_ccm(cctx, in, out, len, enc)) {
2122             if (!CRYPTO_memcmp(cctx->aes.ccm.kmac_param.icv.b, in + len,
2123                                cctx->aes.ccm.m))
2124                 return len;
2125         }
2126
2127         OPENSSL_cleanse(out, len);
2128         return -1;
2129     }
2130 }
2131
2132 /*-
2133  * Set key and flag field and/or iv. Returns 1 if successful. Otherwise 0 is
2134  * returned.
2135  */
2136 static int s390x_aes_ccm_init_key(EVP_CIPHER_CTX *ctx,
2137                                   const unsigned char *key,
2138                                   const unsigned char *iv, int enc)
2139 {
2140     S390X_AES_CCM_CTX *cctx = EVP_C_DATA(S390X_AES_CCM_CTX, ctx);
2141     unsigned char *ivec;
2142     int keylen;
2143
2144     if (iv == NULL && key == NULL)
2145         return 1;
2146
2147     if (key != NULL) {
2148         keylen = EVP_CIPHER_CTX_key_length(ctx);
2149         cctx->aes.ccm.fc = S390X_AES_FC(keylen);
2150         memcpy(cctx->aes.ccm.kmac_param.k, key, keylen);
2151
2152         /* Store encoded m and l. */
2153         cctx->aes.ccm.nonce.b[0] = ((cctx->aes.ccm.l - 1) & 0x7)
2154                                  | (((cctx->aes.ccm.m - 2) >> 1) & 0x7) << 3;
2155         memset(cctx->aes.ccm.nonce.b + 1, 0,
2156                sizeof(cctx->aes.ccm.nonce.b));
2157         cctx->aes.ccm.blocks = 0;
2158
2159         cctx->aes.ccm.key_set = 1;
2160     }
2161
2162     if (iv != NULL) {
2163         ivec = EVP_CIPHER_CTX_iv_noconst(ctx);
2164         memcpy(ivec, iv, 15 - cctx->aes.ccm.l);
2165
2166         cctx->aes.ccm.iv_set = 1;
2167     }
2168
2169     return 1;
2170 }
2171
2172 /*-
2173  * Called from EVP layer to initialize context, process additional
2174  * authenticated data, en/de-crypt plain/cipher-text and authenticate
2175  * plaintext or process a TLS packet, depending on context. Returns bytes
2176  * written on success. Otherwise -1 is returned.
2177  */
2178 static int s390x_aes_ccm_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
2179                                 const unsigned char *in, size_t len)
2180 {
2181     S390X_AES_CCM_CTX *cctx = EVP_C_DATA(S390X_AES_CCM_CTX, ctx);
2182     const int enc = EVP_CIPHER_CTX_encrypting(ctx);
2183     int rv;
2184     unsigned char *buf, *ivec;
2185
2186     if (!cctx->aes.ccm.key_set)
2187         return -1;
2188
2189     if (cctx->aes.ccm.tls_aad_len >= 0)
2190         return s390x_aes_ccm_tls_cipher(ctx, out, in, len);
2191
2192     /*-
2193      * Final(): Does not return any data. Recall that ccm is mac-then-encrypt
2194      * so integrity must be checked already at Update() i.e., before
2195      * potentially corrupted data is output.
2196      */
2197     if (in == NULL && out != NULL)
2198         return 0;
2199
2200     if (!cctx->aes.ccm.iv_set)
2201         return -1;
2202
2203     if (!enc && !cctx->aes.ccm.tag_set)
2204         return -1;
2205
2206     if (out == NULL) {
2207         /* Update(): Pass message length. */
2208         if (in == NULL) {
2209             ivec = EVP_CIPHER_CTX_iv_noconst(ctx);
2210             s390x_aes_ccm_setiv(cctx, ivec, len);
2211
2212             cctx->aes.ccm.len_set = 1;
2213             return len;
2214         }
2215
2216         /* Update(): Process aad. */
2217         if (!cctx->aes.ccm.len_set && len)
2218             return -1;
2219
2220         s390x_aes_ccm_aad(cctx, in, len);
2221         return len;
2222     }
2223
2224     /* Update(): Process message. */
2225
2226     if (!cctx->aes.ccm.len_set) {
2227         /*-
2228          * In case message length was not previously set explicitely via
2229          * Update(), set it now.
2230          */
2231         ivec = EVP_CIPHER_CTX_iv_noconst(ctx);
2232         s390x_aes_ccm_setiv(cctx, ivec, len);
2233
2234         cctx->aes.ccm.len_set = 1;
2235     }
2236
2237     if (enc) {
2238         if (s390x_aes_ccm(cctx, in, out, len, enc))
2239             return -1;
2240
2241         cctx->aes.ccm.tag_set = 1;
2242         return len;
2243     } else {
2244         rv = -1;
2245
2246         if (!s390x_aes_ccm(cctx, in, out, len, enc)) {
2247             buf = EVP_CIPHER_CTX_buf_noconst(ctx);
2248             if (!CRYPTO_memcmp(cctx->aes.ccm.kmac_param.icv.b, buf,
2249                                cctx->aes.ccm.m))
2250                 rv = len;
2251         }
2252
2253         if (rv == -1)
2254             OPENSSL_cleanse(out, len);
2255
2256         cctx->aes.ccm.iv_set = 0;
2257         cctx->aes.ccm.tag_set = 0;
2258         cctx->aes.ccm.len_set = 0;
2259         return rv;
2260     }
2261 }
2262
2263 /*-
2264  * Performs various operations on the context structure depending on control
2265  * type. Returns 1 for success, 0 for failure and -1 for unknown control type.
2266  * Code is big-endian.
2267  */
2268 static int s390x_aes_ccm_ctrl(EVP_CIPHER_CTX *c, int type, int arg, void *ptr)
2269 {
2270     S390X_AES_CCM_CTX *cctx = EVP_C_DATA(S390X_AES_CCM_CTX, c);
2271     unsigned char *buf, *iv;
2272     int enc, len;
2273
2274     switch (type) {
2275     case EVP_CTRL_INIT:
2276         cctx->aes.ccm.key_set = 0;
2277         cctx->aes.ccm.iv_set = 0;
2278         cctx->aes.ccm.l = 8;
2279         cctx->aes.ccm.m = 12;
2280         cctx->aes.ccm.tag_set = 0;
2281         cctx->aes.ccm.len_set = 0;
2282         cctx->aes.ccm.tls_aad_len = -1;
2283         return 1;
2284
2285     case EVP_CTRL_AEAD_TLS1_AAD:
2286         if (arg != EVP_AEAD_TLS1_AAD_LEN)
2287             return 0;
2288
2289         /* Save the aad for later use. */
2290         buf = EVP_CIPHER_CTX_buf_noconst(c);
2291         memcpy(buf, ptr, arg);
2292         cctx->aes.ccm.tls_aad_len = arg;
2293
2294         len = *(uint16_t *)(buf + arg - 2);
2295         if (len < EVP_CCM_TLS_EXPLICIT_IV_LEN)
2296             return 0;
2297
2298         /* Correct length for explicit iv. */
2299         len -= EVP_CCM_TLS_EXPLICIT_IV_LEN;
2300
2301         enc = EVP_CIPHER_CTX_encrypting(c);
2302         if (!enc) {
2303             if (len < cctx->aes.ccm.m)
2304                 return 0;
2305
2306             /* Correct length for tag. */
2307             len -= cctx->aes.ccm.m;
2308         }
2309
2310         *(uint16_t *)(buf + arg - 2) = len;
2311         /* Extra padding: tag appended to record. */
2312         return cctx->aes.ccm.m;
2313
2314     case EVP_CTRL_CCM_SET_IV_FIXED:
2315         if (arg != EVP_CCM_TLS_FIXED_IV_LEN)
2316             return 0;
2317
2318         /* Copy to first part of the iv. */
2319         iv = EVP_CIPHER_CTX_iv_noconst(c);
2320         memcpy(iv, ptr, arg);
2321         return 1;
2322
2323     case EVP_CTRL_AEAD_SET_IVLEN:
2324         arg = 15 - arg;
2325         /* fall-through */
2326
2327     case EVP_CTRL_CCM_SET_L:
2328         if (arg < 2 || arg > 8)
2329             return 0;
2330
2331         cctx->aes.ccm.l = arg;
2332         return 1;
2333
2334     case EVP_CTRL_AEAD_SET_TAG:
2335         if ((arg & 1) || arg < 4 || arg > 16)
2336             return 0;
2337
2338         enc = EVP_CIPHER_CTX_encrypting(c);
2339         if (enc && ptr)
2340             return 0;
2341
2342         if (ptr) {
2343             cctx->aes.ccm.tag_set = 1;
2344             buf = EVP_CIPHER_CTX_buf_noconst(c);
2345             memcpy(buf, ptr, arg);
2346         }
2347
2348         cctx->aes.ccm.m = arg;
2349         return 1;
2350
2351     case EVP_CTRL_AEAD_GET_TAG:
2352         enc = EVP_CIPHER_CTX_encrypting(c);
2353         if (!enc || !cctx->aes.ccm.tag_set)
2354             return 0;
2355
2356         if(arg < cctx->aes.ccm.m)
2357             return 0;
2358
2359         memcpy(ptr, cctx->aes.ccm.kmac_param.icv.b, cctx->aes.ccm.m);
2360         cctx->aes.ccm.tag_set = 0;
2361         cctx->aes.ccm.iv_set = 0;
2362         cctx->aes.ccm.len_set = 0;
2363         return 1;
2364
2365     case EVP_CTRL_COPY:
2366         return 1;
2367
2368     default:
2369         return -1;
2370     }
2371 }
2372
2373 # define s390x_aes_ccm_cleanup aes_ccm_cleanup
2374
2375 # ifndef OPENSSL_NO_OCB
2376 #  define S390X_AES_OCB_CTX             EVP_AES_OCB_CTX
2377 #  define S390X_aes_128_ocb_CAPABLE     0
2378 #  define S390X_aes_192_ocb_CAPABLE     0
2379 #  define S390X_aes_256_ocb_CAPABLE     0
2380
2381 #  define s390x_aes_ocb_init_key aes_ocb_init_key
2382 static int s390x_aes_ocb_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
2383                                   const unsigned char *iv, int enc);
2384 #  define s390x_aes_ocb_cipher aes_ocb_cipher
2385 static int s390x_aes_ocb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
2386                                 const unsigned char *in, size_t len);
2387 #  define s390x_aes_ocb_cleanup aes_ocb_cleanup
2388 static int s390x_aes_ocb_cleanup(EVP_CIPHER_CTX *);
2389 #  define s390x_aes_ocb_ctrl aes_ocb_ctrl
2390 static int s390x_aes_ocb_ctrl(EVP_CIPHER_CTX *, int type, int arg, void *ptr);
2391 # endif
2392
2393 # define BLOCK_CIPHER_generic(nid,keylen,blocksize,ivlen,nmode,mode,    \
2394                               MODE,flags)                               \
2395 static const EVP_CIPHER s390x_aes_##keylen##_##mode = {                 \
2396     nid##_##keylen##_##nmode,blocksize,                                 \
2397     keylen / 8,                                                         \
2398     ivlen,                                                              \
2399     flags | EVP_CIPH_##MODE##_MODE,                                     \
2400     s390x_aes_##mode##_init_key,                                        \
2401     s390x_aes_##mode##_cipher,                                          \
2402     NULL,                                                               \
2403     sizeof(S390X_AES_##MODE##_CTX),                                     \
2404     NULL,                                                               \
2405     NULL,                                                               \
2406     NULL,                                                               \
2407     NULL                                                                \
2408 };                                                                      \
2409 static const EVP_CIPHER aes_##keylen##_##mode = {                       \
2410     nid##_##keylen##_##nmode,                                           \
2411     blocksize,                                                          \
2412     keylen / 8,                                                         \
2413     ivlen,                                                              \
2414     flags | EVP_CIPH_##MODE##_MODE,                                     \
2415     aes_init_key,                                                       \
2416     aes_##mode##_cipher,                                                \
2417     NULL,                                                               \
2418     sizeof(EVP_AES_KEY),                                                \
2419     NULL,                                                               \
2420     NULL,                                                               \
2421     NULL,                                                               \
2422     NULL                                                                \
2423 };                                                                      \
2424 const EVP_CIPHER *EVP_aes_##keylen##_##mode(void)                       \
2425 {                                                                       \
2426     return S390X_aes_##keylen##_##mode##_CAPABLE ?                      \
2427            &s390x_aes_##keylen##_##mode : &aes_##keylen##_##mode;       \
2428 }
2429
2430 # define BLOCK_CIPHER_custom(nid,keylen,blocksize,ivlen,mode,MODE,flags)\
2431 static const EVP_CIPHER s390x_aes_##keylen##_##mode = {                 \
2432     nid##_##keylen##_##mode,                                            \
2433     blocksize,                                                          \
2434     (EVP_CIPH_##MODE##_MODE == EVP_CIPH_XTS_MODE ? 2 : 1) * keylen / 8, \
2435     ivlen,                                                              \
2436     flags | EVP_CIPH_##MODE##_MODE,                                     \
2437     s390x_aes_##mode##_init_key,                                        \
2438     s390x_aes_##mode##_cipher,                                          \
2439     s390x_aes_##mode##_cleanup,                                         \
2440     sizeof(S390X_AES_##MODE##_CTX),                                     \
2441     NULL,                                                               \
2442     NULL,                                                               \
2443     s390x_aes_##mode##_ctrl,                                            \
2444     NULL                                                                \
2445 };                                                                      \
2446 static const EVP_CIPHER aes_##keylen##_##mode = {                       \
2447     nid##_##keylen##_##mode,blocksize,                                  \
2448     (EVP_CIPH_##MODE##_MODE == EVP_CIPH_XTS_MODE ? 2 : 1) * keylen / 8, \
2449     ivlen,                                                              \
2450     flags | EVP_CIPH_##MODE##_MODE,                                     \
2451     aes_##mode##_init_key,                                              \
2452     aes_##mode##_cipher,                                                \
2453     aes_##mode##_cleanup,                                               \
2454     sizeof(EVP_AES_##MODE##_CTX),                                       \
2455     NULL,                                                               \
2456     NULL,                                                               \
2457     aes_##mode##_ctrl,                                                  \
2458     NULL                                                                \
2459 };                                                                      \
2460 const EVP_CIPHER *EVP_aes_##keylen##_##mode(void)                       \
2461 {                                                                       \
2462     return S390X_aes_##keylen##_##mode##_CAPABLE ?                      \
2463            &s390x_aes_##keylen##_##mode : &aes_##keylen##_##mode;       \
2464 }
2465
2466 #else
2467
2468 # define BLOCK_CIPHER_generic(nid,keylen,blocksize,ivlen,nmode,mode,MODE,flags) \
2469 static const EVP_CIPHER aes_##keylen##_##mode = { \
2470         nid##_##keylen##_##nmode,blocksize,keylen/8,ivlen, \
2471         flags|EVP_CIPH_##MODE##_MODE,   \
2472         aes_init_key,                   \
2473         aes_##mode##_cipher,            \
2474         NULL,                           \
2475         sizeof(EVP_AES_KEY),            \
2476         NULL,NULL,NULL,NULL }; \
2477 const EVP_CIPHER *EVP_aes_##keylen##_##mode(void) \
2478 { return &aes_##keylen##_##mode; }
2479
2480 # define BLOCK_CIPHER_custom(nid,keylen,blocksize,ivlen,mode,MODE,flags) \
2481 static const EVP_CIPHER aes_##keylen##_##mode = { \
2482         nid##_##keylen##_##mode,blocksize, \
2483         (EVP_CIPH_##MODE##_MODE==EVP_CIPH_XTS_MODE?2:1)*keylen/8, ivlen, \
2484         flags|EVP_CIPH_##MODE##_MODE,   \
2485         aes_##mode##_init_key,          \
2486         aes_##mode##_cipher,            \
2487         aes_##mode##_cleanup,           \
2488         sizeof(EVP_AES_##MODE##_CTX),   \
2489         NULL,NULL,aes_##mode##_ctrl,NULL }; \
2490 const EVP_CIPHER *EVP_aes_##keylen##_##mode(void) \
2491 { return &aes_##keylen##_##mode; }
2492
2493 #endif
2494
2495 #if defined(OPENSSL_CPUID_OBJ) && (defined(__arm__) || defined(__arm) || defined(__aarch64__))
2496 # include "arm_arch.h"
2497 # if __ARM_MAX_ARCH__>=7
2498 #  if defined(BSAES_ASM)
2499 #   define BSAES_CAPABLE (OPENSSL_armcap_P & ARMV7_NEON)
2500 #  endif
2501 #  if defined(VPAES_ASM)
2502 #   define VPAES_CAPABLE (OPENSSL_armcap_P & ARMV7_NEON)
2503 #  endif
2504 #  define HWAES_CAPABLE (OPENSSL_armcap_P & ARMV8_AES)
2505 #  define HWAES_set_encrypt_key aes_v8_set_encrypt_key
2506 #  define HWAES_set_decrypt_key aes_v8_set_decrypt_key
2507 #  define HWAES_encrypt aes_v8_encrypt
2508 #  define HWAES_decrypt aes_v8_decrypt
2509 #  define HWAES_cbc_encrypt aes_v8_cbc_encrypt
2510 #  define HWAES_ctr32_encrypt_blocks aes_v8_ctr32_encrypt_blocks
2511 # endif
2512 #endif
2513
2514 #if defined(HWAES_CAPABLE)
2515 int HWAES_set_encrypt_key(const unsigned char *userKey, const int bits,
2516                           AES_KEY *key);
2517 int HWAES_set_decrypt_key(const unsigned char *userKey, const int bits,
2518                           AES_KEY *key);
2519 void HWAES_encrypt(const unsigned char *in, unsigned char *out,
2520                    const AES_KEY *key);
2521 void HWAES_decrypt(const unsigned char *in, unsigned char *out,
2522                    const AES_KEY *key);
2523 void HWAES_cbc_encrypt(const unsigned char *in, unsigned char *out,
2524                        size_t length, const AES_KEY *key,
2525                        unsigned char *ivec, const int enc);
2526 void HWAES_ctr32_encrypt_blocks(const unsigned char *in, unsigned char *out,
2527                                 size_t len, const AES_KEY *key,
2528                                 const unsigned char ivec[16]);
2529 void HWAES_xts_encrypt(const unsigned char *inp, unsigned char *out,
2530                        size_t len, const AES_KEY *key1,
2531                        const AES_KEY *key2, const unsigned char iv[16]);
2532 void HWAES_xts_decrypt(const unsigned char *inp, unsigned char *out,
2533                        size_t len, const AES_KEY *key1,
2534                        const AES_KEY *key2, const unsigned char iv[16]);
2535 #endif
2536
2537 #define BLOCK_CIPHER_generic_pack(nid,keylen,flags)             \
2538         BLOCK_CIPHER_generic(nid,keylen,16,16,cbc,cbc,CBC,flags|EVP_CIPH_FLAG_DEFAULT_ASN1)     \
2539         BLOCK_CIPHER_generic(nid,keylen,16,0,ecb,ecb,ECB,flags|EVP_CIPH_FLAG_DEFAULT_ASN1)      \
2540         BLOCK_CIPHER_generic(nid,keylen,1,16,ofb128,ofb,OFB,flags|EVP_CIPH_FLAG_DEFAULT_ASN1)   \
2541         BLOCK_CIPHER_generic(nid,keylen,1,16,cfb128,cfb,CFB,flags|EVP_CIPH_FLAG_DEFAULT_ASN1)   \
2542         BLOCK_CIPHER_generic(nid,keylen,1,16,cfb1,cfb1,CFB,flags)       \
2543         BLOCK_CIPHER_generic(nid,keylen,1,16,cfb8,cfb8,CFB,flags)       \
2544         BLOCK_CIPHER_generic(nid,keylen,1,16,ctr,ctr,CTR,flags)
2545
2546 static int aes_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
2547                         const unsigned char *iv, int enc)
2548 {
2549     int ret, mode;
2550     EVP_AES_KEY *dat = EVP_C_DATA(EVP_AES_KEY,ctx);
2551
2552     mode = EVP_CIPHER_CTX_mode(ctx);
2553     if ((mode == EVP_CIPH_ECB_MODE || mode == EVP_CIPH_CBC_MODE)
2554         && !enc) {
2555 #ifdef HWAES_CAPABLE
2556         if (HWAES_CAPABLE) {
2557             ret = HWAES_set_decrypt_key(key,
2558                                         EVP_CIPHER_CTX_key_length(ctx) * 8,
2559                                         &dat->ks.ks);
2560             dat->block = (block128_f) HWAES_decrypt;
2561             dat->stream.cbc = NULL;
2562 # ifdef HWAES_cbc_encrypt
2563             if (mode == EVP_CIPH_CBC_MODE)
2564                 dat->stream.cbc = (cbc128_f) HWAES_cbc_encrypt;
2565 # endif
2566         } else
2567 #endif
2568 #ifdef BSAES_CAPABLE
2569         if (BSAES_CAPABLE && mode == EVP_CIPH_CBC_MODE) {
2570             ret = AES_set_decrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
2571                                       &dat->ks.ks);
2572             dat->block = (block128_f) AES_decrypt;
2573             dat->stream.cbc = (cbc128_f) bsaes_cbc_encrypt;
2574         } else
2575 #endif
2576 #ifdef VPAES_CAPABLE
2577         if (VPAES_CAPABLE) {
2578             ret = vpaes_set_decrypt_key(key,
2579                                         EVP_CIPHER_CTX_key_length(ctx) * 8,
2580                                         &dat->ks.ks);
2581             dat->block = (block128_f) vpaes_decrypt;
2582             dat->stream.cbc = mode == EVP_CIPH_CBC_MODE ?
2583                 (cbc128_f) vpaes_cbc_encrypt : NULL;
2584         } else
2585 #endif
2586         {
2587             ret = AES_set_decrypt_key(key,
2588                                       EVP_CIPHER_CTX_key_length(ctx) * 8,
2589                                       &dat->ks.ks);
2590             dat->block = (block128_f) AES_decrypt;
2591             dat->stream.cbc = mode == EVP_CIPH_CBC_MODE ?
2592                 (cbc128_f) AES_cbc_encrypt : NULL;
2593         }
2594     } else
2595 #ifdef HWAES_CAPABLE
2596     if (HWAES_CAPABLE) {
2597         ret = HWAES_set_encrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
2598                                     &dat->ks.ks);
2599         dat->block = (block128_f) HWAES_encrypt;
2600         dat->stream.cbc = NULL;
2601 # ifdef HWAES_cbc_encrypt
2602         if (mode == EVP_CIPH_CBC_MODE)
2603             dat->stream.cbc = (cbc128_f) HWAES_cbc_encrypt;
2604         else
2605 # endif
2606 # ifdef HWAES_ctr32_encrypt_blocks
2607         if (mode == EVP_CIPH_CTR_MODE)
2608             dat->stream.ctr = (ctr128_f) HWAES_ctr32_encrypt_blocks;
2609         else
2610 # endif
2611             (void)0;            /* terminate potentially open 'else' */
2612     } else
2613 #endif
2614 #ifdef BSAES_CAPABLE
2615     if (BSAES_CAPABLE && mode == EVP_CIPH_CTR_MODE) {
2616         ret = AES_set_encrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
2617                                   &dat->ks.ks);
2618         dat->block = (block128_f) AES_encrypt;
2619         dat->stream.ctr = (ctr128_f) bsaes_ctr32_encrypt_blocks;
2620     } else
2621 #endif
2622 #ifdef VPAES_CAPABLE
2623     if (VPAES_CAPABLE) {
2624         ret = vpaes_set_encrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
2625                                     &dat->ks.ks);
2626         dat->block = (block128_f) vpaes_encrypt;
2627         dat->stream.cbc = mode == EVP_CIPH_CBC_MODE ?
2628             (cbc128_f) vpaes_cbc_encrypt : NULL;
2629     } else
2630 #endif
2631     {
2632         ret = AES_set_encrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
2633                                   &dat->ks.ks);
2634         dat->block = (block128_f) AES_encrypt;
2635         dat->stream.cbc = mode == EVP_CIPH_CBC_MODE ?
2636             (cbc128_f) AES_cbc_encrypt : NULL;
2637 #ifdef AES_CTR_ASM
2638         if (mode == EVP_CIPH_CTR_MODE)
2639             dat->stream.ctr = (ctr128_f) AES_ctr32_encrypt;
2640 #endif
2641     }
2642
2643     if (ret < 0) {
2644         EVPerr(EVP_F_AES_INIT_KEY, EVP_R_AES_KEY_SETUP_FAILED);
2645         return 0;
2646     }
2647
2648     return 1;
2649 }
2650
2651 static int aes_cbc_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
2652                           const unsigned char *in, size_t len)
2653 {
2654     EVP_AES_KEY *dat = EVP_C_DATA(EVP_AES_KEY,ctx);
2655
2656     if (dat->stream.cbc)
2657         (*dat->stream.cbc) (in, out, len, &dat->ks,
2658                             EVP_CIPHER_CTX_iv_noconst(ctx),
2659                             EVP_CIPHER_CTX_encrypting(ctx));
2660     else if (EVP_CIPHER_CTX_encrypting(ctx))
2661         CRYPTO_cbc128_encrypt(in, out, len, &dat->ks,
2662                               EVP_CIPHER_CTX_iv_noconst(ctx), dat->block);
2663     else
2664         CRYPTO_cbc128_decrypt(in, out, len, &dat->ks,
2665                               EVP_CIPHER_CTX_iv_noconst(ctx), dat->block);
2666
2667     return 1;
2668 }
2669
2670 static int aes_ecb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
2671                           const unsigned char *in, size_t len)
2672 {
2673     size_t bl = EVP_CIPHER_CTX_block_size(ctx);
2674     size_t i;
2675     EVP_AES_KEY *dat = EVP_C_DATA(EVP_AES_KEY,ctx);
2676
2677     if (len < bl)
2678         return 1;
2679
2680     for (i = 0, len -= bl; i <= len; i += bl)
2681         (*dat->block) (in + i, out + i, &dat->ks);
2682
2683     return 1;
2684 }
2685
2686 static int aes_ofb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
2687                           const unsigned char *in, size_t len)
2688 {
2689     EVP_AES_KEY *dat = EVP_C_DATA(EVP_AES_KEY,ctx);
2690
2691     int num = EVP_CIPHER_CTX_num(ctx);
2692     CRYPTO_ofb128_encrypt(in, out, len, &dat->ks,
2693                           EVP_CIPHER_CTX_iv_noconst(ctx), &num, dat->block);
2694     EVP_CIPHER_CTX_set_num(ctx, num);
2695     return 1;
2696 }
2697
2698 static int aes_cfb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
2699                           const unsigned char *in, size_t len)
2700 {
2701     EVP_AES_KEY *dat = EVP_C_DATA(EVP_AES_KEY,ctx);
2702
2703     int num = EVP_CIPHER_CTX_num(ctx);
2704     CRYPTO_cfb128_encrypt(in, out, len, &dat->ks,
2705                           EVP_CIPHER_CTX_iv_noconst(ctx), &num,
2706                           EVP_CIPHER_CTX_encrypting(ctx), dat->block);
2707     EVP_CIPHER_CTX_set_num(ctx, num);
2708     return 1;
2709 }
2710
2711 static int aes_cfb8_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
2712                            const unsigned char *in, size_t len)
2713 {
2714     EVP_AES_KEY *dat = EVP_C_DATA(EVP_AES_KEY,ctx);
2715
2716     int num = EVP_CIPHER_CTX_num(ctx);
2717     CRYPTO_cfb128_8_encrypt(in, out, len, &dat->ks,
2718                             EVP_CIPHER_CTX_iv_noconst(ctx), &num,
2719                             EVP_CIPHER_CTX_encrypting(ctx), dat->block);
2720     EVP_CIPHER_CTX_set_num(ctx, num);
2721     return 1;
2722 }
2723
2724 static int aes_cfb1_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
2725                            const unsigned char *in, size_t len)
2726 {
2727     EVP_AES_KEY *dat = EVP_C_DATA(EVP_AES_KEY,ctx);
2728
2729     if (EVP_CIPHER_CTX_test_flags(ctx, EVP_CIPH_FLAG_LENGTH_BITS)) {
2730         int num = EVP_CIPHER_CTX_num(ctx);
2731         CRYPTO_cfb128_1_encrypt(in, out, len, &dat->ks,
2732                                 EVP_CIPHER_CTX_iv_noconst(ctx), &num,
2733                                 EVP_CIPHER_CTX_encrypting(ctx), dat->block);
2734         EVP_CIPHER_CTX_set_num(ctx, num);
2735         return 1;
2736     }
2737
2738     while (len >= MAXBITCHUNK) {
2739         int num = EVP_CIPHER_CTX_num(ctx);
2740         CRYPTO_cfb128_1_encrypt(in, out, MAXBITCHUNK * 8, &dat->ks,
2741                                 EVP_CIPHER_CTX_iv_noconst(ctx), &num,
2742                                 EVP_CIPHER_CTX_encrypting(ctx), dat->block);
2743         EVP_CIPHER_CTX_set_num(ctx, num);
2744         len -= MAXBITCHUNK;
2745         out += MAXBITCHUNK;
2746         in  += MAXBITCHUNK;
2747     }
2748     if (len) {
2749         int num = EVP_CIPHER_CTX_num(ctx);
2750         CRYPTO_cfb128_1_encrypt(in, out, len * 8, &dat->ks,
2751                                 EVP_CIPHER_CTX_iv_noconst(ctx), &num,
2752                                 EVP_CIPHER_CTX_encrypting(ctx), dat->block);
2753         EVP_CIPHER_CTX_set_num(ctx, num);
2754     }
2755
2756     return 1;
2757 }
2758
2759 static int aes_ctr_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
2760                           const unsigned char *in, size_t len)
2761 {
2762     unsigned int num = EVP_CIPHER_CTX_num(ctx);
2763     EVP_AES_KEY *dat = EVP_C_DATA(EVP_AES_KEY,ctx);
2764
2765     if (dat->stream.ctr)
2766         CRYPTO_ctr128_encrypt_ctr32(in, out, len, &dat->ks,
2767                                     EVP_CIPHER_CTX_iv_noconst(ctx),
2768                                     EVP_CIPHER_CTX_buf_noconst(ctx),
2769                                     &num, dat->stream.ctr);
2770     else
2771         CRYPTO_ctr128_encrypt(in, out, len, &dat->ks,
2772                               EVP_CIPHER_CTX_iv_noconst(ctx),
2773                               EVP_CIPHER_CTX_buf_noconst(ctx), &num,
2774                               dat->block);
2775     EVP_CIPHER_CTX_set_num(ctx, num);
2776     return 1;
2777 }
2778
2779 BLOCK_CIPHER_generic_pack(NID_aes, 128, 0)
2780     BLOCK_CIPHER_generic_pack(NID_aes, 192, 0)
2781     BLOCK_CIPHER_generic_pack(NID_aes, 256, 0)
2782
2783 static int aes_gcm_cleanup(EVP_CIPHER_CTX *c)
2784 {
2785     EVP_AES_GCM_CTX *gctx = EVP_C_DATA(EVP_AES_GCM_CTX,c);
2786     if (gctx == NULL)
2787         return 0;
2788     OPENSSL_cleanse(&gctx->gcm, sizeof(gctx->gcm));
2789     if (gctx->iv != EVP_CIPHER_CTX_iv_noconst(c))
2790         OPENSSL_free(gctx->iv);
2791     return 1;
2792 }
2793
2794 /* increment counter (64-bit int) by 1 */
2795 static void ctr64_inc(unsigned char *counter)
2796 {
2797     int n = 8;
2798     unsigned char c;
2799
2800     do {
2801         --n;
2802         c = counter[n];
2803         ++c;
2804         counter[n] = c;
2805         if (c)
2806             return;
2807     } while (n);
2808 }
2809
2810 static int aes_gcm_ctrl(EVP_CIPHER_CTX *c, int type, int arg, void *ptr)
2811 {
2812     EVP_AES_GCM_CTX *gctx = EVP_C_DATA(EVP_AES_GCM_CTX,c);
2813     switch (type) {
2814     case EVP_CTRL_INIT:
2815         gctx->key_set = 0;
2816         gctx->iv_set = 0;
2817         gctx->ivlen = c->cipher->iv_len;
2818         gctx->iv = c->iv;
2819         gctx->taglen = -1;
2820         gctx->iv_gen = 0;
2821         gctx->tls_aad_len = -1;
2822         return 1;
2823
2824     case EVP_CTRL_AEAD_SET_IVLEN:
2825         if (arg <= 0)
2826             return 0;
2827         /* Allocate memory for IV if needed */
2828         if ((arg > EVP_MAX_IV_LENGTH) && (arg > gctx->ivlen)) {
2829             if (gctx->iv != c->iv)
2830                 OPENSSL_free(gctx->iv);
2831             if ((gctx->iv = OPENSSL_malloc(arg)) == NULL) {
2832                 EVPerr(EVP_F_AES_GCM_CTRL, ERR_R_MALLOC_FAILURE);
2833                 return 0;
2834             }
2835         }
2836         gctx->ivlen = arg;
2837         return 1;
2838
2839     case EVP_CTRL_AEAD_SET_TAG:
2840         if (arg <= 0 || arg > 16 || c->encrypt)
2841             return 0;
2842         memcpy(c->buf, ptr, arg);
2843         gctx->taglen = arg;
2844         return 1;
2845
2846     case EVP_CTRL_AEAD_GET_TAG:
2847         if (arg <= 0 || arg > 16 || !c->encrypt
2848             || gctx->taglen < 0)
2849             return 0;
2850         memcpy(ptr, c->buf, arg);
2851         return 1;
2852
2853     case EVP_CTRL_GCM_SET_IV_FIXED:
2854         /* Special case: -1 length restores whole IV */
2855         if (arg == -1) {
2856             memcpy(gctx->iv, ptr, gctx->ivlen);
2857             gctx->iv_gen = 1;
2858             return 1;
2859         }
2860         /*
2861          * Fixed field must be at least 4 bytes and invocation field at least
2862          * 8.
2863          */
2864         if ((arg < 4) || (gctx->ivlen - arg) < 8)
2865             return 0;
2866         if (arg)
2867             memcpy(gctx->iv, ptr, arg);
2868         if (c->encrypt && RAND_bytes(gctx->iv + arg, gctx->ivlen - arg) <= 0)
2869             return 0;
2870         gctx->iv_gen = 1;
2871         return 1;
2872
2873     case EVP_CTRL_GCM_IV_GEN:
2874         if (gctx->iv_gen == 0 || gctx->key_set == 0)
2875             return 0;
2876         CRYPTO_gcm128_setiv(&gctx->gcm, gctx->iv, gctx->ivlen);
2877         if (arg <= 0 || arg > gctx->ivlen)
2878             arg = gctx->ivlen;
2879         memcpy(ptr, gctx->iv + gctx->ivlen - arg, arg);
2880         /*
2881          * Invocation field will be at least 8 bytes in size and so no need
2882          * to check wrap around or increment more than last 8 bytes.
2883          */
2884         ctr64_inc(gctx->iv + gctx->ivlen - 8);
2885         gctx->iv_set = 1;
2886         return 1;
2887
2888     case EVP_CTRL_GCM_SET_IV_INV:
2889         if (gctx->iv_gen == 0 || gctx->key_set == 0 || c->encrypt)
2890             return 0;
2891         memcpy(gctx->iv + gctx->ivlen - arg, ptr, arg);
2892         CRYPTO_gcm128_setiv(&gctx->gcm, gctx->iv, gctx->ivlen);
2893         gctx->iv_set = 1;
2894         return 1;
2895
2896     case EVP_CTRL_AEAD_TLS1_AAD:
2897         /* Save the AAD for later use */
2898         if (arg != EVP_AEAD_TLS1_AAD_LEN)
2899             return 0;
2900         memcpy(c->buf, ptr, arg);
2901         gctx->tls_aad_len = arg;
2902         {
2903             unsigned int len = c->buf[arg - 2] << 8 | c->buf[arg - 1];
2904             /* Correct length for explicit IV */
2905             if (len < EVP_GCM_TLS_EXPLICIT_IV_LEN)
2906                 return 0;
2907             len -= EVP_GCM_TLS_EXPLICIT_IV_LEN;
2908             /* If decrypting correct for tag too */
2909             if (!c->encrypt) {
2910                 if (len < EVP_GCM_TLS_TAG_LEN)
2911                     return 0;
2912                 len -= EVP_GCM_TLS_TAG_LEN;
2913             }
2914             c->buf[arg - 2] = len >> 8;
2915             c->buf[arg - 1] = len & 0xff;
2916         }
2917         /* Extra padding: tag appended to record */
2918         return EVP_GCM_TLS_TAG_LEN;
2919
2920     case EVP_CTRL_COPY:
2921         {
2922             EVP_CIPHER_CTX *out = ptr;
2923             EVP_AES_GCM_CTX *gctx_out = EVP_C_DATA(EVP_AES_GCM_CTX,out);
2924             if (gctx->gcm.key) {
2925                 if (gctx->gcm.key != &gctx->ks)
2926                     return 0;
2927                 gctx_out->gcm.key = &gctx_out->ks;
2928             }
2929             if (gctx->iv == c->iv)
2930                 gctx_out->iv = out->iv;
2931             else {
2932                 if ((gctx_out->iv = OPENSSL_malloc(gctx->ivlen)) == NULL) {
2933                     EVPerr(EVP_F_AES_GCM_CTRL, ERR_R_MALLOC_FAILURE);
2934                     return 0;
2935                 }
2936                 memcpy(gctx_out->iv, gctx->iv, gctx->ivlen);
2937             }
2938             return 1;
2939         }
2940
2941     default:
2942         return -1;
2943
2944     }
2945 }
2946
2947 static int aes_gcm_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
2948                             const unsigned char *iv, int enc)
2949 {
2950     EVP_AES_GCM_CTX *gctx = EVP_C_DATA(EVP_AES_GCM_CTX,ctx);
2951     if (!iv && !key)
2952         return 1;
2953     if (key) {
2954         do {
2955 #ifdef HWAES_CAPABLE
2956             if (HWAES_CAPABLE) {
2957                 HWAES_set_encrypt_key(key, ctx->key_len * 8, &gctx->ks.ks);
2958                 CRYPTO_gcm128_init(&gctx->gcm, &gctx->ks,
2959                                    (block128_f) HWAES_encrypt);
2960 # ifdef HWAES_ctr32_encrypt_blocks
2961                 gctx->ctr = (ctr128_f) HWAES_ctr32_encrypt_blocks;
2962 # else
2963                 gctx->ctr = NULL;
2964 # endif
2965                 break;
2966             } else
2967 #endif
2968 #ifdef BSAES_CAPABLE
2969             if (BSAES_CAPABLE) {
2970                 AES_set_encrypt_key(key, ctx->key_len * 8, &gctx->ks.ks);
2971                 CRYPTO_gcm128_init(&gctx->gcm, &gctx->ks,
2972                                    (block128_f) AES_encrypt);
2973                 gctx->ctr = (ctr128_f) bsaes_ctr32_encrypt_blocks;
2974                 break;
2975             } else
2976 #endif
2977 #ifdef VPAES_CAPABLE
2978             if (VPAES_CAPABLE) {
2979                 vpaes_set_encrypt_key(key, ctx->key_len * 8, &gctx->ks.ks);
2980                 CRYPTO_gcm128_init(&gctx->gcm, &gctx->ks,
2981                                    (block128_f) vpaes_encrypt);
2982                 gctx->ctr = NULL;
2983                 break;
2984             } else
2985 #endif
2986                 (void)0;        /* terminate potentially open 'else' */
2987
2988             AES_set_encrypt_key(key, ctx->key_len * 8, &gctx->ks.ks);
2989             CRYPTO_gcm128_init(&gctx->gcm, &gctx->ks,
2990                                (block128_f) AES_encrypt);
2991 #ifdef AES_CTR_ASM
2992             gctx->ctr = (ctr128_f) AES_ctr32_encrypt;
2993 #else
2994             gctx->ctr = NULL;
2995 #endif
2996         } while (0);
2997
2998         /*
2999          * If we have an iv can set it directly, otherwise use saved IV.
3000          */
3001         if (iv == NULL && gctx->iv_set)
3002             iv = gctx->iv;
3003         if (iv) {
3004             CRYPTO_gcm128_setiv(&gctx->gcm, iv, gctx->ivlen);
3005             gctx->iv_set = 1;
3006         }
3007         gctx->key_set = 1;
3008     } else {
3009         /* If key set use IV, otherwise copy */
3010         if (gctx->key_set)
3011             CRYPTO_gcm128_setiv(&gctx->gcm, iv, gctx->ivlen);
3012         else
3013             memcpy(gctx->iv, iv, gctx->ivlen);
3014         gctx->iv_set = 1;
3015         gctx->iv_gen = 0;
3016     }
3017     return 1;
3018 }
3019
3020 /*
3021  * Handle TLS GCM packet format. This consists of the last portion of the IV
3022  * followed by the payload and finally the tag. On encrypt generate IV,
3023  * encrypt payload and write the tag. On verify retrieve IV, decrypt payload
3024  * and verify tag.
3025  */
3026
3027 static int aes_gcm_tls_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
3028                               const unsigned char *in, size_t len)
3029 {
3030     EVP_AES_GCM_CTX *gctx = EVP_C_DATA(EVP_AES_GCM_CTX,ctx);
3031     int rv = -1;
3032     /* Encrypt/decrypt must be performed in place */
3033     if (out != in
3034         || len < (EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN))
3035         return -1;
3036     /*
3037      * Set IV from start of buffer or generate IV and write to start of
3038      * buffer.
3039      */
3040     if (EVP_CIPHER_CTX_ctrl(ctx, ctx->encrypt ? EVP_CTRL_GCM_IV_GEN
3041                                               : EVP_CTRL_GCM_SET_IV_INV,
3042                             EVP_GCM_TLS_EXPLICIT_IV_LEN, out) <= 0)
3043         goto err;
3044     /* Use saved AAD */
3045     if (CRYPTO_gcm128_aad(&gctx->gcm, ctx->buf, gctx->tls_aad_len))
3046         goto err;
3047     /* Fix buffer and length to point to payload */
3048     in += EVP_GCM_TLS_EXPLICIT_IV_LEN;
3049     out += EVP_GCM_TLS_EXPLICIT_IV_LEN;
3050     len -= EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN;
3051     if (ctx->encrypt) {
3052         /* Encrypt payload */
3053         if (gctx->ctr) {
3054             size_t bulk = 0;
3055 #if defined(AES_GCM_ASM)
3056             if (len >= 32 && AES_GCM_ASM(gctx)) {
3057                 if (CRYPTO_gcm128_encrypt(&gctx->gcm, NULL, NULL, 0))
3058                     return -1;
3059
3060                 bulk = AES_gcm_encrypt(in, out, len,
3061                                        gctx->gcm.key,
3062                                        gctx->gcm.Yi.c, gctx->gcm.Xi.u);
3063                 gctx->gcm.len.u[1] += bulk;
3064             }
3065 #endif
3066             if (CRYPTO_gcm128_encrypt_ctr32(&gctx->gcm,
3067                                             in + bulk,
3068                                             out + bulk,
3069                                             len - bulk, gctx->ctr))
3070                 goto err;
3071         } else {
3072             size_t bulk = 0;
3073 #if defined(AES_GCM_ASM2)
3074             if (len >= 32 && AES_GCM_ASM2(gctx)) {
3075                 if (CRYPTO_gcm128_encrypt(&gctx->gcm, NULL, NULL, 0))
3076                     return -1;
3077
3078                 bulk = AES_gcm_encrypt(in, out, len,
3079                                        gctx->gcm.key,
3080                                        gctx->gcm.Yi.c, gctx->gcm.Xi.u);
3081                 gctx->gcm.len.u[1] += bulk;
3082             }
3083 #endif
3084             if (CRYPTO_gcm128_encrypt(&gctx->gcm,
3085                                       in + bulk, out + bulk, len - bulk))
3086                 goto err;
3087         }
3088         out += len;
3089         /* Finally write tag */
3090         CRYPTO_gcm128_tag(&gctx->gcm, out, EVP_GCM_TLS_TAG_LEN);
3091         rv = len + EVP_GCM_TLS_EXPLICIT_IV_LEN + EVP_GCM_TLS_TAG_LEN;
3092     } else {
3093         /* Decrypt */
3094         if (gctx->ctr) {
3095             size_t bulk = 0;
3096 #if defined(AES_GCM_ASM)
3097             if (len >= 16 && AES_GCM_ASM(gctx)) {
3098                 if (CRYPTO_gcm128_decrypt(&gctx->gcm, NULL, NULL, 0))
3099                     return -1;
3100
3101                 bulk = AES_gcm_decrypt(in, out, len,
3102                                        gctx->gcm.key,
3103                                        gctx->gcm.Yi.c, gctx->gcm.Xi.u);
3104                 gctx->gcm.len.u[1] += bulk;
3105             }
3106 #endif
3107             if (CRYPTO_gcm128_decrypt_ctr32(&gctx->gcm,
3108                                             in + bulk,
3109                                             out + bulk,
3110                                             len - bulk, gctx->ctr))
3111                 goto err;
3112         } else {
3113             size_t bulk = 0;
3114 #if defined(AES_GCM_ASM2)
3115             if (len >= 16 && AES_GCM_ASM2(gctx)) {
3116                 if (CRYPTO_gcm128_decrypt(&gctx->gcm, NULL, NULL, 0))
3117                     return -1;
3118
3119                 bulk = AES_gcm_decrypt(in, out, len,
3120                                        gctx->gcm.key,
3121                                        gctx->gcm.Yi.c, gctx->gcm.Xi.u);
3122                 gctx->gcm.len.u[1] += bulk;
3123             }
3124 #endif
3125             if (CRYPTO_gcm128_decrypt(&gctx->gcm,
3126                                       in + bulk, out + bulk, len - bulk))
3127                 goto err;
3128         }
3129         /* Retrieve tag */
3130         CRYPTO_gcm128_tag(&gctx->gcm, ctx->buf, EVP_GCM_TLS_TAG_LEN);
3131         /* If tag mismatch wipe buffer */
3132         if (CRYPTO_memcmp(ctx->buf, in + len, EVP_GCM_TLS_TAG_LEN)) {
3133             OPENSSL_cleanse(out, len);
3134             goto err;
3135         }
3136         rv = len;
3137     }
3138
3139  err:
3140     gctx->iv_set = 0;
3141     gctx->tls_aad_len = -1;
3142     return rv;
3143 }
3144
3145 static int aes_gcm_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
3146                           const unsigned char *in, size_t len)
3147 {
3148     EVP_AES_GCM_CTX *gctx = EVP_C_DATA(EVP_AES_GCM_CTX,ctx);
3149     /* If not set up, return error */
3150     if (!gctx->key_set)
3151         return -1;
3152
3153     if (gctx->tls_aad_len >= 0)
3154         return aes_gcm_tls_cipher(ctx, out, in, len);
3155
3156     if (!gctx->iv_set)
3157         return -1;
3158     if (in) {
3159         if (out == NULL) {
3160             if (CRYPTO_gcm128_aad(&gctx->gcm, in, len))
3161                 return -1;
3162         } else if (ctx->encrypt) {
3163             if (gctx->ctr) {
3164                 size_t bulk = 0;
3165 #if defined(AES_GCM_ASM)
3166                 if (len >= 32 && AES_GCM_ASM(gctx)) {
3167                     size_t res = (16 - gctx->gcm.mres) % 16;
3168
3169                     if (CRYPTO_gcm128_encrypt(&gctx->gcm, in, out, res))
3170                         return -1;
3171
3172                     bulk = AES_gcm_encrypt(in + res,
3173                                            out + res, len - res,
3174                                            gctx->gcm.key, gctx->gcm.Yi.c,
3175                                            gctx->gcm.Xi.u);
3176                     gctx->gcm.len.u[1] += bulk;
3177                     bulk += res;
3178                 }
3179 #endif
3180                 if (CRYPTO_gcm128_encrypt_ctr32(&gctx->gcm,
3181                                                 in + bulk,
3182                                                 out + bulk,
3183                                                 len - bulk, gctx->ctr))
3184                     return -1;
3185             } else {
3186                 size_t bulk = 0;
3187 #if defined(AES_GCM_ASM2)
3188                 if (len >= 32 && AES_GCM_ASM2(gctx)) {
3189                     size_t res = (16 - gctx->gcm.mres) % 16;
3190
3191                     if (CRYPTO_gcm128_encrypt(&gctx->gcm, in, out, res))
3192                         return -1;
3193
3194                     bulk = AES_gcm_encrypt(in + res,
3195                                            out + res, len - res,
3196                                            gctx->gcm.key, gctx->gcm.Yi.c,
3197                                            gctx->gcm.Xi.u);
3198                     gctx->gcm.len.u[1] += bulk;
3199                     bulk += res;
3200                 }
3201 #endif
3202                 if (CRYPTO_gcm128_encrypt(&gctx->gcm,
3203                                           in + bulk, out + bulk, len - bulk))
3204                     return -1;
3205             }
3206         } else {
3207             if (gctx->ctr) {
3208                 size_t bulk = 0;
3209 #if defined(AES_GCM_ASM)
3210                 if (len >= 16 && AES_GCM_ASM(gctx)) {
3211                     size_t res = (16 - gctx->gcm.mres) % 16;
3212
3213                     if (CRYPTO_gcm128_decrypt(&gctx->gcm, in, out, res))
3214                         return -1;
3215
3216                     bulk = AES_gcm_decrypt(in + res,
3217                                            out + res, len - res,
3218                                            gctx->gcm.key,
3219                                            gctx->gcm.Yi.c, gctx->gcm.Xi.u);
3220                     gctx->gcm.len.u[1] += bulk;
3221                     bulk += res;
3222                 }
3223 #endif
3224                 if (CRYPTO_gcm128_decrypt_ctr32(&gctx->gcm,
3225                                                 in + bulk,
3226                                                 out + bulk,
3227                                                 len - bulk, gctx->ctr))
3228                     return -1;
3229             } else {
3230                 size_t bulk = 0;
3231 #if defined(AES_GCM_ASM2)
3232                 if (len >= 16 && AES_GCM_ASM2(gctx)) {
3233                     size_t res = (16 - gctx->gcm.mres) % 16;
3234
3235                     if (CRYPTO_gcm128_decrypt(&gctx->gcm, in, out, res))
3236                         return -1;
3237
3238                     bulk = AES_gcm_decrypt(in + res,
3239                                            out + res, len - res,
3240                                            gctx->gcm.key,
3241                                            gctx->gcm.Yi.c, gctx->gcm.Xi.u);
3242                     gctx->gcm.len.u[1] += bulk;
3243                     bulk += res;
3244                 }
3245 #endif
3246                 if (CRYPTO_gcm128_decrypt(&gctx->gcm,
3247                                           in + bulk, out + bulk, len - bulk))
3248                     return -1;
3249             }
3250         }
3251         return len;
3252     } else {
3253         if (!ctx->encrypt) {
3254             if (gctx->taglen < 0)
3255                 return -1;
3256             if (CRYPTO_gcm128_finish(&gctx->gcm, ctx->buf, gctx->taglen) != 0)
3257                 return -1;
3258             gctx->iv_set = 0;
3259             return 0;
3260         }
3261         CRYPTO_gcm128_tag(&gctx->gcm, ctx->buf, 16);
3262         gctx->taglen = 16;
3263         /* Don't reuse the IV */
3264         gctx->iv_set = 0;
3265         return 0;
3266     }
3267
3268 }
3269
3270 #define CUSTOM_FLAGS    (EVP_CIPH_FLAG_DEFAULT_ASN1 \
3271                 | EVP_CIPH_CUSTOM_IV | EVP_CIPH_FLAG_CUSTOM_CIPHER \
3272                 | EVP_CIPH_ALWAYS_CALL_INIT | EVP_CIPH_CTRL_INIT \
3273                 | EVP_CIPH_CUSTOM_COPY)
3274
3275 BLOCK_CIPHER_custom(NID_aes, 128, 1, 12, gcm, GCM,
3276                     EVP_CIPH_FLAG_AEAD_CIPHER | CUSTOM_FLAGS)
3277     BLOCK_CIPHER_custom(NID_aes, 192, 1, 12, gcm, GCM,
3278                     EVP_CIPH_FLAG_AEAD_CIPHER | CUSTOM_FLAGS)
3279     BLOCK_CIPHER_custom(NID_aes, 256, 1, 12, gcm, GCM,
3280                     EVP_CIPH_FLAG_AEAD_CIPHER | CUSTOM_FLAGS)
3281
3282 static int aes_xts_ctrl(EVP_CIPHER_CTX *c, int type, int arg, void *ptr)
3283 {
3284     EVP_AES_XTS_CTX *xctx = EVP_C_DATA(EVP_AES_XTS_CTX,c);
3285     if (type == EVP_CTRL_COPY) {
3286         EVP_CIPHER_CTX *out = ptr;
3287         EVP_AES_XTS_CTX *xctx_out = EVP_C_DATA(EVP_AES_XTS_CTX,out);
3288         if (xctx->xts.key1) {
3289             if (xctx->xts.key1 != &xctx->ks1)
3290                 return 0;
3291             xctx_out->xts.key1 = &xctx_out->ks1;
3292         }
3293         if (xctx->xts.key2) {
3294             if (xctx->xts.key2 != &xctx->ks2)
3295                 return 0;
3296             xctx_out->xts.key2 = &xctx_out->ks2;
3297         }
3298         return 1;
3299     } else if (type != EVP_CTRL_INIT)
3300         return -1;
3301     /* key1 and key2 are used as an indicator both key and IV are set */
3302     xctx->xts.key1 = NULL;
3303     xctx->xts.key2 = NULL;
3304     return 1;
3305 }
3306
3307 static int aes_xts_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
3308                             const unsigned char *iv, int enc)
3309 {
3310     EVP_AES_XTS_CTX *xctx = EVP_C_DATA(EVP_AES_XTS_CTX,ctx);
3311     if (!iv && !key)
3312         return 1;
3313
3314     if (key)
3315         do {
3316 #ifdef AES_XTS_ASM
3317             xctx->stream = enc ? AES_xts_encrypt : AES_xts_decrypt;
3318 #else
3319             xctx->stream = NULL;
3320 #endif
3321             /* key_len is two AES keys */
3322 #ifdef HWAES_CAPABLE
3323             if (HWAES_CAPABLE) {
3324                 if (enc) {
3325                     HWAES_set_encrypt_key(key,
3326                                           EVP_CIPHER_CTX_key_length(ctx) * 4,
3327                                           &xctx->ks1.ks);
3328                     xctx->xts.block1 = (block128_f) HWAES_encrypt;
3329 # ifdef HWAES_xts_encrypt
3330                     xctx->stream = HWAES_xts_encrypt;
3331 # endif
3332                 } else {
3333                     HWAES_set_decrypt_key(key,
3334                                           EVP_CIPHER_CTX_key_length(ctx) * 4,
3335                                           &xctx->ks1.ks);
3336                     xctx->xts.block1 = (block128_f) HWAES_decrypt;
3337 # ifdef HWAES_xts_decrypt
3338                     xctx->stream = HWAES_xts_decrypt;
3339 #endif
3340                 }
3341
3342                 HWAES_set_encrypt_key(key + EVP_CIPHER_CTX_key_length(ctx) / 2,
3343                                       EVP_CIPHER_CTX_key_length(ctx) * 4,
3344                                       &xctx->ks2.ks);
3345                 xctx->xts.block2 = (block128_f) HWAES_encrypt;
3346
3347                 xctx->xts.key1 = &xctx->ks1;
3348                 break;
3349             } else
3350 #endif
3351 #ifdef BSAES_CAPABLE
3352             if (BSAES_CAPABLE)
3353                 xctx->stream = enc ? bsaes_xts_encrypt : bsaes_xts_decrypt;
3354             else
3355 #endif
3356 #ifdef VPAES_CAPABLE
3357             if (VPAES_CAPABLE) {
3358                 if (enc) {
3359                     vpaes_set_encrypt_key(key,
3360                                           EVP_CIPHER_CTX_key_length(ctx) * 4,
3361                                           &xctx->ks1.ks);
3362                     xctx->xts.block1 = (block128_f) vpaes_encrypt;
3363                 } else {
3364                     vpaes_set_decrypt_key(key,
3365                                           EVP_CIPHER_CTX_key_length(ctx) * 4,
3366                                           &xctx->ks1.ks);
3367                     xctx->xts.block1 = (block128_f) vpaes_decrypt;
3368                 }
3369
3370                 vpaes_set_encrypt_key(key + EVP_CIPHER_CTX_key_length(ctx) / 2,
3371                                       EVP_CIPHER_CTX_key_length(ctx) * 4,
3372                                       &xctx->ks2.ks);
3373                 xctx->xts.block2 = (block128_f) vpaes_encrypt;
3374
3375                 xctx->xts.key1 = &xctx->ks1;
3376                 break;
3377             } else
3378 #endif
3379                 (void)0;        /* terminate potentially open 'else' */
3380
3381             if (enc) {
3382                 AES_set_encrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 4,
3383                                     &xctx->ks1.ks);
3384                 xctx->xts.block1 = (block128_f) AES_encrypt;
3385             } else {
3386                 AES_set_decrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 4,
3387                                     &xctx->ks1.ks);
3388                 xctx->xts.block1 = (block128_f) AES_decrypt;
3389             }
3390
3391             AES_set_encrypt_key(key + EVP_CIPHER_CTX_key_length(ctx) / 2,
3392                                 EVP_CIPHER_CTX_key_length(ctx) * 4,
3393                                 &xctx->ks2.ks);
3394             xctx->xts.block2 = (block128_f) AES_encrypt;
3395
3396             xctx->xts.key1 = &xctx->ks1;
3397         } while (0);
3398
3399     if (iv) {
3400         xctx->xts.key2 = &xctx->ks2;
3401         memcpy(EVP_CIPHER_CTX_iv_noconst(ctx), iv, 16);
3402     }
3403
3404     return 1;
3405 }
3406
3407 static int aes_xts_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
3408                           const unsigned char *in, size_t len)
3409 {
3410     EVP_AES_XTS_CTX *xctx = EVP_C_DATA(EVP_AES_XTS_CTX,ctx);
3411     if (!xctx->xts.key1 || !xctx->xts.key2)
3412         return 0;
3413     if (!out || !in || len < AES_BLOCK_SIZE)
3414         return 0;
3415     if (xctx->stream)
3416         (*xctx->stream) (in, out, len,
3417                          xctx->xts.key1, xctx->xts.key2,
3418                          EVP_CIPHER_CTX_iv_noconst(ctx));
3419     else if (CRYPTO_xts128_encrypt(&xctx->xts, EVP_CIPHER_CTX_iv_noconst(ctx),
3420                                    in, out, len,
3421                                    EVP_CIPHER_CTX_encrypting(ctx)))
3422         return 0;
3423     return 1;
3424 }
3425
3426 #define aes_xts_cleanup NULL
3427
3428 #define XTS_FLAGS       (EVP_CIPH_FLAG_DEFAULT_ASN1 | EVP_CIPH_CUSTOM_IV \
3429                          | EVP_CIPH_ALWAYS_CALL_INIT | EVP_CIPH_CTRL_INIT \
3430                          | EVP_CIPH_CUSTOM_COPY)
3431
3432 BLOCK_CIPHER_custom(NID_aes, 128, 1, 16, xts, XTS, XTS_FLAGS)
3433     BLOCK_CIPHER_custom(NID_aes, 256, 1, 16, xts, XTS, XTS_FLAGS)
3434
3435 static int aes_ccm_ctrl(EVP_CIPHER_CTX *c, int type, int arg, void *ptr)
3436 {
3437     EVP_AES_CCM_CTX *cctx = EVP_C_DATA(EVP_AES_CCM_CTX,c);
3438     switch (type) {
3439     case EVP_CTRL_INIT:
3440         cctx->key_set = 0;
3441         cctx->iv_set = 0;
3442         cctx->L = 8;
3443         cctx->M = 12;
3444         cctx->tag_set = 0;
3445         cctx->len_set = 0;
3446         cctx->tls_aad_len = -1;
3447         return 1;
3448
3449     case EVP_CTRL_AEAD_TLS1_AAD:
3450         /* Save the AAD for later use */
3451         if (arg != EVP_AEAD_TLS1_AAD_LEN)
3452             return 0;
3453         memcpy(EVP_CIPHER_CTX_buf_noconst(c), ptr, arg);
3454         cctx->tls_aad_len = arg;
3455         {
3456             uint16_t len =
3457                 EVP_CIPHER_CTX_buf_noconst(c)[arg - 2] << 8
3458                 | EVP_CIPHER_CTX_buf_noconst(c)[arg - 1];
3459             /* Correct length for explicit IV */
3460             if (len < EVP_CCM_TLS_EXPLICIT_IV_LEN)
3461                 return 0;
3462             len -= EVP_CCM_TLS_EXPLICIT_IV_LEN;
3463             /* If decrypting correct for tag too */
3464             if (!EVP_CIPHER_CTX_encrypting(c)) {
3465                 if (len < cctx->M)
3466                     return 0;
3467                 len -= cctx->M;
3468             }
3469             EVP_CIPHER_CTX_buf_noconst(c)[arg - 2] = len >> 8;
3470             EVP_CIPHER_CTX_buf_noconst(c)[arg - 1] = len & 0xff;
3471         }
3472         /* Extra padding: tag appended to record */
3473         return cctx->M;
3474
3475     case EVP_CTRL_CCM_SET_IV_FIXED:
3476         /* Sanity check length */
3477         if (arg != EVP_CCM_TLS_FIXED_IV_LEN)
3478             return 0;
3479         /* Just copy to first part of IV */
3480         memcpy(EVP_CIPHER_CTX_iv_noconst(c), ptr, arg);
3481         return 1;
3482
3483     case EVP_CTRL_AEAD_SET_IVLEN:
3484         arg = 15 - arg;
3485         /* fall thru */
3486     case EVP_CTRL_CCM_SET_L:
3487         if (arg < 2 || arg > 8)
3488             return 0;
3489         cctx->L = arg;
3490         return 1;
3491
3492     case EVP_CTRL_AEAD_SET_TAG:
3493         if ((arg & 1) || arg < 4 || arg > 16)
3494             return 0;
3495         if (EVP_CIPHER_CTX_encrypting(c) && ptr)
3496             return 0;
3497         if (ptr) {
3498             cctx->tag_set = 1;
3499             memcpy(EVP_CIPHER_CTX_buf_noconst(c), ptr, arg);
3500         }
3501         cctx->M = arg;
3502         return 1;
3503
3504     case EVP_CTRL_AEAD_GET_TAG:
3505         if (!EVP_CIPHER_CTX_encrypting(c) || !cctx->tag_set)
3506             return 0;
3507         if (!CRYPTO_ccm128_tag(&cctx->ccm, ptr, (size_t)arg))
3508             return 0;
3509         cctx->tag_set = 0;
3510         cctx->iv_set = 0;
3511         cctx->len_set = 0;
3512         return 1;
3513
3514     case EVP_CTRL_COPY:
3515         {
3516             EVP_CIPHER_CTX *out = ptr;
3517             EVP_AES_CCM_CTX *cctx_out = EVP_C_DATA(EVP_AES_CCM_CTX,out);
3518             if (cctx->ccm.key) {
3519                 if (cctx->ccm.key != &cctx->ks)
3520                     return 0;
3521                 cctx_out->ccm.key = &cctx_out->ks;
3522             }
3523             return 1;
3524         }
3525
3526     default:
3527         return -1;
3528
3529     }
3530 }
3531
3532 static int aes_ccm_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
3533                             const unsigned char *iv, int enc)
3534 {
3535     EVP_AES_CCM_CTX *cctx = EVP_C_DATA(EVP_AES_CCM_CTX,ctx);
3536     if (!iv && !key)
3537         return 1;
3538     if (key)
3539         do {
3540 #ifdef HWAES_CAPABLE
3541             if (HWAES_CAPABLE) {
3542                 HWAES_set_encrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
3543                                       &cctx->ks.ks);
3544
3545                 CRYPTO_ccm128_init(&cctx->ccm, cctx->M, cctx->L,
3546                                    &cctx->ks, (block128_f) HWAES_encrypt);
3547                 cctx->str = NULL;
3548                 cctx->key_set = 1;
3549                 break;
3550             } else
3551 #endif
3552 #ifdef VPAES_CAPABLE
3553             if (VPAES_CAPABLE) {
3554                 vpaes_set_encrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
3555                                       &cctx->ks.ks);
3556                 CRYPTO_ccm128_init(&cctx->ccm, cctx->M, cctx->L,
3557                                    &cctx->ks, (block128_f) vpaes_encrypt);
3558                 cctx->str = NULL;
3559                 cctx->key_set = 1;
3560                 break;
3561             }
3562 #endif
3563             AES_set_encrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
3564                                 &cctx->ks.ks);
3565             CRYPTO_ccm128_init(&cctx->ccm, cctx->M, cctx->L,
3566                                &cctx->ks, (block128_f) AES_encrypt);
3567             cctx->str = NULL;
3568             cctx->key_set = 1;
3569         } while (0);
3570     if (iv) {
3571         memcpy(EVP_CIPHER_CTX_iv_noconst(ctx), iv, 15 - cctx->L);
3572         cctx->iv_set = 1;
3573     }
3574     return 1;
3575 }
3576
3577 static int aes_ccm_tls_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
3578                               const unsigned char *in, size_t len)
3579 {
3580     EVP_AES_CCM_CTX *cctx = EVP_C_DATA(EVP_AES_CCM_CTX,ctx);
3581     CCM128_CONTEXT *ccm = &cctx->ccm;
3582     /* Encrypt/decrypt must be performed in place */
3583     if (out != in || len < (EVP_CCM_TLS_EXPLICIT_IV_LEN + (size_t)cctx->M))
3584         return -1;
3585     /* If encrypting set explicit IV from sequence number (start of AAD) */
3586     if (EVP_CIPHER_CTX_encrypting(ctx))
3587         memcpy(out, EVP_CIPHER_CTX_buf_noconst(ctx),
3588                EVP_CCM_TLS_EXPLICIT_IV_LEN);
3589     /* Get rest of IV from explicit IV */
3590     memcpy(EVP_CIPHER_CTX_iv_noconst(ctx) + EVP_CCM_TLS_FIXED_IV_LEN, in,
3591            EVP_CCM_TLS_EXPLICIT_IV_LEN);
3592     /* Correct length value */
3593     len -= EVP_CCM_TLS_EXPLICIT_IV_LEN + cctx->M;
3594     if (CRYPTO_ccm128_setiv(ccm, EVP_CIPHER_CTX_iv_noconst(ctx), 15 - cctx->L,
3595                             len))
3596             return -1;
3597     /* Use saved AAD */
3598     CRYPTO_ccm128_aad(ccm, EVP_CIPHER_CTX_buf_noconst(ctx), cctx->tls_aad_len);
3599     /* Fix buffer to point to payload */
3600     in += EVP_CCM_TLS_EXPLICIT_IV_LEN;
3601     out += EVP_CCM_TLS_EXPLICIT_IV_LEN;
3602     if (EVP_CIPHER_CTX_encrypting(ctx)) {
3603         if (cctx->str ? CRYPTO_ccm128_encrypt_ccm64(ccm, in, out, len,
3604                                                     cctx->str) :
3605             CRYPTO_ccm128_encrypt(ccm, in, out, len))
3606             return -1;
3607         if (!CRYPTO_ccm128_tag(ccm, out + len, cctx->M))
3608             return -1;
3609         return len + EVP_CCM_TLS_EXPLICIT_IV_LEN + cctx->M;
3610     } else {
3611         if (cctx->str ? !CRYPTO_ccm128_decrypt_ccm64(ccm, in, out, len,
3612                                                      cctx->str) :
3613             !CRYPTO_ccm128_decrypt(ccm, in, out, len)) {
3614             unsigned char tag[16];
3615             if (CRYPTO_ccm128_tag(ccm, tag, cctx->M)) {
3616                 if (!CRYPTO_memcmp(tag, in + len, cctx->M))
3617                     return len;
3618             }
3619         }
3620         OPENSSL_cleanse(out, len);
3621         return -1;
3622     }
3623 }
3624
3625 static int aes_ccm_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
3626                           const unsigned char *in, size_t len)
3627 {
3628     EVP_AES_CCM_CTX *cctx = EVP_C_DATA(EVP_AES_CCM_CTX,ctx);
3629     CCM128_CONTEXT *ccm = &cctx->ccm;
3630     /* If not set up, return error */
3631     if (!cctx->key_set)
3632         return -1;
3633
3634     if (cctx->tls_aad_len >= 0)
3635         return aes_ccm_tls_cipher(ctx, out, in, len);
3636
3637     /* EVP_*Final() doesn't return any data */
3638     if (in == NULL && out != NULL)
3639         return 0;
3640
3641     if (!cctx->iv_set)
3642         return -1;
3643
3644     if (!EVP_CIPHER_CTX_encrypting(ctx) && !cctx->tag_set)
3645         return -1;
3646     if (!out) {
3647         if (!in) {
3648             if (CRYPTO_ccm128_setiv(ccm, EVP_CIPHER_CTX_iv_noconst(ctx),
3649                                     15 - cctx->L, len))
3650                 return -1;
3651             cctx->len_set = 1;
3652             return len;
3653         }
3654         /* If have AAD need message length */
3655         if (!cctx->len_set && len)
3656             return -1;
3657         CRYPTO_ccm128_aad(ccm, in, len);
3658         return len;
3659     }
3660     /* If not set length yet do it */
3661     if (!cctx->len_set) {
3662         if (CRYPTO_ccm128_setiv(ccm, EVP_CIPHER_CTX_iv_noconst(ctx),
3663                                 15 - cctx->L, len))
3664             return -1;
3665         cctx->len_set = 1;
3666     }
3667     if (EVP_CIPHER_CTX_encrypting(ctx)) {
3668         if (cctx->str ? CRYPTO_ccm128_encrypt_ccm64(ccm, in, out, len,
3669                                                     cctx->str) :
3670             CRYPTO_ccm128_encrypt(ccm, in, out, len))
3671             return -1;
3672         cctx->tag_set = 1;
3673         return len;
3674     } else {
3675         int rv = -1;
3676         if (cctx->str ? !CRYPTO_ccm128_decrypt_ccm64(ccm, in, out, len,
3677                                                      cctx->str) :
3678             !CRYPTO_ccm128_decrypt(ccm, in, out, len)) {
3679             unsigned char tag[16];
3680             if (CRYPTO_ccm128_tag(ccm, tag, cctx->M)) {
3681                 if (!CRYPTO_memcmp(tag, EVP_CIPHER_CTX_buf_noconst(ctx),
3682                                    cctx->M))
3683                     rv = len;
3684             }
3685         }
3686         if (rv == -1)
3687             OPENSSL_cleanse(out, len);
3688         cctx->iv_set = 0;
3689         cctx->tag_set = 0;
3690         cctx->len_set = 0;
3691         return rv;
3692     }
3693 }
3694
3695 #define aes_ccm_cleanup NULL
3696
3697 BLOCK_CIPHER_custom(NID_aes, 128, 1, 12, ccm, CCM,
3698                     EVP_CIPH_FLAG_AEAD_CIPHER | CUSTOM_FLAGS)
3699     BLOCK_CIPHER_custom(NID_aes, 192, 1, 12, ccm, CCM,
3700                         EVP_CIPH_FLAG_AEAD_CIPHER | CUSTOM_FLAGS)
3701     BLOCK_CIPHER_custom(NID_aes, 256, 1, 12, ccm, CCM,
3702                         EVP_CIPH_FLAG_AEAD_CIPHER | CUSTOM_FLAGS)
3703
3704 typedef struct {
3705     union {
3706         double align;
3707         AES_KEY ks;
3708     } ks;
3709     /* Indicates if IV has been set */
3710     unsigned char *iv;
3711 } EVP_AES_WRAP_CTX;
3712
3713 static int aes_wrap_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
3714                              const unsigned char *iv, int enc)
3715 {
3716     EVP_AES_WRAP_CTX *wctx = EVP_C_DATA(EVP_AES_WRAP_CTX,ctx);
3717     if (!iv && !key)
3718         return 1;
3719     if (key) {
3720         if (EVP_CIPHER_CTX_encrypting(ctx))
3721             AES_set_encrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
3722                                 &wctx->ks.ks);
3723         else
3724             AES_set_decrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
3725                                 &wctx->ks.ks);
3726         if (!iv)
3727             wctx->iv = NULL;
3728     }
3729     if (iv) {
3730         memcpy(EVP_CIPHER_CTX_iv_noconst(ctx), iv, EVP_CIPHER_CTX_iv_length(ctx));
3731         wctx->iv = EVP_CIPHER_CTX_iv_noconst(ctx);
3732     }
3733     return 1;
3734 }
3735
3736 static int aes_wrap_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
3737                            const unsigned char *in, size_t inlen)
3738 {
3739     EVP_AES_WRAP_CTX *wctx = EVP_C_DATA(EVP_AES_WRAP_CTX,ctx);
3740     size_t rv;
3741     /* AES wrap with padding has IV length of 4, without padding 8 */
3742     int pad = EVP_CIPHER_CTX_iv_length(ctx) == 4;
3743     /* No final operation so always return zero length */
3744     if (!in)
3745         return 0;
3746     /* Input length must always be non-zero */
3747     if (!inlen)
3748         return -1;
3749     /* If decrypting need at least 16 bytes and multiple of 8 */
3750     if (!EVP_CIPHER_CTX_encrypting(ctx) && (inlen < 16 || inlen & 0x7))
3751         return -1;
3752     /* If not padding input must be multiple of 8 */
3753     if (!pad && inlen & 0x7)
3754         return -1;
3755     if (is_partially_overlapping(out, in, inlen)) {
3756         EVPerr(EVP_F_AES_WRAP_CIPHER, EVP_R_PARTIALLY_OVERLAPPING);
3757         return 0;
3758     }
3759     if (!out) {
3760         if (EVP_CIPHER_CTX_encrypting(ctx)) {
3761             /* If padding round up to multiple of 8 */
3762             if (pad)
3763                 inlen = (inlen + 7) / 8 * 8;
3764             /* 8 byte prefix */
3765             return inlen + 8;
3766         } else {
3767             /*
3768              * If not padding output will be exactly 8 bytes smaller than
3769              * input. If padding it will be at least 8 bytes smaller but we
3770              * don't know how much.
3771              */
3772             return inlen - 8;
3773         }
3774     }
3775     if (pad) {
3776         if (EVP_CIPHER_CTX_encrypting(ctx))
3777             rv = CRYPTO_128_wrap_pad(&wctx->ks.ks, wctx->iv,
3778                                      out, in, inlen,
3779                                      (block128_f) AES_encrypt);
3780         else
3781             rv = CRYPTO_128_unwrap_pad(&wctx->ks.ks, wctx->iv,
3782                                        out, in, inlen,
3783                                        (block128_f) AES_decrypt);
3784     } else {
3785         if (EVP_CIPHER_CTX_encrypting(ctx))
3786             rv = CRYPTO_128_wrap(&wctx->ks.ks, wctx->iv,
3787                                  out, in, inlen, (block128_f) AES_encrypt);
3788         else
3789             rv = CRYPTO_128_unwrap(&wctx->ks.ks, wctx->iv,
3790                                    out, in, inlen, (block128_f) AES_decrypt);
3791     }
3792     return rv ? (int)rv : -1;
3793 }
3794
3795 #define WRAP_FLAGS      (EVP_CIPH_WRAP_MODE \
3796                 | EVP_CIPH_CUSTOM_IV | EVP_CIPH_FLAG_CUSTOM_CIPHER \
3797                 | EVP_CIPH_ALWAYS_CALL_INIT | EVP_CIPH_FLAG_DEFAULT_ASN1)
3798
3799 static const EVP_CIPHER aes_128_wrap = {
3800     NID_id_aes128_wrap,
3801     8, 16, 8, WRAP_FLAGS,
3802     aes_wrap_init_key, aes_wrap_cipher,
3803     NULL,
3804     sizeof(EVP_AES_WRAP_CTX),
3805     NULL, NULL, NULL, NULL
3806 };
3807
3808 const EVP_CIPHER *EVP_aes_128_wrap(void)
3809 {
3810     return &aes_128_wrap;
3811 }
3812
3813 static const EVP_CIPHER aes_192_wrap = {
3814     NID_id_aes192_wrap,
3815     8, 24, 8, WRAP_FLAGS,
3816     aes_wrap_init_key, aes_wrap_cipher,
3817     NULL,
3818     sizeof(EVP_AES_WRAP_CTX),
3819     NULL, NULL, NULL, NULL
3820 };
3821
3822 const EVP_CIPHER *EVP_aes_192_wrap(void)
3823 {
3824     return &aes_192_wrap;
3825 }
3826
3827 static const EVP_CIPHER aes_256_wrap = {
3828     NID_id_aes256_wrap,
3829     8, 32, 8, WRAP_FLAGS,
3830     aes_wrap_init_key, aes_wrap_cipher,
3831     NULL,
3832     sizeof(EVP_AES_WRAP_CTX),
3833     NULL, NULL, NULL, NULL
3834 };
3835
3836 const EVP_CIPHER *EVP_aes_256_wrap(void)
3837 {
3838     return &aes_256_wrap;
3839 }
3840
3841 static const EVP_CIPHER aes_128_wrap_pad = {
3842     NID_id_aes128_wrap_pad,
3843     8, 16, 4, WRAP_FLAGS,
3844     aes_wrap_init_key, aes_wrap_cipher,
3845     NULL,
3846     sizeof(EVP_AES_WRAP_CTX),
3847     NULL, NULL, NULL, NULL
3848 };
3849
3850 const EVP_CIPHER *EVP_aes_128_wrap_pad(void)
3851 {
3852     return &aes_128_wrap_pad;
3853 }
3854
3855 static const EVP_CIPHER aes_192_wrap_pad = {
3856     NID_id_aes192_wrap_pad,
3857     8, 24, 4, WRAP_FLAGS,
3858     aes_wrap_init_key, aes_wrap_cipher,
3859     NULL,
3860     sizeof(EVP_AES_WRAP_CTX),
3861     NULL, NULL, NULL, NULL
3862 };
3863
3864 const EVP_CIPHER *EVP_aes_192_wrap_pad(void)
3865 {
3866     return &aes_192_wrap_pad;
3867 }
3868
3869 static const EVP_CIPHER aes_256_wrap_pad = {
3870     NID_id_aes256_wrap_pad,
3871     8, 32, 4, WRAP_FLAGS,
3872     aes_wrap_init_key, aes_wrap_cipher,
3873     NULL,
3874     sizeof(EVP_AES_WRAP_CTX),
3875     NULL, NULL, NULL, NULL
3876 };
3877
3878 const EVP_CIPHER *EVP_aes_256_wrap_pad(void)
3879 {
3880     return &aes_256_wrap_pad;
3881 }
3882
3883 #ifndef OPENSSL_NO_OCB
3884 static int aes_ocb_ctrl(EVP_CIPHER_CTX *c, int type, int arg, void *ptr)
3885 {
3886     EVP_AES_OCB_CTX *octx = EVP_C_DATA(EVP_AES_OCB_CTX,c);
3887     EVP_CIPHER_CTX *newc;
3888     EVP_AES_OCB_CTX *new_octx;
3889
3890     switch (type) {
3891     case EVP_CTRL_INIT:
3892         octx->key_set = 0;
3893         octx->iv_set = 0;
3894         octx->ivlen = EVP_CIPHER_CTX_iv_length(c);
3895         octx->iv = EVP_CIPHER_CTX_iv_noconst(c);
3896         octx->taglen = 16;
3897         octx->data_buf_len = 0;
3898         octx->aad_buf_len = 0;
3899         return 1;
3900
3901     case EVP_CTRL_AEAD_SET_IVLEN:
3902         /* IV len must be 1 to 15 */
3903         if (arg <= 0 || arg > 15)
3904             return 0;
3905
3906         octx->ivlen = arg;
3907         return 1;
3908
3909     case EVP_CTRL_AEAD_SET_TAG:
3910         if (!ptr) {
3911             /* Tag len must be 0 to 16 */
3912             if (arg < 0 || arg > 16)
3913                 return 0;
3914
3915             octx->taglen = arg;
3916             return 1;
3917         }
3918         if (arg != octx->taglen || EVP_CIPHER_CTX_encrypting(c))
3919             return 0;
3920         memcpy(octx->tag, ptr, arg);
3921         return 1;
3922
3923     case EVP_CTRL_AEAD_GET_TAG:
3924         if (arg != octx->taglen || !EVP_CIPHER_CTX_encrypting(c))
3925             return 0;
3926
3927         memcpy(ptr, octx->tag, arg);
3928         return 1;
3929
3930     case EVP_CTRL_COPY:
3931         newc = (EVP_CIPHER_CTX *)ptr;
3932         new_octx = EVP_C_DATA(EVP_AES_OCB_CTX,newc);
3933         return CRYPTO_ocb128_copy_ctx(&new_octx->ocb, &octx->ocb,
3934                                       &new_octx->ksenc.ks,
3935                                       &new_octx->ksdec.ks);
3936
3937     default:
3938         return -1;
3939
3940     }
3941 }
3942
3943 # ifdef HWAES_CAPABLE
3944 #  ifdef HWAES_ocb_encrypt
3945 void HWAES_ocb_encrypt(const unsigned char *in, unsigned char *out,
3946                        size_t blocks, const void *key,
3947                        size_t start_block_num,
3948                        unsigned char offset_i[16],
3949                        const unsigned char L_[][16],
3950                        unsigned char checksum[16]);
3951 #  else
3952 #    define HWAES_ocb_encrypt ((ocb128_f)NULL)
3953 #  endif
3954 #  ifdef HWAES_ocb_decrypt
3955 void HWAES_ocb_decrypt(const unsigned char *in, unsigned char *out,
3956                        size_t blocks, const void *key,
3957                        size_t start_block_num,
3958                        unsigned char offset_i[16],
3959                        const unsigned char L_[][16],
3960                        unsigned char checksum[16]);
3961 #  else
3962 #    define HWAES_ocb_decrypt ((ocb128_f)NULL)
3963 #  endif
3964 # endif
3965
3966 static int aes_ocb_init_key(EVP_CIPHER_CTX *ctx, const unsigned char *key,
3967                             const unsigned char *iv, int enc)
3968 {
3969     EVP_AES_OCB_CTX *octx = EVP_C_DATA(EVP_AES_OCB_CTX,ctx);
3970     if (!iv && !key)
3971         return 1;
3972     if (key) {
3973         do {
3974             /*
3975              * We set both the encrypt and decrypt key here because decrypt
3976              * needs both. We could possibly optimise to remove setting the
3977              * decrypt for an encryption operation.
3978              */
3979 # ifdef HWAES_CAPABLE
3980             if (HWAES_CAPABLE) {
3981                 HWAES_set_encrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
3982                                       &octx->ksenc.ks);
3983                 HWAES_set_decrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
3984                                       &octx->ksdec.ks);
3985                 if (!CRYPTO_ocb128_init(&octx->ocb,
3986                                         &octx->ksenc.ks, &octx->ksdec.ks,
3987                                         (block128_f) HWAES_encrypt,
3988                                         (block128_f) HWAES_decrypt,
3989                                         enc ? HWAES_ocb_encrypt
3990                                             : HWAES_ocb_decrypt))
3991                     return 0;
3992                 break;
3993             }
3994 # endif
3995 # ifdef VPAES_CAPABLE
3996             if (VPAES_CAPABLE) {
3997                 vpaes_set_encrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
3998                                       &octx->ksenc.ks);
3999                 vpaes_set_decrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
4000                                       &octx->ksdec.ks);
4001                 if (!CRYPTO_ocb128_init(&octx->ocb,
4002                                         &octx->ksenc.ks, &octx->ksdec.ks,
4003                                         (block128_f) vpaes_encrypt,
4004                                         (block128_f) vpaes_decrypt,
4005                                         NULL))
4006                     return 0;
4007                 break;
4008             }
4009 # endif
4010             AES_set_encrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
4011                                 &octx->ksenc.ks);
4012             AES_set_decrypt_key(key, EVP_CIPHER_CTX_key_length(ctx) * 8,
4013                                 &octx->ksdec.ks);
4014             if (!CRYPTO_ocb128_init(&octx->ocb,
4015                                     &octx->ksenc.ks, &octx->ksdec.ks,
4016                                     (block128_f) AES_encrypt,
4017                                     (block128_f) AES_decrypt,
4018                                     NULL))
4019                 return 0;
4020         }
4021         while (0);
4022
4023         /*
4024          * If we have an iv we can set it directly, otherwise use saved IV.
4025          */
4026         if (iv == NULL && octx->iv_set)
4027             iv = octx->iv;
4028         if (iv) {
4029             if (CRYPTO_ocb128_setiv(&octx->ocb, iv, octx->ivlen, octx->taglen)
4030                 != 1)
4031                 return 0;
4032             octx->iv_set = 1;
4033         }
4034         octx->key_set = 1;
4035     } else {
4036         /* If key set use IV, otherwise copy */
4037         if (octx->key_set)
4038             CRYPTO_ocb128_setiv(&octx->ocb, iv, octx->ivlen, octx->taglen);
4039         else
4040             memcpy(octx->iv, iv, octx->ivlen);
4041         octx->iv_set = 1;
4042     }
4043     return 1;
4044 }
4045
4046 static int aes_ocb_cipher(EVP_CIPHER_CTX *ctx, unsigned char *out,
4047                           const unsigned char *in, size_t len)
4048 {
4049     unsigned char *buf;
4050     int *buf_len;
4051     int written_len = 0;
4052     size_t trailing_len;
4053     EVP_AES_OCB_CTX *octx = EVP_C_DATA(EVP_AES_OCB_CTX,ctx);
4054
4055     /* If IV or Key not set then return error */
4056     if (!octx->iv_set)
4057         return -1;
4058
4059     if (!octx->key_set)
4060         return -1;
4061
4062     if (in != NULL) {
4063         /*
4064          * Need to ensure we are only passing full blocks to low level OCB
4065          * routines. We do it here rather than in EVP_EncryptUpdate/
4066          * EVP_DecryptUpdate because we need to pass full blocks of AAD too
4067          * and those routines don't support that
4068          */
4069
4070         /* Are we dealing with AAD or normal data here? */
4071         if (out == NULL) {
4072             buf = octx->aad_buf;
4073             buf_len = &(octx->aad_buf_len);
4074         } else {
4075             buf = octx->data_buf;
4076             buf_len = &(octx->data_buf_len);
4077
4078             if (is_partially_overlapping(out + *buf_len, in, len)) {
4079                 EVPerr(EVP_F_AES_OCB_CIPHER, EVP_R_PARTIALLY_OVERLAPPING);
4080                 return 0;
4081             }
4082         }
4083
4084         /*
4085          * If we've got a partially filled buffer from a previous call then
4086          * use that data first
4087          */
4088         if (*buf_len > 0) {
4089             unsigned int remaining;
4090
4091             remaining = AES_BLOCK_SIZE - (*buf_len);
4092             if (remaining > len) {
4093                 memcpy(buf + (*buf_len), in, len);
4094                 *(buf_len) += len;
4095                 return 0;
4096             }
4097             memcpy(buf + (*buf_len), in, remaining);
4098
4099             /*
4100              * If we get here we've filled the buffer, so process it
4101              */
4102             len -= remaining;
4103             in += remaining;
4104             if (out == NULL) {
4105                 if (!CRYPTO_ocb128_aad(&octx->ocb, buf, AES_BLOCK_SIZE))
4106                     return -1;
4107             } else if (EVP_CIPHER_CTX_encrypting(ctx)) {
4108                 if (!CRYPTO_ocb128_encrypt(&octx->ocb, buf, out,
4109                                            AES_BLOCK_SIZE))
4110                     return -1;
4111             } else {
4112                 if (!CRYPTO_ocb128_decrypt(&octx->ocb, buf, out,
4113                                            AES_BLOCK_SIZE))
4114                     return -1;
4115             }
4116             written_len = AES_BLOCK_SIZE;
4117             *buf_len = 0;
4118             if (out != NULL)
4119                 out += AES_BLOCK_SIZE;
4120         }
4121
4122         /* Do we have a partial block to handle at the end? */
4123         trailing_len = len % AES_BLOCK_SIZE;
4124
4125         /*
4126          * If we've got some full blocks to handle, then process these first
4127          */
4128         if (len != trailing_len) {
4129             if (out == NULL) {
4130                 if (!CRYPTO_ocb128_aad(&octx->ocb, in, len - trailing_len))
4131                     return -1;
4132             } else if (EVP_CIPHER_CTX_encrypting(ctx)) {
4133                 if (!CRYPTO_ocb128_encrypt
4134                     (&octx->ocb, in, out, len - trailing_len))
4135                     return -1;
4136             } else {
4137                 if (!CRYPTO_ocb128_decrypt
4138                     (&octx->ocb, in, out, len - trailing_len))
4139                     return -1;
4140             }
4141             written_len += len - trailing_len;
4142             in += len - trailing_len;
4143         }
4144
4145         /* Handle any trailing partial block */
4146         if (trailing_len > 0) {
4147             memcpy(buf, in, trailing_len);
4148             *buf_len = trailing_len;
4149         }
4150
4151         return written_len;
4152     } else {
4153         /*
4154          * First of all empty the buffer of any partial block that we might
4155          * have been provided - both for data and AAD
4156          */
4157         if (octx->data_buf_len > 0) {
4158             if (EVP_CIPHER_CTX_encrypting(ctx)) {
4159                 if (!CRYPTO_ocb128_encrypt(&octx->ocb, octx->data_buf, out,
4160                                            octx->data_buf_len))
4161                     return -1;
4162             } else {
4163                 if (!CRYPTO_ocb128_decrypt(&octx->ocb, octx->data_buf, out,
4164                                            octx->data_buf_len))
4165                     return -1;
4166             }
4167             written_len = octx->data_buf_len;
4168             octx->data_buf_len = 0;
4169         }
4170         if (octx->aad_buf_len > 0) {
4171             if (!CRYPTO_ocb128_aad
4172                 (&octx->ocb, octx->aad_buf, octx->aad_buf_len))
4173                 return -1;
4174             octx->aad_buf_len = 0;
4175         }
4176         /* If decrypting then verify */
4177         if (!EVP_CIPHER_CTX_encrypting(ctx)) {
4178             if (octx->taglen < 0)
4179                 return -1;
4180             if (CRYPTO_ocb128_finish(&octx->ocb,
4181                                      octx->tag, octx->taglen) != 0)
4182                 return -1;
4183             octx->iv_set = 0;
4184             return written_len;
4185         }
4186         /* If encrypting then just get the tag */
4187         if (CRYPTO_ocb128_tag(&octx->ocb, octx->tag, 16) != 1)
4188             return -1;
4189         /* Don't reuse the IV */
4190         octx->iv_set = 0;
4191         return written_len;
4192     }
4193 }
4194
4195 static int aes_ocb_cleanup(EVP_CIPHER_CTX *c)
4196 {
4197     EVP_AES_OCB_CTX *octx = EVP_C_DATA(EVP_AES_OCB_CTX,c);
4198     CRYPTO_ocb128_cleanup(&octx->ocb);
4199     return 1;
4200 }
4201
4202 BLOCK_CIPHER_custom(NID_aes, 128, 16, 12, ocb, OCB,
4203                     EVP_CIPH_FLAG_AEAD_CIPHER | CUSTOM_FLAGS)
4204 BLOCK_CIPHER_custom(NID_aes, 192, 16, 12, ocb, OCB,
4205                     EVP_CIPH_FLAG_AEAD_CIPHER | CUSTOM_FLAGS)
4206 BLOCK_CIPHER_custom(NID_aes, 256, 16, 12, ocb, OCB,
4207                     EVP_CIPH_FLAG_AEAD_CIPHER | CUSTOM_FLAGS)
4208 #endif                         /* OPENSSL_NO_OCB */