2 * Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (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
10 #ifndef OSSL_AES_PLATFORM_H
11 # define OSSL_AES_PLATFORM_H
13 # include "openssl/aes.h"
16 int vpaes_set_encrypt_key(const unsigned char *userKey, int bits,
18 int vpaes_set_decrypt_key(const unsigned char *userKey, int bits,
20 void vpaes_encrypt(const unsigned char *in, unsigned char *out,
22 void vpaes_decrypt(const unsigned char *in, unsigned char *out,
24 void vpaes_cbc_encrypt(const unsigned char *in,
27 const AES_KEY *key, unsigned char *ivec, int enc);
28 # endif /* VPAES_ASM */
31 void bsaes_cbc_encrypt(const unsigned char *in, unsigned char *out,
32 size_t length, const AES_KEY *key,
33 unsigned char ivec[16], int enc);
34 void bsaes_ctr32_encrypt_blocks(const unsigned char *in, unsigned char *out,
35 size_t len, const AES_KEY *key,
36 const unsigned char ivec[16]);
37 void bsaes_xts_encrypt(const unsigned char *inp, unsigned char *out,
38 size_t len, const AES_KEY *key1,
39 const AES_KEY *key2, const unsigned char iv[16]);
40 void bsaes_xts_decrypt(const unsigned char *inp, unsigned char *out,
41 size_t len, const AES_KEY *key1,
42 const AES_KEY *key2, const unsigned char iv[16]);
43 # endif /* BSAES_ASM */
46 void AES_ctr32_encrypt(const unsigned char *in, unsigned char *out,
47 size_t blocks, const AES_KEY *key,
48 const unsigned char ivec[AES_BLOCK_SIZE]);
49 # endif /* AES_CTR_ASM */
52 void AES_xts_encrypt(const unsigned char *inp, unsigned char *out, size_t len,
53 const AES_KEY *key1, const AES_KEY *key2,
54 const unsigned char iv[16]);
55 void AES_xts_decrypt(const unsigned char *inp, unsigned char *out, size_t len,
56 const AES_KEY *key1, const AES_KEY *key2,
57 const unsigned char iv[16]);
58 # endif /* AES_XTS_ASM */
60 # if defined(OPENSSL_CPUID_OBJ)
61 # if (defined(__powerpc__) || defined(__ppc__) || defined(_ARCH_PPC))
62 # include "ppc_arch.h"
64 # define VPAES_CAPABLE (OPENSSL_ppccap_P & PPC_ALTIVEC)
66 # define HWAES_CAPABLE (OPENSSL_ppccap_P & PPC_CRYPTO207)
67 # define HWAES_set_encrypt_key aes_p8_set_encrypt_key
68 # define HWAES_set_decrypt_key aes_p8_set_decrypt_key
69 # define HWAES_encrypt aes_p8_encrypt
70 # define HWAES_decrypt aes_p8_decrypt
71 # define HWAES_cbc_encrypt aes_p8_cbc_encrypt
72 # define HWAES_ctr32_encrypt_blocks aes_p8_ctr32_encrypt_blocks
73 # define HWAES_xts_encrypt aes_p8_xts_encrypt
74 # define HWAES_xts_decrypt aes_p8_xts_decrypt
77 # if (defined(__arm__) || defined(__arm) || defined(__aarch64__))
78 # include "arm_arch.h"
79 # if __ARM_MAX_ARCH__>=7
80 # if defined(BSAES_ASM)
81 # define BSAES_CAPABLE (OPENSSL_armcap_P & ARMV7_NEON)
83 # if defined(VPAES_ASM)
84 # define VPAES_CAPABLE (OPENSSL_armcap_P & ARMV7_NEON)
86 # define HWAES_CAPABLE (OPENSSL_armcap_P & ARMV8_AES)
87 # define HWAES_set_encrypt_key aes_v8_set_encrypt_key
88 # define HWAES_set_decrypt_key aes_v8_set_decrypt_key
89 # define HWAES_encrypt aes_v8_encrypt
90 # define HWAES_decrypt aes_v8_decrypt
91 # define HWAES_cbc_encrypt aes_v8_cbc_encrypt
92 # define HWAES_ecb_encrypt aes_v8_ecb_encrypt
93 # define HWAES_ctr32_encrypt_blocks aes_v8_ctr32_encrypt_blocks
94 # define AES_PMULL_CAPABLE ((OPENSSL_armcap_P & ARMV8_PMULL) && (OPENSSL_armcap_P & ARMV8_AES))
95 # define AES_GCM_ENC_BYTES 512
96 # define AES_GCM_DEC_BYTES 512
97 # if __ARM_MAX_ARCH__>=8
98 # define AES_gcm_encrypt armv8_aes_gcm_encrypt
99 # define AES_gcm_decrypt armv8_aes_gcm_decrypt
100 # define AES_GCM_ASM(gctx) ((gctx)->ctr==aes_v8_ctr32_encrypt_blocks && \
101 (gctx)->gcm.ghash==gcm_ghash_v8)
102 size_t aes_gcm_enc_128_kernel(const uint8_t * plaintext, uint64_t plaintext_length, uint8_t * ciphertext,
103 uint64_t *Xi, unsigned char ivec[16], const void *key);
104 size_t aes_gcm_enc_192_kernel(const uint8_t * plaintext, uint64_t plaintext_length, uint8_t * ciphertext,
105 uint64_t *Xi, unsigned char ivec[16], const void *key);
106 size_t aes_gcm_enc_256_kernel(const uint8_t * plaintext, uint64_t plaintext_length, uint8_t * ciphertext,
107 uint64_t *Xi, unsigned char ivec[16], const void *key);
108 size_t aes_gcm_dec_128_kernel(const uint8_t * ciphertext, uint64_t plaintext_length, uint8_t * plaintext,
109 uint64_t *Xi, unsigned char ivec[16], const void *key);
110 size_t aes_gcm_dec_192_kernel(const uint8_t * ciphertext, uint64_t plaintext_length, uint8_t * plaintext,
111 uint64_t *Xi, unsigned char ivec[16], const void *key);
112 size_t aes_gcm_dec_256_kernel(const uint8_t * ciphertext, uint64_t plaintext_length, uint8_t * plaintext,
113 uint64_t *Xi, unsigned char ivec[16], const void *key);
114 size_t armv8_aes_gcm_encrypt(const unsigned char *in, unsigned char *out, size_t len, const void *key,
115 unsigned char ivec[16], u64 *Xi);
116 size_t armv8_aes_gcm_decrypt(const unsigned char *in, unsigned char *out, size_t len, const void *key,
117 unsigned char ivec[16], u64 *Xi);
118 void gcm_ghash_v8(u64 Xi[2],const u128 Htable[16],const u8 *inp, size_t len);
122 # endif /* OPENSSL_CPUID_OBJ */
124 # if defined(AES_ASM) && !defined(I386_ONLY) && ( \
125 ((defined(__i386) || defined(__i386__) || \
126 defined(_M_IX86)) && defined(OPENSSL_IA32_SSE2))|| \
127 defined(__x86_64) || defined(__x86_64__) || \
128 defined(_M_AMD64) || defined(_M_X64) )
132 # define AESNI_CAPABLE (OPENSSL_ia32cap_P[1]&(1<<(57-32)))
134 # define VPAES_CAPABLE (OPENSSL_ia32cap_P[1]&(1<<(41-32)))
137 # define BSAES_CAPABLE (OPENSSL_ia32cap_P[1]&(1<<(41-32)))
140 # define AES_GCM_ENC_BYTES 32
141 # define AES_GCM_DEC_BYTES 16
143 int aesni_set_encrypt_key(const unsigned char *userKey, int bits,
145 int aesni_set_decrypt_key(const unsigned char *userKey, int bits,
148 void aesni_encrypt(const unsigned char *in, unsigned char *out,
150 void aesni_decrypt(const unsigned char *in, unsigned char *out,
153 void aesni_ecb_encrypt(const unsigned char *in,
155 size_t length, const AES_KEY *key, int enc);
156 void aesni_cbc_encrypt(const unsigned char *in,
159 const AES_KEY *key, unsigned char *ivec, int enc);
160 # ifndef OPENSSL_NO_OCB
161 void aesni_ocb_encrypt(const unsigned char *in, unsigned char *out,
162 size_t blocks, const void *key,
163 size_t start_block_num,
164 unsigned char offset_i[16],
165 const unsigned char L_[][16],
166 unsigned char checksum[16]);
167 void aesni_ocb_decrypt(const unsigned char *in, unsigned char *out,
168 size_t blocks, const void *key,
169 size_t start_block_num,
170 unsigned char offset_i[16],
171 const unsigned char L_[][16],
172 unsigned char checksum[16]);
173 # endif /* OPENSSL_NO_OCB */
175 void aesni_ctr32_encrypt_blocks(const unsigned char *in,
178 const void *key, const unsigned char *ivec);
180 void aesni_xts_encrypt(const unsigned char *in,
183 const AES_KEY *key1, const AES_KEY *key2,
184 const unsigned char iv[16]);
186 void aesni_xts_decrypt(const unsigned char *in,
189 const AES_KEY *key1, const AES_KEY *key2,
190 const unsigned char iv[16]);
192 void aesni_ccm64_encrypt_blocks(const unsigned char *in,
196 const unsigned char ivec[16],
197 unsigned char cmac[16]);
199 void aesni_ccm64_decrypt_blocks(const unsigned char *in,
203 const unsigned char ivec[16],
204 unsigned char cmac[16]);
206 # if defined(__x86_64) || defined(__x86_64__) || defined(_M_AMD64) || defined(_M_X64)
207 size_t aesni_gcm_encrypt(const unsigned char *in, unsigned char *out, size_t len,
208 const void *key, unsigned char ivec[16], u64 *Xi);
209 size_t aesni_gcm_decrypt(const unsigned char *in, unsigned char *out, size_t len,
210 const void *key, unsigned char ivec[16], u64 *Xi);
211 void gcm_ghash_avx(u64 Xi[2], const u128 Htable[16], const u8 *in, size_t len);
213 # define AES_gcm_encrypt aesni_gcm_encrypt
214 # define AES_gcm_decrypt aesni_gcm_decrypt
215 # define AES_GCM_ASM(ctx) (ctx->ctr == aesni_ctr32_encrypt_blocks && \
216 ctx->gcm.ghash == gcm_ghash_avx)
220 # elif defined(AES_ASM) && (defined(__sparc) || defined(__sparc__))
222 /* Fujitsu SPARC64 X support */
223 extern unsigned int OPENSSL_sparcv9cap_P[];
224 # include "sparc_arch.h"
226 # define SPARC_AES_CAPABLE (OPENSSL_sparcv9cap_P[1] & CFR_AES)
227 # define HWAES_CAPABLE (OPENSSL_sparcv9cap_P[0] & SPARCV9_FJAESX)
228 # define HWAES_set_encrypt_key aes_fx_set_encrypt_key
229 # define HWAES_set_decrypt_key aes_fx_set_decrypt_key
230 # define HWAES_encrypt aes_fx_encrypt
231 # define HWAES_decrypt aes_fx_decrypt
232 # define HWAES_cbc_encrypt aes_fx_cbc_encrypt
233 # define HWAES_ctr32_encrypt_blocks aes_fx_ctr32_encrypt_blocks
235 void aes_t4_set_encrypt_key(const unsigned char *key, int bits, AES_KEY *ks);
236 void aes_t4_set_decrypt_key(const unsigned char *key, int bits, AES_KEY *ks);
237 void aes_t4_encrypt(const unsigned char *in, unsigned char *out,
239 void aes_t4_decrypt(const unsigned char *in, unsigned char *out,
242 * Key-length specific subroutines were chosen for following reason.
243 * Each SPARC T4 core can execute up to 8 threads which share core's
244 * resources. Loading as much key material to registers allows to
245 * minimize references to shared memory interface, as well as amount
246 * of instructions in inner loops [much needed on T4]. But then having
247 * non-key-length specific routines would require conditional branches
248 * either in inner loops or on subroutines' entries. Former is hardly
249 * acceptable, while latter means code size increase to size occupied
250 * by multiple key-length specific subroutines, so why fight?
252 void aes128_t4_cbc_encrypt(const unsigned char *in, unsigned char *out,
253 size_t len, const AES_KEY *key,
254 unsigned char *ivec);
255 void aes128_t4_cbc_decrypt(const unsigned char *in, unsigned char *out,
256 size_t len, const AES_KEY *key,
257 unsigned char *ivec);
258 void aes192_t4_cbc_encrypt(const unsigned char *in, unsigned char *out,
259 size_t len, const AES_KEY *key,
260 unsigned char *ivec);
261 void aes192_t4_cbc_decrypt(const unsigned char *in, unsigned char *out,
262 size_t len, const AES_KEY *key,
263 unsigned char *ivec);
264 void aes256_t4_cbc_encrypt(const unsigned char *in, unsigned char *out,
265 size_t len, const AES_KEY *key,
266 unsigned char *ivec);
267 void aes256_t4_cbc_decrypt(const unsigned char *in, unsigned char *out,
268 size_t len, const AES_KEY *key,
269 unsigned char *ivec);
270 void aes128_t4_ctr32_encrypt(const unsigned char *in, unsigned char *out,
271 size_t blocks, const AES_KEY *key,
272 unsigned char *ivec);
273 void aes192_t4_ctr32_encrypt(const unsigned char *in, unsigned char *out,
274 size_t blocks, const AES_KEY *key,
275 unsigned char *ivec);
276 void aes256_t4_ctr32_encrypt(const unsigned char *in, unsigned char *out,
277 size_t blocks, const AES_KEY *key,
278 unsigned char *ivec);
279 void aes128_t4_xts_encrypt(const unsigned char *in, unsigned char *out,
280 size_t blocks, const AES_KEY *key1,
281 const AES_KEY *key2, const unsigned char *ivec);
282 void aes128_t4_xts_decrypt(const unsigned char *in, unsigned char *out,
283 size_t blocks, const AES_KEY *key1,
284 const AES_KEY *key2, const unsigned char *ivec);
285 void aes256_t4_xts_encrypt(const unsigned char *in, unsigned char *out,
286 size_t blocks, const AES_KEY *key1,
287 const AES_KEY *key2, const unsigned char *ivec);
288 void aes256_t4_xts_decrypt(const unsigned char *in, unsigned char *out,
289 size_t blocks, const AES_KEY *key1,
290 const AES_KEY *key2, const unsigned char *ivec);
292 # elif defined(OPENSSL_CPUID_OBJ) && defined(__s390__)
293 /* IBM S390X support */
294 # include "s390x_arch.h"
297 /* Convert key size to function code: [16,24,32] -> [18,19,20]. */
298 # define S390X_AES_FC(keylen) (S390X_AES_128 + ((((keylen) << 3) - 128) >> 6))
300 /* Most modes of operation need km for partial block processing. */
301 # define S390X_aes_128_CAPABLE (OPENSSL_s390xcap_P.km[0] & \
302 S390X_CAPBIT(S390X_AES_128))
303 # define S390X_aes_192_CAPABLE (OPENSSL_s390xcap_P.km[0] & \
304 S390X_CAPBIT(S390X_AES_192))
305 # define S390X_aes_256_CAPABLE (OPENSSL_s390xcap_P.km[0] & \
306 S390X_CAPBIT(S390X_AES_256))
308 # define S390X_aes_128_cbc_CAPABLE 1 /* checked by callee */
309 # define S390X_aes_192_cbc_CAPABLE 1
310 # define S390X_aes_256_cbc_CAPABLE 1
312 # define S390X_aes_128_ecb_CAPABLE S390X_aes_128_CAPABLE
313 # define S390X_aes_192_ecb_CAPABLE S390X_aes_192_CAPABLE
314 # define S390X_aes_256_ecb_CAPABLE S390X_aes_256_CAPABLE
316 # define S390X_aes_128_ofb_CAPABLE (S390X_aes_128_CAPABLE && \
317 (OPENSSL_s390xcap_P.kmo[0] & \
318 S390X_CAPBIT(S390X_AES_128)))
319 # define S390X_aes_192_ofb_CAPABLE (S390X_aes_192_CAPABLE && \
320 (OPENSSL_s390xcap_P.kmo[0] & \
321 S390X_CAPBIT(S390X_AES_192)))
322 # define S390X_aes_256_ofb_CAPABLE (S390X_aes_256_CAPABLE && \
323 (OPENSSL_s390xcap_P.kmo[0] & \
324 S390X_CAPBIT(S390X_AES_256)))
326 # define S390X_aes_128_cfb_CAPABLE (S390X_aes_128_CAPABLE && \
327 (OPENSSL_s390xcap_P.kmf[0] & \
328 S390X_CAPBIT(S390X_AES_128)))
329 # define S390X_aes_192_cfb_CAPABLE (S390X_aes_192_CAPABLE && \
330 (OPENSSL_s390xcap_P.kmf[0] & \
331 S390X_CAPBIT(S390X_AES_192)))
332 # define S390X_aes_256_cfb_CAPABLE (S390X_aes_256_CAPABLE && \
333 (OPENSSL_s390xcap_P.kmf[0] & \
334 S390X_CAPBIT(S390X_AES_256)))
335 # define S390X_aes_128_cfb8_CAPABLE (OPENSSL_s390xcap_P.kmf[0] & \
336 S390X_CAPBIT(S390X_AES_128))
337 # define S390X_aes_192_cfb8_CAPABLE (OPENSSL_s390xcap_P.kmf[0] & \
338 S390X_CAPBIT(S390X_AES_192))
339 # define S390X_aes_256_cfb8_CAPABLE (OPENSSL_s390xcap_P.kmf[0] & \
340 S390X_CAPBIT(S390X_AES_256))
341 # define S390X_aes_128_cfb1_CAPABLE 0
342 # define S390X_aes_192_cfb1_CAPABLE 0
343 # define S390X_aes_256_cfb1_CAPABLE 0
345 # define S390X_aes_128_ctr_CAPABLE 1 /* checked by callee */
346 # define S390X_aes_192_ctr_CAPABLE 1
347 # define S390X_aes_256_ctr_CAPABLE 1
349 # define S390X_aes_128_xts_CAPABLE 1 /* checked by callee */
350 # define S390X_aes_256_xts_CAPABLE 1
352 # define S390X_aes_128_gcm_CAPABLE (S390X_aes_128_CAPABLE && \
353 (OPENSSL_s390xcap_P.kma[0] & \
354 S390X_CAPBIT(S390X_AES_128)))
355 # define S390X_aes_192_gcm_CAPABLE (S390X_aes_192_CAPABLE && \
356 (OPENSSL_s390xcap_P.kma[0] & \
357 S390X_CAPBIT(S390X_AES_192)))
358 # define S390X_aes_256_gcm_CAPABLE (S390X_aes_256_CAPABLE && \
359 (OPENSSL_s390xcap_P.kma[0] & \
360 S390X_CAPBIT(S390X_AES_256)))
362 # define S390X_aes_128_ccm_CAPABLE (S390X_aes_128_CAPABLE && \
363 (OPENSSL_s390xcap_P.kmac[0] & \
364 S390X_CAPBIT(S390X_AES_128)))
365 # define S390X_aes_192_ccm_CAPABLE (S390X_aes_192_CAPABLE && \
366 (OPENSSL_s390xcap_P.kmac[0] & \
367 S390X_CAPBIT(S390X_AES_192)))
368 # define S390X_aes_256_ccm_CAPABLE (S390X_aes_256_CAPABLE && \
369 (OPENSSL_s390xcap_P.kmac[0] & \
370 S390X_CAPBIT(S390X_AES_256)))
371 # define S390X_CCM_AAD_FLAG 0x40
373 # ifndef OPENSSL_NO_OCB
374 # define S390X_aes_128_ocb_CAPABLE 0
375 # define S390X_aes_192_ocb_CAPABLE 0
376 # define S390X_aes_256_ocb_CAPABLE 0
377 # endif /* OPENSSL_NO_OCB */
379 # ifndef OPENSSL_NO_SIV
380 # define S390X_aes_128_siv_CAPABLE 0
381 # define S390X_aes_192_siv_CAPABLE 0
382 # define S390X_aes_256_siv_CAPABLE 0
383 # endif /* OPENSSL_NO_SIV */
385 /* Convert key size to function code: [16,24,32] -> [18,19,20]. */
386 # define S390X_AES_FC(keylen) (S390X_AES_128 + ((((keylen) << 3) - 128) >> 6))
389 # if defined(HWAES_CAPABLE)
390 int HWAES_set_encrypt_key(const unsigned char *userKey, const int bits,
392 int HWAES_set_decrypt_key(const unsigned char *userKey, const int bits,
394 void HWAES_encrypt(const unsigned char *in, unsigned char *out,
396 void HWAES_decrypt(const unsigned char *in, unsigned char *out,
398 void HWAES_cbc_encrypt(const unsigned char *in, unsigned char *out,
399 size_t length, const AES_KEY *key,
400 unsigned char *ivec, const int enc);
401 void HWAES_ecb_encrypt(const unsigned char *in, unsigned char *out,
402 size_t length, const AES_KEY *key,
404 void HWAES_ctr32_encrypt_blocks(const unsigned char *in, unsigned char *out,
405 size_t len, const void *key,
406 const unsigned char ivec[16]);
407 void HWAES_xts_encrypt(const unsigned char *inp, unsigned char *out,
408 size_t len, const AES_KEY *key1,
409 const AES_KEY *key2, const unsigned char iv[16]);
410 void HWAES_xts_decrypt(const unsigned char *inp, unsigned char *out,
411 size_t len, const AES_KEY *key1,
412 const AES_KEY *key2, const unsigned char iv[16]);
413 # ifndef OPENSSL_NO_OCB
414 # ifdef HWAES_ocb_encrypt
415 void HWAES_ocb_encrypt(const unsigned char *in, unsigned char *out,
416 size_t blocks, const void *key,
417 size_t start_block_num,
418 unsigned char offset_i[16],
419 const unsigned char L_[][16],
420 unsigned char checksum[16]);
422 # define HWAES_ocb_encrypt ((ocb128_f)NULL)
424 # ifdef HWAES_ocb_decrypt
425 void HWAES_ocb_decrypt(const unsigned char *in, unsigned char *out,
426 size_t blocks, const void *key,
427 size_t start_block_num,
428 unsigned char offset_i[16],
429 const unsigned char L_[][16],
430 unsigned char checksum[16]);
432 # define HWAES_ocb_decrypt ((ocb128_f)NULL)
434 # endif /* OPENSSL_NO_OCB */
436 # endif /* HWAES_CAPABLE */
438 #endif /* OSSL_AES_PLATFORM_H */