1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _AES_IMPL_H 27 #define _AES_IMPL_H 28 29 /* 30 * Common definitions used by AES. 31 */ 32 33 #ifdef __cplusplus 34 extern "C" { 35 #endif 36 37 #include <sys/zfs_context.h> 38 #include <sys/crypto/common.h> 39 40 /* Similar to sysmacros.h IS_P2ALIGNED, but checks two pointers: */ 41 #define IS_P2ALIGNED2(v, w, a) \ 42 ((((uintptr_t)(v) | (uintptr_t)(w)) & ((uintptr_t)(a) - 1)) == 0) 43 44 #define AES_BLOCK_LEN 16 /* bytes */ 45 /* Round constant length, in number of 32-bit elements: */ 46 #define RC_LENGTH (5 * ((AES_BLOCK_LEN) / 4 - 2)) 47 48 #define AES_COPY_BLOCK(src, dst) \ 49 (dst)[0] = (src)[0]; \ 50 (dst)[1] = (src)[1]; \ 51 (dst)[2] = (src)[2]; \ 52 (dst)[3] = (src)[3]; \ 53 (dst)[4] = (src)[4]; \ 54 (dst)[5] = (src)[5]; \ 55 (dst)[6] = (src)[6]; \ 56 (dst)[7] = (src)[7]; \ 57 (dst)[8] = (src)[8]; \ 58 (dst)[9] = (src)[9]; \ 59 (dst)[10] = (src)[10]; \ 60 (dst)[11] = (src)[11]; \ 61 (dst)[12] = (src)[12]; \ 62 (dst)[13] = (src)[13]; \ 63 (dst)[14] = (src)[14]; \ 64 (dst)[15] = (src)[15] 65 66 #define AES_XOR_BLOCK(src, dst) \ 67 (dst)[0] ^= (src)[0]; \ 68 (dst)[1] ^= (src)[1]; \ 69 (dst)[2] ^= (src)[2]; \ 70 (dst)[3] ^= (src)[3]; \ 71 (dst)[4] ^= (src)[4]; \ 72 (dst)[5] ^= (src)[5]; \ 73 (dst)[6] ^= (src)[6]; \ 74 (dst)[7] ^= (src)[7]; \ 75 (dst)[8] ^= (src)[8]; \ 76 (dst)[9] ^= (src)[9]; \ 77 (dst)[10] ^= (src)[10]; \ 78 (dst)[11] ^= (src)[11]; \ 79 (dst)[12] ^= (src)[12]; \ 80 (dst)[13] ^= (src)[13]; \ 81 (dst)[14] ^= (src)[14]; \ 82 (dst)[15] ^= (src)[15] 83 84 /* AES key size definitions */ 85 #define AES_MINBITS 128 86 #define AES_MINBYTES ((AES_MINBITS) >> 3) 87 #define AES_MAXBITS 256 88 #define AES_MAXBYTES ((AES_MAXBITS) >> 3) 89 90 #define AES_MIN_KEY_BYTES ((AES_MINBITS) >> 3) 91 #define AES_MAX_KEY_BYTES ((AES_MAXBITS) >> 3) 92 #define AES_192_KEY_BYTES 24 93 #define AES_IV_LEN 16 94 95 /* AES key schedule may be implemented with 32- or 64-bit elements: */ 96 #define AES_32BIT_KS 32 97 #define AES_64BIT_KS 64 98 99 #define MAX_AES_NR 14 /* Maximum number of rounds */ 100 #define MAX_AES_NB 4 /* Number of columns comprising a state */ 101 102 typedef union { 103 #ifdef sun4u 104 uint64_t ks64[((MAX_AES_NR) + 1) * (MAX_AES_NB)]; 105 #endif 106 uint32_t ks32[((MAX_AES_NR) + 1) * (MAX_AES_NB)]; 107 } aes_ks_t; 108 109 typedef struct aes_impl_ops aes_impl_ops_t; 110 111 /* 112 * The absolute offset of the encr_ks (0) and the nr (504) fields are hard 113 * coded in aesni-gcm-x86_64, so please don't change (or adjust accordingly). 114 */ 115 typedef struct aes_key aes_key_t; 116 struct aes_key { 117 aes_ks_t encr_ks; /* encryption key schedule */ 118 aes_ks_t decr_ks; /* decryption key schedule */ 119 #ifdef __amd64 120 long double align128; /* Align fields above for Intel AES-NI */ 121 #endif /* __amd64 */ 122 const aes_impl_ops_t *ops; /* ops associated with this schedule */ 123 int nr; /* number of rounds (10, 12, or 14) */ 124 int type; /* key schedule size (32 or 64 bits) */ 125 }; 126 127 /* 128 * Core AES functions. 129 * ks and keysched are pointers to aes_key_t. 130 * They are declared void* as they are intended to be opaque types. 131 * Use function aes_alloc_keysched() to allocate memory for ks and keysched. 132 */ 133 extern void *aes_alloc_keysched(size_t *size, int kmflag); 134 extern void aes_init_keysched(const uint8_t *cipherKey, uint_t keyBits, 135 void *keysched); 136 extern int aes_encrypt_block(const void *ks, const uint8_t *pt, uint8_t *ct); 137 extern int aes_decrypt_block(const void *ks, const uint8_t *ct, uint8_t *pt); 138 139 /* 140 * AES mode functions. 141 * The first 2 functions operate on 16-byte AES blocks. 142 */ 143 extern void aes_copy_block(uint8_t *in, uint8_t *out); 144 extern void aes_xor_block(uint8_t *data, uint8_t *dst); 145 146 /* Note: ctx is a pointer to aes_ctx_t defined in modes.h */ 147 extern int aes_encrypt_contiguous_blocks(void *ctx, char *data, size_t length, 148 crypto_data_t *out); 149 extern int aes_decrypt_contiguous_blocks(void *ctx, char *data, size_t length, 150 crypto_data_t *out); 151 152 /* 153 * The following definitions and declarations are only used by AES FIPS POST 154 */ 155 #ifdef _AES_IMPL 156 157 typedef enum aes_mech_type { 158 AES_ECB_MECH_INFO_TYPE, /* SUN_CKM_AES_ECB */ 159 AES_CBC_MECH_INFO_TYPE, /* SUN_CKM_AES_CBC */ 160 AES_CBC_PAD_MECH_INFO_TYPE, /* SUN_CKM_AES_CBC_PAD */ 161 AES_CTR_MECH_INFO_TYPE, /* SUN_CKM_AES_CTR */ 162 AES_CCM_MECH_INFO_TYPE, /* SUN_CKM_AES_CCM */ 163 AES_GCM_MECH_INFO_TYPE, /* SUN_CKM_AES_GCM */ 164 AES_GMAC_MECH_INFO_TYPE /* SUN_CKM_AES_GMAC */ 165 } aes_mech_type_t; 166 167 #endif /* _AES_IMPL */ 168 169 /* 170 * Methods used to define AES implementation 171 * 172 * @aes_gen_f Key generation 173 * @aes_enc_f Function encrypts one block 174 * @aes_dec_f Function decrypts one block 175 * @aes_will_work_f Function tests whether method will function 176 */ 177 typedef void (*aes_generate_f)(aes_key_t *, const uint32_t *, int); 178 typedef void (*aes_encrypt_f)(const uint32_t[], int, 179 const uint32_t[4], uint32_t[4]); 180 typedef void (*aes_decrypt_f)(const uint32_t[], int, 181 const uint32_t[4], uint32_t[4]); 182 typedef boolean_t (*aes_will_work_f)(void); 183 184 #define AES_IMPL_NAME_MAX (16) 185 186 struct aes_impl_ops { 187 aes_generate_f generate; 188 aes_encrypt_f encrypt; 189 aes_decrypt_f decrypt; 190 aes_will_work_f is_supported; 191 boolean_t needs_byteswap; 192 char name[AES_IMPL_NAME_MAX]; 193 }; 194 195 extern const aes_impl_ops_t aes_generic_impl; 196 #if defined(__x86_64) 197 extern const aes_impl_ops_t aes_x86_64_impl; 198 199 /* These functions are used to execute amd64 instructions for AMD or Intel: */ 200 extern int rijndael_key_setup_enc_amd64(uint32_t rk[], 201 const uint32_t cipherKey[], int keyBits); 202 extern int rijndael_key_setup_dec_amd64(uint32_t rk[], 203 const uint32_t cipherKey[], int keyBits); 204 extern void aes_encrypt_amd64(const uint32_t rk[], int Nr, 205 const uint32_t pt[4], uint32_t ct[4]); 206 extern void aes_decrypt_amd64(const uint32_t rk[], int Nr, 207 const uint32_t ct[4], uint32_t pt[4]); 208 #endif 209 #if defined(__x86_64) && defined(HAVE_AES) 210 extern const aes_impl_ops_t aes_aesni_impl; 211 #endif 212 213 /* 214 * Initializes fastest implementation 215 */ 216 void aes_impl_init(void); 217 218 /* 219 * Returns optimal allowed AES implementation 220 */ 221 const struct aes_impl_ops *aes_impl_get_ops(void); 222 223 #ifdef __cplusplus 224 } 225 #endif 226 227 #endif /* _AES_IMPL_H */ 228