crypto/engine/eng_aesni.c

   1 /*
   2  * Support for Intel AES-NI intruction set
   3  *   Author: Huang Ying <ying.huang@intel.com>
   4  *
   5  * Intel AES-NI is a new set of Single Instruction Multiple Data
   6  * (SIMD) instructions that are going to be introduced in the next
   7  * generation of Intel processor, as of 2009. These instructions
   8  * enable fast and secure data encryption and decryption, using the
   9  * Advanced Encryption Standard (AES), defined by FIPS Publication
  10  * number 197.  The architecture introduces six instructions that
  11  * offer full hardware support for AES. Four of them support high
  12  * performance data encryption and decryption, and the other two
  13  * instructions support the AES key expansion procedure.
  14  *
  15  * The white paper can be downloaded from:
  16  *   http://softwarecommunity.intel.com/isn/downloads/intelavx/AES-Instructions-Set_WP.pdf
  17  *
  18  * This file is based on engines/e_padlock.c
  19  */
  20
  21 /* ====================================================================
  22  * Copyright (c) 1999-2001 The OpenSSL Project.  All rights reserved.
  23  *
  24  * Redistribution and use in source and binary forms, with or without
  25  * modification, are permitted provided that the following conditions
  26  * are met:
  27  *
  28  * 1. Redistributions of source code must retain the above copyright
  29  *    notice, this list of conditions and the following disclaimer.
  30  *
  31  * 2. Redistributions in binary form must reproduce the above copyright
  32  *    notice, this list of conditions and the following disclaimer in
  33  *    the documentation and/or other materials provided with the
  34  *    distribution.
  35  *
  36  * 3. All advertising materials mentioning features or use of this
  37  *    software must display the following acknowledgment:
  38  *    "This product includes software developed by the OpenSSL Project
  39  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
  40  *
  41  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  42  *    endorse or promote products derived from this software without
  43  *    prior written permission. For written permission, please contact
  44  *    licensing@OpenSSL.org.
  45  *
  46  * 5. Products derived from this software may not be called "OpenSSL"
  47  *    nor may "OpenSSL" appear in their names without prior written
  48  *    permission of the OpenSSL Project.
  49  *
  50  * 6. Redistributions of any form whatsoever must retain the following
  51  *    acknowledgment:
  52  *    "This product includes software developed by the OpenSSL Project
  53  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
  54  *
  55  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  56  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  57  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  58  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  59  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  60  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  61  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  62  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  63  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  64  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  65  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  66  * OF THE POSSIBILITY OF SUCH DAMAGE.
  67  * ====================================================================
  68  *
  69  * This product includes cryptographic software written by Eric Young
  70  * (eay@cryptsoft.com).  This product includes software written by Tim
  71  * Hudson (tjh@cryptsoft.com).
  72  *
  73  */
  74
  75
  76 #include <openssl/opensslconf.h>
  77
  78 #if !defined(OPENSSL_NO_HW) && !defined(OPENSSL_NO_HW_AES_NI) && !defined(OPENSSL_NO_AES)
  79
  80 #include <stdio.h>
  81 #include <string.h>
  82 #include <assert.h>
  83 #include <openssl/crypto.h>
  84 #include <openssl/dso.h>
  85 #include <openssl/engine.h>
  86 #include <openssl/evp.h>
  87 #include <openssl/aes.h>
  88 #include <openssl/err.h>
  89 #include <cryptlib.h>
  90 #include <openssl/modes.h>
  91
  92 /* AES-NI is available *ONLY* on some x86 CPUs.  Not only that it
  93    doesn't exist elsewhere, but it even can't be compiled on other
  94    platforms! */
  95 #undef COMPILE_HW_AESNI
  96 #if (defined(__x86_64) || defined(__x86_64__) || \
  97      defined(_M_AMD64) || defined(_M_X64) || \
  98      defined(OPENSSL_IA32_SSE2)) && !defined(OPENSSL_NO_ASM)
  99 #define COMPILE_HW_AESNI
 100 static ENGINE *ENGINE_aesni (void);
 101 #endif
 102
 103 void ENGINE_load_aesni (void)
 104 {
 105 /* On non-x86 CPUs it just returns. */
 106 #ifdef COMPILE_HW_AESNI
 107         ENGINE *toadd = ENGINE_aesni();
 108         if (!toadd)
 109                 return;
 110         ENGINE_add (toadd);
 111         ENGINE_free (toadd);
 112         ERR_clear_error ();
 113 #endif
 114 }
 115
 116 #ifdef COMPILE_HW_AESNI
 117 int aesni_set_encrypt_key(const unsigned char *userKey, int bits,
 118                               AES_KEY *key);
 119 int aesni_set_decrypt_key(const unsigned char *userKey, int bits,
 120                               AES_KEY *key);
 121
 122 void aesni_encrypt(const unsigned char *in, unsigned char *out,
 123                        const AES_KEY *key);
 124 void aesni_decrypt(const unsigned char *in, unsigned char *out,
 125                        const AES_KEY *key);
 126
 127 void aesni_ecb_encrypt(const unsigned char *in,
 128                            unsigned char *out,
 129                            size_t length,
 130                            const AES_KEY *key,
 131                            int enc);
 132 void aesni_cbc_encrypt(const unsigned char *in,
 133                            unsigned char *out,
 134                            size_t length,
 135                            const AES_KEY *key,
 136                            unsigned char *ivec, int enc);
 137
 138 /* Function for ENGINE detection and control */
 139 static int aesni_init(ENGINE *e);
 140
 141 /* Cipher Stuff */
 142 static int aesni_ciphers(ENGINE *e, const EVP_CIPHER **cipher,
 143                                 const int **nids, int nid);
 144
 145 #define AESNI_MIN_ALIGN 16
 146 #define AESNI_ALIGN(x) \
 147         ((void *)(((unsigned long)(x)+AESNI_MIN_ALIGN-1)&~(AESNI_MIN_ALIGN-1)))
 148
 149 /* Engine names */
 150 static const char   aesni_id[] = "aesni",
 151                     aesni_name[] = "Intel AES-NI engine",
 152                     no_aesni_name[] = "Intel AES-NI engine (no-aesni)";
 153
 154 /* ===== Engine "management" functions ===== */
 155
 156 /* Prepare the ENGINE structure for registration */
 157 static int
 158 aesni_bind_helper(ENGINE *e)
 159 {
 160         int engage = (OPENSSL_ia32cap_P[1] & (1 << (57-32))) != 0;
 161
 162         /* Register everything or return with an error */
 163         if (!ENGINE_set_id(e, aesni_id) ||
 164             !ENGINE_set_name(e, engage ? aesni_name : no_aesni_name) ||
 165
 166             !ENGINE_set_init_function(e, aesni_init) ||
 167             (engage && !ENGINE_set_ciphers (e, aesni_ciphers))
 168             )
 169                 return 0;
 170
 171         /* Everything looks good */
 172         return 1;
 173 }
 174
 175 /* Constructor */
 176 static ENGINE *
 177 ENGINE_aesni(void)
 178 {
 179         ENGINE *eng = ENGINE_new();
 180
 181         if (!eng) {
 182                 return NULL;
 183         }
 184
 185         if (!aesni_bind_helper(eng)) {
 186                 ENGINE_free(eng);
 187                 return NULL;
 188         }
 189
 190         return eng;
 191 }
 192
 193 /* Check availability of the engine */
 194 static int
 195 aesni_init(ENGINE *e)
 196 {
 197         return 1;
 198 }
 199
 200 #if defined(NID_aes_128_cfb128) && ! defined (NID_aes_128_cfb)
 201 #define NID_aes_128_cfb NID_aes_128_cfb128
 202 #endif
 203
 204 #if defined(NID_aes_128_ofb128) && ! defined (NID_aes_128_ofb)
 205 #define NID_aes_128_ofb NID_aes_128_ofb128
 206 #endif
 207
 208 #if defined(NID_aes_192_cfb128) && ! defined (NID_aes_192_cfb)
 209 #define NID_aes_192_cfb NID_aes_192_cfb128
 210 #endif
 211
 212 #if defined(NID_aes_192_ofb128) && ! defined (NID_aes_192_ofb)
 213 #define NID_aes_192_ofb NID_aes_192_ofb128
 214 #endif
 215
 216 #if defined(NID_aes_256_cfb128) && ! defined (NID_aes_256_cfb)
 217 #define NID_aes_256_cfb NID_aes_256_cfb128
 218 #endif
 219
 220 #if defined(NID_aes_256_ofb128) && ! defined (NID_aes_256_ofb)
 221 #define NID_aes_256_ofb NID_aes_256_ofb128
 222 #endif
 223
 224 /* List of supported ciphers. */
 225 static int aesni_cipher_nids[] = {
 226         NID_aes_128_ecb,
 227         NID_aes_128_cbc,
 228         NID_aes_128_cfb,
 229         NID_aes_128_ofb,
 230
 231         NID_aes_192_ecb,
 232         NID_aes_192_cbc,
 233         NID_aes_192_cfb,
 234         NID_aes_192_ofb,
 235
 236         NID_aes_256_ecb,
 237         NID_aes_256_cbc,
 238         NID_aes_256_cfb,
 239         NID_aes_256_ofb,
 240 };
 241 static int aesni_cipher_nids_num =
 242         (sizeof(aesni_cipher_nids)/sizeof(aesni_cipher_nids[0]));
 243
 244 typedef struct
 245 {
 246         AES_KEY ks;
 247         unsigned int _pad1[3];
 248 } AESNI_KEY;
 249
 250 static int
 251 aesni_init_key (EVP_CIPHER_CTX *ctx, const unsigned char *user_key,
 252                     const unsigned char *iv, int enc)
 253 {
 254         int ret;
 255         AES_KEY *key = AESNI_ALIGN(ctx->cipher_data);
 256
 257         if ((ctx->cipher->flags & EVP_CIPH_MODE) == EVP_CIPH_CFB_MODE
 258             || (ctx->cipher->flags & EVP_CIPH_MODE) == EVP_CIPH_OFB_MODE
 259             || enc)
 260                 ret=aesni_set_encrypt_key(user_key, ctx->key_len * 8, key);
 261         else
 262                 ret=aesni_set_decrypt_key(user_key, ctx->key_len * 8, key);
 263
 264         if(ret < 0) {
 265                 EVPerr(EVP_F_AES_INIT_KEY,EVP_R_AES_KEY_SETUP_FAILED);
 266                 return 0;
 267         }
 268
 269         return 1;
 270 }
 271
 272 static int aesni_cipher_ecb(EVP_CIPHER_CTX *ctx, unsigned char *out,
 273                  const unsigned char *in, size_t inl)
 274 {       AES_KEY *key = AESNI_ALIGN(ctx->cipher_data);
 275         aesni_ecb_encrypt(in, out, inl, key, ctx->encrypt);
 276         return 1;
 277 }
 278 static int aesni_cipher_cbc(EVP_CIPHER_CTX *ctx, unsigned char *out,
 279                  const unsigned char *in, size_t inl)
 280 {       AES_KEY *key = AESNI_ALIGN(ctx->cipher_data);
 281         aesni_cbc_encrypt(in, out, inl, key,
 282                               ctx->iv, ctx->encrypt);
 283         return 1;
 284 }
 285 static int aesni_cipher_cfb(EVP_CIPHER_CTX *ctx, unsigned char *out,
 286                  const unsigned char *in, size_t inl)
 287 {       AES_KEY *key = AESNI_ALIGN(ctx->cipher_data);
 288         CRYPTO_cfb128_encrypt(in, out, inl, key, ctx->iv,
 289                                 &ctx->num, ctx->encrypt,
 290                                 (block128_f)aesni_encrypt);
 291         return 1;
 292 }
 293 static int aesni_cipher_ofb(EVP_CIPHER_CTX *ctx, unsigned char *out,
 294                  const unsigned char *in, size_t inl)
 295 {       AES_KEY *key = AESNI_ALIGN(ctx->cipher_data);
 296         CRYPTO_ofb128_encrypt(in, out, inl, key, ctx->iv,
 297                                 &ctx->num, (block128_f)aesni_encrypt);
 298         return 1;
 299 }
 300
 301 #define AES_BLOCK_SIZE          16
 302
 303 #define EVP_CIPHER_block_size_ECB       AES_BLOCK_SIZE
 304 #define EVP_CIPHER_block_size_CBC       AES_BLOCK_SIZE
 305 #define EVP_CIPHER_block_size_OFB       1
 306 #define EVP_CIPHER_block_size_CFB       1
 307
 308 /* Declaring so many ciphers by hand would be a pain.
 309    Instead introduce a bit of preprocessor magic :-) */
 310 #define DECLARE_AES_EVP(ksize,lmode,umode)      \
 311 static const EVP_CIPHER aesni_##ksize##_##lmode = {     \
 312         NID_aes_##ksize##_##lmode,                      \
 313         EVP_CIPHER_block_size_##umode,                  \
 314         ksize / 8,                                      \
 315         AES_BLOCK_SIZE,                                 \
 316         0 | EVP_CIPH_##umode##_MODE,                    \
 317         aesni_init_key,                         \
 318         aesni_cipher_##lmode,                           \
 319         NULL,                                           \
 320         sizeof(AESNI_KEY),                              \
 321         EVP_CIPHER_set_asn1_iv,                         \
 322         EVP_CIPHER_get_asn1_iv,                         \
 323         NULL,                                           \
 324         NULL                                            \
 325 }
 326
 327 DECLARE_AES_EVP(128,ecb,ECB);
 328 DECLARE_AES_EVP(128,cbc,CBC);
 329 DECLARE_AES_EVP(128,cfb,CFB);
 330 DECLARE_AES_EVP(128,ofb,OFB);
 331
 332 DECLARE_AES_EVP(192,ecb,ECB);
 333 DECLARE_AES_EVP(192,cbc,CBC);
 334 DECLARE_AES_EVP(192,cfb,CFB);
 335 DECLARE_AES_EVP(192,ofb,OFB);
 336
 337 DECLARE_AES_EVP(256,ecb,ECB);
 338 DECLARE_AES_EVP(256,cbc,CBC);
 339 DECLARE_AES_EVP(256,cfb,CFB);
 340 DECLARE_AES_EVP(256,ofb,OFB);
 341
 342 static int
 343 aesni_ciphers (ENGINE *e, const EVP_CIPHER **cipher,
 344                       const int **nids, int nid)
 345 {
 346         /* No specific cipher => return a list of supported nids ... */
 347         if (!cipher) {
 348                 *nids = aesni_cipher_nids;
 349                 return aesni_cipher_nids_num;
 350         }
 351
 352         /* ... or the requested "cipher" otherwise */
 353         switch (nid) {
 354         case NID_aes_128_ecb:
 355                 *cipher = &aesni_128_ecb;
 356                 break;
 357         case NID_aes_128_cbc:
 358                 *cipher = &aesni_128_cbc;
 359                 break;
 360         case NID_aes_128_cfb:
 361                 *cipher = &aesni_128_cfb;
 362                 break;
 363         case NID_aes_128_ofb:
 364                 *cipher = &aesni_128_ofb;
 365                 break;
 366
 367         case NID_aes_192_ecb:
 368                 *cipher = &aesni_192_ecb;
 369                 break;
 370         case NID_aes_192_cbc:
 371                 *cipher = &aesni_192_cbc;
 372                 break;
 373         case NID_aes_192_cfb:
 374                 *cipher = &aesni_192_cfb;
 375                 break;
 376         case NID_aes_192_ofb:
 377                 *cipher = &aesni_192_ofb;
 378                 break;
 379
 380         case NID_aes_256_ecb:
 381                 *cipher = &aesni_256_ecb;
 382                 break;
 383         case NID_aes_256_cbc:
 384                 *cipher = &aesni_256_cbc;
 385                 break;
 386         case NID_aes_256_cfb:
 387                 *cipher = &aesni_256_cfb;
 388                 break;
 389         case NID_aes_256_ofb:
 390                 *cipher = &aesni_256_ofb;
 391                 break;
 392
 393         default:
 394                 /* Sorry, we don't support this NID */
 395                 *cipher = NULL;
 396                 return 0;
 397         }
 398
 399         return 1;
 400 }
 401
 402 #endif /* COMPILE_HW_AESNI */
 403 #endif /* !defined(OPENSSL_NO_HW) && !defined(OPENSSL_NO_HW_AESNI) && !defined(OPENSSL_NO_AES) */