blob: e1e0a15a37f610ee8922cb8a7abbfff74a1303a9 [file] [log] [blame]
Jerry Yu49231312023-01-10 16:57:21 +08001/*
Dave Rodgmanf918d422023-03-17 17:52:23 +00002 * Armv8-A Cryptographic Extension support functions for Aarch64
Jerry Yu49231312023-01-10 16:57:21 +08003 *
4 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Jerry Yu49231312023-01-10 16:57:21 +08006 */
7
Dave Rodgman27e3c872023-10-08 10:29:26 +01008#if defined(__clang__) && (__clang_major__ >= 4)
9
Dave Rodgman9fd1b522023-10-10 15:23:44 +010010/* Ideally, we would simply use MBEDTLS_ARCH_IS_ARMV8_A in the following #if,
Dave Rodgman27e3c872023-10-08 10:29:26 +010011 * but that is defined by build_info.h, and we need this block to happen first. */
12#if defined(__ARM_ARCH)
13#if __ARM_ARCH >= 8
Dave Rodgman9fd1b522023-10-10 15:23:44 +010014#define MBEDTLS_AESCE_ARCH_IS_ARMV8_A
Dave Rodgman27e3c872023-10-08 10:29:26 +010015#endif
16#endif
17
Dave Rodgman9fd1b522023-10-10 15:23:44 +010018#if defined(MBEDTLS_AESCE_ARCH_IS_ARMV8_A) && !defined(__ARM_FEATURE_CRYPTO)
Jerry Yu48b999c2023-03-03 15:51:07 +080019/* TODO: Re-consider above after https://reviews.llvm.org/D131064 merged.
20 *
21 * The intrinsic declaration are guarded by predefined ACLE macros in clang:
22 * these are normally only enabled by the -march option on the command line.
23 * By defining the macros ourselves we gain access to those declarations without
24 * requiring -march on the command line.
25 *
26 * `arm_neon.h` could be included by any header file, so we put these defines
27 * at the top of this file, before any includes.
28 */
29#define __ARM_FEATURE_CRYPTO 1
Jerry Yuae129c32023-03-03 15:55:56 +080030/* See: https://arm-software.github.io/acle/main/acle.html#cryptographic-extensions
31 *
Jerry Yu490bf082023-03-06 15:21:44 +080032 * `__ARM_FEATURE_CRYPTO` is deprecated, but we need to continue to specify it
33 * for older compilers.
Jerry Yuae129c32023-03-03 15:55:56 +080034 */
35#define __ARM_FEATURE_AES 1
Dave Rodgmandb6ab242023-03-14 16:03:57 +000036#define MBEDTLS_ENABLE_ARM_CRYPTO_EXTENSIONS_COMPILER_FLAG
Jerry Yu490bf082023-03-06 15:21:44 +080037#endif
Jerry Yu48b999c2023-03-03 15:51:07 +080038
Dave Rodgman27e3c872023-10-08 10:29:26 +010039#endif /* defined(__clang__) && (__clang_major__ >= 4) */
40
Jerry Yu49231312023-01-10 16:57:21 +080041#include <string.h>
42#include "common.h"
43
44#if defined(MBEDTLS_AESCE_C)
45
46#include "aesce.h"
47
Dave Rodgman9fd1b522023-10-10 15:23:44 +010048#if defined(MBEDTLS_ARCH_IS_ARMV8_A) && defined(__ARM_NEON)
Jerry Yu49231312023-01-10 16:57:21 +080049
Jerry Yu61c4cfa2023-04-26 11:06:51 +080050/* Compiler version checks. */
Jerry Yudb368de2023-04-26 16:55:37 +080051#if defined(__clang__)
Dave Rodgman48b965d2023-10-09 12:19:44 +010052# if defined(MBEDTLS_ARCH_IS_ARM32) && (__clang_major__ < 11)
Dave Rodgmanb34fe8b2023-10-10 09:52:46 +010053# error "Minimum version of Clang for MBEDTLS_AESCE_C on 32-bit Arm or Thumb is 11.0."
Dave Rodgman48b965d2023-10-09 12:19:44 +010054# elif defined(MBEDTLS_ARCH_IS_ARM64) && (__clang_major__ < 4)
55# error "Minimum version of Clang for MBEDTLS_AESCE_C on aarch64 is 4.0."
Jerry Yudb368de2023-04-26 16:55:37 +080056# endif
57#elif defined(__GNUC__)
58# if __GNUC__ < 6
59# error "Minimum version of GCC for MBEDTLS_AESCE_C is 6.0."
60# endif
61#elif defined(_MSC_VER)
Jerry Yu61c4cfa2023-04-26 11:06:51 +080062/* TODO: We haven't verified MSVC from 1920 to 1928. If someone verified that,
63 * please update this and document of `MBEDTLS_AESCE_C` in
64 * `mbedtls_config.h`. */
Jerry Yudb368de2023-04-26 16:55:37 +080065# if _MSC_VER < 1929
66# error "Minimum version of MSVC for MBEDTLS_AESCE_C is 2019 version 16.11.2."
67# endif
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +010068#elif defined(__ARMCC_VERSION)
69# if defined(MBEDTLS_ARCH_IS_ARM32) && (__ARMCC_VERSION < 6200002)
70/* TODO: We haven't verified armclang for 32-bit Arm/Thumb prior to 6.20.
71 * If someone verified that, please update this and document of
72 * `MBEDTLS_AESCE_C` in `mbedtls_config.h`. */
73# error "Minimum version of armclang for MBEDTLS_AESCE_C on 32-bit Arm is 6.20."
74# elif defined(MBEDTLS_ARCH_IS_ARM64) && (__ARMCC_VERSION < 6060000)
75# error "Minimum version of armclang for MBEDTLS_AESCE_C on aarch64 is 6.6."
76# endif
Jerry Yu61c4cfa2023-04-26 11:06:51 +080077#endif
78
Jerry Yu6b00f5a2023-05-04 16:30:21 +080079#ifdef __ARM_NEON
Jerry Yu08933d32023-04-27 18:28:00 +080080#include <arm_neon.h>
Jerry Yu6b00f5a2023-05-04 16:30:21 +080081#else
82#error "Target does not support NEON instructions"
83#endif
Jerry Yu08933d32023-04-27 18:28:00 +080084
Jerry Yu580e06f2023-04-28 17:42:40 +080085#if !(defined(__ARM_FEATURE_CRYPTO) || defined(__ARM_FEATURE_AES)) || \
86 defined(MBEDTLS_ENABLE_ARM_CRYPTO_EXTENSIONS_COMPILER_FLAG)
Jerry Yub1d06bb2023-05-05 14:05:07 +080087# if defined(__ARMCOMPILER_VERSION)
88# if __ARMCOMPILER_VERSION <= 6090000
89# error "Must use minimum -march=armv8-a+crypto for MBEDTLS_AESCE_C"
90# else
Jerry Yu893be8d2023-07-13 17:32:11 +080091# pragma clang attribute push (__attribute__((target("aes"))), apply_to=function)
Jerry Yub1d06bb2023-05-05 14:05:07 +080092# define MBEDTLS_POP_TARGET_PRAGMA
93# endif
94# elif defined(__clang__)
Jerry Yu893be8d2023-07-13 17:32:11 +080095# pragma clang attribute push (__attribute__((target("aes"))), apply_to=function)
Jerry Yuec9be842023-03-14 10:42:47 +080096# define MBEDTLS_POP_TARGET_PRAGMA
97# elif defined(__GNUC__)
Jerry Yuec9be842023-03-14 10:42:47 +080098# pragma GCC push_options
Beniamin Sandu471a9752023-06-25 20:16:16 +030099# pragma GCC target ("+crypto")
Jerry Yuec9be842023-03-14 10:42:47 +0800100# define MBEDTLS_POP_TARGET_PRAGMA
Jerry Yu07d28d82023-03-20 18:12:36 +0800101# elif defined(_MSC_VER)
Jerry Yu61c4cfa2023-04-26 11:06:51 +0800102# error "Required feature(__ARM_FEATURE_AES) is not enabled."
Jerry Yu49231312023-01-10 16:57:21 +0800103# endif
Jerry Yu580e06f2023-04-28 17:42:40 +0800104#endif /* !(__ARM_FEATURE_CRYPTO || __ARM_FEATURE_AES) ||
105 MBEDTLS_ENABLE_ARM_CRYPTO_EXTENSIONS_COMPILER_FLAG */
Jerry Yu49231312023-01-10 16:57:21 +0800106
Dave Rodgman45661322023-08-04 12:31:58 +0100107#if defined(__linux__) && !defined(MBEDTLS_AES_USE_HARDWARE_ONLY)
108
Jerry Yub95c7762023-01-10 16:59:51 +0800109#include <sys/auxv.h>
Dave Rodgman5e419372023-10-23 15:30:20 +0100110#if !defined(HWCAP_NEON)
111#define HWCAP_NEON (1 << 12)
112#endif
113#if !defined(HWCAP2_AES)
114#define HWCAP2_AES (1 << 0)
115#endif
116#if !defined(HWCAP_AES)
117#define HWCAP_AES (1 << 3)
118#endif
119#if !defined(HWCAP_ASIMD)
120#define HWCAP_ASIMD (1 << 1)
121#endif
Dave Rodgman45661322023-08-04 12:31:58 +0100122
Dave Rodgmanb30adce2023-08-04 12:52:51 +0100123signed char mbedtls_aesce_has_support_result = -1;
Jerry Yub95c7762023-01-10 16:59:51 +0800124
Jerry Yu36606232023-04-19 10:44:29 +0800125#if !defined(MBEDTLS_AES_USE_HARDWARE_ONLY)
Jerry Yub95c7762023-01-10 16:59:51 +0800126/*
127 * AES instruction support detection routine
128 */
Dave Rodgman45661322023-08-04 12:31:58 +0100129int mbedtls_aesce_has_support_impl(void)
Jerry Yub95c7762023-01-10 16:59:51 +0800130{
Dave Rodgman45661322023-08-04 12:31:58 +0100131 /* To avoid many calls to getauxval, cache the result. This is
132 * thread-safe, because we store the result in a char so cannot
133 * be vulnerable to non-atomic updates.
134 * It is possible that we could end up setting result more than
135 * once, but that is harmless.
136 */
Dave Rodgmanb30adce2023-08-04 12:52:51 +0100137 if (mbedtls_aesce_has_support_result == -1) {
Dave Rodgman851cf5a2023-10-08 12:26:41 +0100138#if defined(MBEDTLS_ARCH_IS_ARM32)
139 unsigned long auxval = getauxval(AT_HWCAP);
140 unsigned long auxval2 = getauxval(AT_HWCAP2);
141 if (((auxval & HWCAP_NEON) == HWCAP_NEON) &&
142 ((auxval2 & HWCAP2_AES) == HWCAP2_AES)) {
143 mbedtls_aesce_has_support_result = 1;
144 } else {
145 mbedtls_aesce_has_support_result = 0;
146 }
147#else
Dave Rodgman45661322023-08-04 12:31:58 +0100148 unsigned long auxval = getauxval(AT_HWCAP);
149 if ((auxval & (HWCAP_ASIMD | HWCAP_AES)) ==
150 (HWCAP_ASIMD | HWCAP_AES)) {
151 mbedtls_aesce_has_support_result = 1;
152 } else {
153 mbedtls_aesce_has_support_result = 0;
154 }
Dave Rodgman851cf5a2023-10-08 12:26:41 +0100155#endif
Dave Rodgman45661322023-08-04 12:31:58 +0100156 }
157 return mbedtls_aesce_has_support_result;
Jerry Yub95c7762023-01-10 16:59:51 +0800158}
Jerry Yu0d4f4e52023-03-31 14:32:47 +0800159#endif
Jerry Yub95c7762023-01-10 16:59:51 +0800160
Dave Rodgman45661322023-08-04 12:31:58 +0100161#endif /* defined(__linux__) && !defined(MBEDTLS_AES_USE_HARDWARE_ONLY) */
162
Dave Rodgman48fd2ab2023-06-16 09:36:50 +0100163/* Single round of AESCE encryption */
164#define AESCE_ENCRYPT_ROUND \
165 block = vaeseq_u8(block, vld1q_u8(keys)); \
166 block = vaesmcq_u8(block); \
167 keys += 16
168/* Two rounds of AESCE encryption */
169#define AESCE_ENCRYPT_ROUND_X2 AESCE_ENCRYPT_ROUND; AESCE_ENCRYPT_ROUND
170
Dave Rodgman9bb7e6f2023-06-16 09:41:21 +0100171MBEDTLS_OPTIMIZE_FOR_PERFORMANCE
Jerry Yu2bb3d812023-01-10 17:38:26 +0800172static uint8x16_t aesce_encrypt_block(uint8x16_t block,
173 unsigned char *keys,
174 int rounds)
175{
Dave Rodgman73b0c0b2023-06-16 14:48:14 +0100176 /* 10, 12 or 14 rounds. Unroll loop. */
Dave Rodgman96fdfb82023-06-15 16:21:31 +0100177 if (rounds == 10) {
178 goto rounds_10;
Jerry Yu2bb3d812023-01-10 17:38:26 +0800179 }
Dave Rodgman96fdfb82023-06-15 16:21:31 +0100180 if (rounds == 12) {
181 goto rounds_12;
182 }
Dave Rodgman48fd2ab2023-06-16 09:36:50 +0100183 AESCE_ENCRYPT_ROUND_X2;
Dave Rodgman96fdfb82023-06-15 16:21:31 +0100184rounds_12:
Dave Rodgman48fd2ab2023-06-16 09:36:50 +0100185 AESCE_ENCRYPT_ROUND_X2;
Dave Rodgman96fdfb82023-06-15 16:21:31 +0100186rounds_10:
Dave Rodgman48fd2ab2023-06-16 09:36:50 +0100187 AESCE_ENCRYPT_ROUND_X2;
188 AESCE_ENCRYPT_ROUND_X2;
189 AESCE_ENCRYPT_ROUND_X2;
190 AESCE_ENCRYPT_ROUND_X2;
191 AESCE_ENCRYPT_ROUND;
Jerry Yu2bb3d812023-01-10 17:38:26 +0800192
Jerry Yuc8bcdc82023-02-21 14:49:02 +0800193 /* AES AddRoundKey for the previous round.
194 * SubBytes, ShiftRows for the final round. */
Dave Rodgman96fdfb82023-06-15 16:21:31 +0100195 block = vaeseq_u8(block, vld1q_u8(keys));
196 keys += 16;
Jerry Yu2bb3d812023-01-10 17:38:26 +0800197
Jerry Yuc8bcdc82023-02-21 14:49:02 +0800198 /* Final round: no MixColumns */
Jerry Yu3304c202023-02-22 14:37:11 +0800199
200 /* Final AddRoundKey */
Dave Rodgman96fdfb82023-06-15 16:21:31 +0100201 block = veorq_u8(block, vld1q_u8(keys));
Jerry Yu2bb3d812023-01-10 17:38:26 +0800202
203 return block;
204}
205
Dave Rodgman48fd2ab2023-06-16 09:36:50 +0100206/* Single round of AESCE decryption
207 *
208 * AES AddRoundKey, SubBytes, ShiftRows
209 *
210 * block = vaesdq_u8(block, vld1q_u8(keys));
211 *
212 * AES inverse MixColumns for the next round.
213 *
214 * This means that we switch the order of the inverse AddRoundKey and
215 * inverse MixColumns operations. We have to do this as AddRoundKey is
216 * done in an atomic instruction together with the inverses of SubBytes
217 * and ShiftRows.
218 *
219 * It works because MixColumns is a linear operation over GF(2^8) and
220 * AddRoundKey is an exclusive or, which is equivalent to addition over
221 * GF(2^8). (The inverse of MixColumns needs to be applied to the
222 * affected round keys separately which has been done when the
223 * decryption round keys were calculated.)
224 *
225 * block = vaesimcq_u8(block);
226 */
227#define AESCE_DECRYPT_ROUND \
228 block = vaesdq_u8(block, vld1q_u8(keys)); \
229 block = vaesimcq_u8(block); \
230 keys += 16
231/* Two rounds of AESCE decryption */
232#define AESCE_DECRYPT_ROUND_X2 AESCE_DECRYPT_ROUND; AESCE_DECRYPT_ROUND
233
Yanray Wangb67b4742023-10-31 17:10:32 +0800234#if !defined(MBEDTLS_BLOCK_CIPHER_NO_DECRYPT)
Jerry Yu2bb3d812023-01-10 17:38:26 +0800235static uint8x16_t aesce_decrypt_block(uint8x16_t block,
236 unsigned char *keys,
237 int rounds)
238{
Dave Rodgman73b0c0b2023-06-16 14:48:14 +0100239 /* 10, 12 or 14 rounds. Unroll loop. */
Dave Rodgman1c4451d2023-06-15 16:28:00 +0100240 if (rounds == 10) {
241 goto rounds_10;
Jerry Yu2bb3d812023-01-10 17:38:26 +0800242 }
Dave Rodgman1c4451d2023-06-15 16:28:00 +0100243 if (rounds == 12) {
244 goto rounds_12;
245 }
Dave Rodgman48fd2ab2023-06-16 09:36:50 +0100246 AESCE_DECRYPT_ROUND_X2;
Dave Rodgman1c4451d2023-06-15 16:28:00 +0100247rounds_12:
Dave Rodgman48fd2ab2023-06-16 09:36:50 +0100248 AESCE_DECRYPT_ROUND_X2;
Dave Rodgman1c4451d2023-06-15 16:28:00 +0100249rounds_10:
Dave Rodgman48fd2ab2023-06-16 09:36:50 +0100250 AESCE_DECRYPT_ROUND_X2;
251 AESCE_DECRYPT_ROUND_X2;
252 AESCE_DECRYPT_ROUND_X2;
253 AESCE_DECRYPT_ROUND_X2;
254 AESCE_DECRYPT_ROUND;
Jerry Yu2bb3d812023-01-10 17:38:26 +0800255
Jerry Yuc8bcdc82023-02-21 14:49:02 +0800256 /* The inverses of AES AddRoundKey, SubBytes, ShiftRows finishing up the
257 * last full round. */
Dave Rodgman1c4451d2023-06-15 16:28:00 +0100258 block = vaesdq_u8(block, vld1q_u8(keys));
259 keys += 16;
Jerry Yu2bb3d812023-01-10 17:38:26 +0800260
Jerry Yuc8bcdc82023-02-21 14:49:02 +0800261 /* Inverse AddRoundKey for inverting the initial round key addition. */
Dave Rodgman1c4451d2023-06-15 16:28:00 +0100262 block = veorq_u8(block, vld1q_u8(keys));
Jerry Yu2bb3d812023-01-10 17:38:26 +0800263
264 return block;
265}
Yanray Wang590c9b72023-08-28 15:40:23 +0800266#endif
Jerry Yu2bb3d812023-01-10 17:38:26 +0800267
268/*
269 * AES-ECB block en(de)cryption
270 */
271int mbedtls_aesce_crypt_ecb(mbedtls_aes_context *ctx,
272 int mode,
273 const unsigned char input[16],
274 unsigned char output[16])
275{
276 uint8x16_t block = vld1q_u8(&input[0]);
277 unsigned char *keys = (unsigned char *) (ctx->buf + ctx->rk_offset);
278
Yanray Wang0d76b6e2023-11-02 11:54:39 +0800279#if !defined(MBEDTLS_BLOCK_CIPHER_NO_DECRYPT)
Yanray Wang111159b2023-11-10 13:41:12 +0800280 if (mode == MBEDTLS_AES_DECRYPT) {
Jerry Yu2bb3d812023-01-10 17:38:26 +0800281 block = aesce_decrypt_block(block, keys, ctx->nr);
Yanray Wang111159b2023-11-10 13:41:12 +0800282 } else
Yanray Wangc4347912023-11-14 10:10:49 +0800283#else
284 (void) mode;
Yanray Wang0d76b6e2023-11-02 11:54:39 +0800285#endif
Yanray Wang111159b2023-11-10 13:41:12 +0800286 {
287 block = aesce_encrypt_block(block, keys, ctx->nr);
Jerry Yu2bb3d812023-01-10 17:38:26 +0800288 }
289 vst1q_u8(&output[0], block);
290
291 return 0;
292}
293
Jerry Yue096da12023-01-10 17:07:01 +0800294/*
295 * Compute decryption round keys from encryption round keys
296 */
Yanray Wangb67b4742023-10-31 17:10:32 +0800297#if !defined(MBEDTLS_BLOCK_CIPHER_NO_DECRYPT)
Jerry Yue096da12023-01-10 17:07:01 +0800298void mbedtls_aesce_inverse_key(unsigned char *invkey,
299 const unsigned char *fwdkey,
300 int nr)
301{
302 int i, j;
303 j = nr;
304 vst1q_u8(invkey, vld1q_u8(fwdkey + j * 16));
305 for (i = 1, j--; j > 0; i++, j--) {
306 vst1q_u8(invkey + i * 16,
307 vaesimcq_u8(vld1q_u8(fwdkey + j * 16)));
308 }
309 vst1q_u8(invkey + i * 16, vld1q_u8(fwdkey + j * 16));
310
311}
Yanray Wang590c9b72023-08-28 15:40:23 +0800312#endif
Jerry Yue096da12023-01-10 17:07:01 +0800313
Jerry Yuc8bcdc82023-02-21 14:49:02 +0800314static inline uint32_t aes_rot_word(uint32_t word)
Jerry Yu3f2fb712023-01-10 17:05:42 +0800315{
316 return (word << (32 - 8)) | (word >> 8);
317}
318
Jerry Yuc8bcdc82023-02-21 14:49:02 +0800319static inline uint32_t aes_sub_word(uint32_t in)
Jerry Yu3f2fb712023-01-10 17:05:42 +0800320{
Jerry Yuc8bcdc82023-02-21 14:49:02 +0800321 uint8x16_t v = vreinterpretq_u8_u32(vdupq_n_u32(in));
Jerry Yu3f2fb712023-01-10 17:05:42 +0800322 uint8x16_t zero = vdupq_n_u8(0);
Jerry Yuc8bcdc82023-02-21 14:49:02 +0800323
324 /* vaeseq_u8 does both SubBytes and ShiftRows. Taking the first row yields
325 * the correct result as ShiftRows doesn't change the first row. */
326 v = vaeseq_u8(zero, v);
327 return vgetq_lane_u32(vreinterpretq_u32_u8(v), 0);
Jerry Yu3f2fb712023-01-10 17:05:42 +0800328}
329
330/*
Jerry Yubaae4012023-02-21 15:26:13 +0800331 * Key expansion function
Jerry Yu3f2fb712023-01-10 17:05:42 +0800332 */
Jerry Yubaae4012023-02-21 15:26:13 +0800333static void aesce_setkey_enc(unsigned char *rk,
334 const unsigned char *key,
335 const size_t key_bit_length)
Jerry Yu3f2fb712023-01-10 17:05:42 +0800336{
Jerry Yubaae4012023-02-21 15:26:13 +0800337 static uint8_t const rcon[] = { 0x01, 0x02, 0x04, 0x08, 0x10,
338 0x20, 0x40, 0x80, 0x1b, 0x36 };
Jerry Yu947bf962023-02-23 11:07:57 +0800339 /* See https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.197.pdf
340 * - Section 5, Nr = Nk + 6
Jerry Yu2c266512023-03-01 11:18:20 +0800341 * - Section 5.2, the length of round keys is Nb*(Nr+1)
Jerry Yu947bf962023-02-23 11:07:57 +0800342 */
343 const uint32_t key_len_in_words = key_bit_length / 32; /* Nk */
344 const size_t round_key_len_in_words = 4; /* Nb */
Jerry Yu2c266512023-03-01 11:18:20 +0800345 const size_t rounds_needed = key_len_in_words + 6; /* Nr */
346 const size_t round_keys_len_in_words =
347 round_key_len_in_words * (rounds_needed + 1); /* Nb*(Nr+1) */
348 const uint32_t *rko_end = (uint32_t *) rk + round_keys_len_in_words;
Jerry Yuc8bcdc82023-02-21 14:49:02 +0800349
Jerry Yu3304c202023-02-22 14:37:11 +0800350 memcpy(rk, key, key_len_in_words * 4);
Jerry Yu3f2fb712023-01-10 17:05:42 +0800351
Jerry Yu3304c202023-02-22 14:37:11 +0800352 for (uint32_t *rki = (uint32_t *) rk;
353 rki + key_len_in_words < rko_end;
354 rki += key_len_in_words) {
355
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +0000356 size_t iteration = (size_t) (rki - (uint32_t *) rk) / key_len_in_words;
Jerry Yu3304c202023-02-22 14:37:11 +0800357 uint32_t *rko;
Jerry Yubaae4012023-02-21 15:26:13 +0800358 rko = rki + key_len_in_words;
359 rko[0] = aes_rot_word(aes_sub_word(rki[key_len_in_words - 1]));
Jerry Yu3304c202023-02-22 14:37:11 +0800360 rko[0] ^= rcon[iteration] ^ rki[0];
Jerry Yu3f2fb712023-01-10 17:05:42 +0800361 rko[1] = rko[0] ^ rki[1];
362 rko[2] = rko[1] ^ rki[2];
363 rko[3] = rko[2] ^ rki[3];
Jerry Yufac5a542023-02-23 10:13:40 +0800364 if (rko + key_len_in_words > rko_end) {
Jerry Yu3304c202023-02-22 14:37:11 +0800365 /* Do not write overflow words.*/
366 continue;
367 }
Yanray Wange2bc1582023-05-08 10:28:53 +0800368#if !defined(MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH)
Jerry Yubaae4012023-02-21 15:26:13 +0800369 switch (key_bit_length) {
Jerry Yu3304c202023-02-22 14:37:11 +0800370 case 128:
371 break;
Jerry Yubaae4012023-02-21 15:26:13 +0800372 case 192:
Jerry Yu3304c202023-02-22 14:37:11 +0800373 rko[4] = rko[3] ^ rki[4];
374 rko[5] = rko[4] ^ rki[5];
Jerry Yubaae4012023-02-21 15:26:13 +0800375 break;
376 case 256:
Jerry Yu3304c202023-02-22 14:37:11 +0800377 rko[4] = aes_sub_word(rko[3]) ^ rki[4];
378 rko[5] = rko[4] ^ rki[5];
379 rko[6] = rko[5] ^ rki[6];
380 rko[7] = rko[6] ^ rki[7];
Jerry Yubaae4012023-02-21 15:26:13 +0800381 break;
Jerry Yu3f2fb712023-01-10 17:05:42 +0800382 }
Yanray Wange2bc1582023-05-08 10:28:53 +0800383#endif /* !MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH */
Jerry Yu3f2fb712023-01-10 17:05:42 +0800384 }
385}
386
387/*
388 * Key expansion, wrapper
389 */
390int mbedtls_aesce_setkey_enc(unsigned char *rk,
391 const unsigned char *key,
392 size_t bits)
393{
394 switch (bits) {
Jerry Yubaae4012023-02-21 15:26:13 +0800395 case 128:
396 case 192:
397 case 256:
Jerry Yuba1e78f2023-02-24 11:18:16 +0800398 aesce_setkey_enc(rk, key, bits);
399 break;
400 default:
401 return MBEDTLS_ERR_AES_INVALID_KEY_LENGTH;
Jerry Yu3f2fb712023-01-10 17:05:42 +0800402 }
403
404 return 0;
405}
406
Jerry Yudf87a122023-01-10 18:17:15 +0800407#if defined(MBEDTLS_GCM_C)
408
Dave Rodgman46267f62023-10-09 14:47:50 +0100409#if defined(MBEDTLS_ARCH_IS_ARM32)
410
411#if defined(__clang__)
412/* On clang for A32/T32, work around some missing intrinsics and types which are listed in
413 * [ACLE](https://arm-software.github.io/acle/neon_intrinsics/advsimd.html#polynomial-1)
414 * These are only required for GCM.
415 */
Dave Rodgman46267f62023-10-09 14:47:50 +0100416#define vreinterpretq_u64_p64(a) ((uint64x2_t) a)
417
418typedef uint8x16_t poly128_t;
419
420static inline poly128_t vmull_p64(poly64_t a, poly64_t b)
Jerry Yu132d0cb2023-03-02 17:35:53 +0800421{
Dave Rodgman46267f62023-10-09 14:47:50 +0100422 poly128_t r;
423 asm ("vmull.p64 %[r], %[a], %[b]" : [r] "=w" (r) : [a] "w" (a), [b] "w" (b) :);
424 return r;
Jerry Yu132d0cb2023-03-02 17:35:53 +0800425}
Dave Rodgman46267f62023-10-09 14:47:50 +0100426
Dave Rodgman90291df2023-10-10 09:51:16 +0100427/* This is set to cause some more missing intrinsics to be defined below */
428#define COMMON_MISSING_INTRINSICS
Dave Rodgman46267f62023-10-09 14:47:50 +0100429
430static inline poly128_t vmull_high_p64(poly64x2_t a, poly64x2_t b)
431{
432 return vmull_p64((poly64_t) (vget_high_u64((uint64x2_t) a)),
433 (poly64_t) (vget_high_u64((uint64x2_t) b)));
434}
435
436#endif /* defined(__clang__) */
437
438static inline uint8x16_t vrbitq_u8(uint8x16_t x)
439{
440 /* There is no vrbitq_u8 instruction in A32/T32, so provide
441 * an equivalent non-Neon implementation. Reverse bit order in each
442 * byte with 4x rbit, rev. */
443 asm ("ldm %[p], { r2-r5 } \n\t"
444 "rbit r2, r2 \n\t"
445 "rev r2, r2 \n\t"
446 "rbit r3, r3 \n\t"
447 "rev r3, r3 \n\t"
448 "rbit r4, r4 \n\t"
449 "rev r4, r4 \n\t"
450 "rbit r5, r5 \n\t"
451 "rev r5, r5 \n\t"
452 "stm %[p], { r2-r5 } \n\t"
453 :
454 /* Output: 16 bytes of memory pointed to by &x */
455 "+m" (*(uint8_t(*)[16]) &x)
456 :
457 [p] "r" (&x)
458 :
459 "r2", "r3", "r4", "r5"
460 );
461 return x;
462}
Dave Rodgman46267f62023-10-09 14:47:50 +0100463
Dave Rodgman90291df2023-10-10 09:51:16 +0100464#endif /* defined(MBEDTLS_ARCH_IS_ARM32) */
Dave Rodgman46267f62023-10-09 14:47:50 +0100465
466#if defined(MBEDTLS_COMPILER_IS_GCC) && __GNUC__ == 5
Jerry Yu132d0cb2023-03-02 17:35:53 +0800467/* Some intrinsics are not available for GCC 5.X. */
Dave Rodgman90291df2023-10-10 09:51:16 +0100468#define COMMON_MISSING_INTRINSICS
469#endif /* MBEDTLS_COMPILER_IS_GCC && __GNUC__ == 5 */
470
471
472#if defined(COMMON_MISSING_INTRINSICS)
473
474/* Missing intrinsics common to both GCC 5, and Clang on 32-bit */
475
476#define vreinterpretq_p64_u8(a) ((poly64x2_t) a)
Jerry Yu132d0cb2023-03-02 17:35:53 +0800477#define vreinterpretq_u8_p128(a) ((uint8x16_t) a)
Dave Rodgman46267f62023-10-09 14:47:50 +0100478
Dave Rodgman90291df2023-10-10 09:51:16 +0100479static inline poly64x1_t vget_low_p64(poly64x2_t a)
Jerry Yu132d0cb2023-03-02 17:35:53 +0800480{
Dave Rodgman90291df2023-10-10 09:51:16 +0100481 uint64x1_t r = vget_low_u64(vreinterpretq_u64_p64(a));
482 return (poly64x1_t) r;
483
Jerry Yu132d0cb2023-03-02 17:35:53 +0800484}
Dave Rodgman90291df2023-10-10 09:51:16 +0100485
486#endif /* COMMON_MISSING_INTRINSICS */
Jerry Yu132d0cb2023-03-02 17:35:53 +0800487
Jerry Yu1ac7f6b2023-03-07 15:44:59 +0800488/* vmull_p64/vmull_high_p64 wrappers.
489 *
490 * Older compilers miss some intrinsic functions for `poly*_t`. We use
491 * uint8x16_t and uint8x16x3_t as input/output parameters.
492 */
Dave Rodgman46267f62023-10-09 14:47:50 +0100493#if defined(MBEDTLS_COMPILER_IS_GCC)
Jerry Yu9db4b1f2023-03-21 16:56:43 +0800494/* GCC reports incompatible type error without cast. GCC think poly64_t and
495 * poly64x1_t are different, that is different with MSVC and Clang. */
496#define MBEDTLS_VMULL_P64(a, b) vmull_p64((poly64_t) a, (poly64_t) b)
497#else
498/* MSVC reports `error C2440: 'type cast'` with cast. Clang does not report
499 * error with/without cast. And I think poly64_t and poly64x1_t are same, no
500 * cast for clang also. */
501#define MBEDTLS_VMULL_P64(a, b) vmull_p64(a, b)
Dave Rodgman46267f62023-10-09 14:47:50 +0100502#endif /* MBEDTLS_COMPILER_IS_GCC */
503
Jerry Yudf87a122023-01-10 18:17:15 +0800504static inline uint8x16_t pmull_low(uint8x16_t a, uint8x16_t b)
505{
Jerry Yu9db4b1f2023-03-21 16:56:43 +0800506
Jerry Yudf87a122023-01-10 18:17:15 +0800507 return vreinterpretq_u8_p128(
Jerry Yu9db4b1f2023-03-21 16:56:43 +0800508 MBEDTLS_VMULL_P64(
Dave Rodgmane467d622023-11-03 23:40:31 +0000509 (poly64_t) vget_low_p64(vreinterpretq_p64_u8(a)),
510 (poly64_t) vget_low_p64(vreinterpretq_p64_u8(b))
Jerry Yu9db4b1f2023-03-21 16:56:43 +0800511 ));
Jerry Yudf87a122023-01-10 18:17:15 +0800512}
513
514static inline uint8x16_t pmull_high(uint8x16_t a, uint8x16_t b)
515{
516 return vreinterpretq_u8_p128(
517 vmull_high_p64(vreinterpretq_p64_u8(a),
518 vreinterpretq_p64_u8(b)));
519}
520
Jerry Yuf0526a92023-03-14 15:00:29 +0800521/* GHASH does 128b polynomial multiplication on block in GF(2^128) defined by
Jerry Yu49b43672023-03-13 10:09:34 +0800522 * `x^128 + x^7 + x^2 + x + 1`.
Jerry Yu1ac7f6b2023-03-07 15:44:59 +0800523 *
524 * Arm64 only has 64b->128b polynomial multipliers, we need to do 4 64b
525 * multiplies to generate a 128b.
526 *
527 * `poly_mult_128` executes polynomial multiplication and outputs 256b that
528 * represented by 3 128b due to code size optimization.
529 *
530 * Output layout:
531 * | | | |
532 * |------------|-------------|-------------|
533 * | ret.val[0] | h3:h2:00:00 | high 128b |
Jerry Yu8f810602023-03-14 17:28:52 +0800534 * | ret.val[1] | :m2:m1:00 | middle 128b |
Jerry Yu1ac7f6b2023-03-07 15:44:59 +0800535 * | ret.val[2] | : :l1:l0 | low 128b |
536 */
Jerry Yudf87a122023-01-10 18:17:15 +0800537static inline uint8x16x3_t poly_mult_128(uint8x16_t a, uint8x16_t b)
538{
539 uint8x16x3_t ret;
Jerry Yu8f810602023-03-14 17:28:52 +0800540 uint8x16_t h, m, l; /* retval high/middle/low */
Jerry Yu1ac7f6b2023-03-07 15:44:59 +0800541 uint8x16_t c, d, e;
542
543 h = pmull_high(a, b); /* h3:h2:00:00 = a1*b1 */
544 l = pmull_low(a, b); /* : :l1:l0 = a0*b0 */
545 c = vextq_u8(b, b, 8); /* :c1:c0 = b0:b1 */
546 d = pmull_high(a, c); /* :d2:d1:00 = a1*b0 */
547 e = pmull_low(a, c); /* :e2:e1:00 = a0*b1 */
548 m = veorq_u8(d, e); /* :m2:m1:00 = d + e */
549
550 ret.val[0] = h;
551 ret.val[1] = m;
552 ret.val[2] = l;
Jerry Yudf87a122023-01-10 18:17:15 +0800553 return ret;
554}
555
Jerry Yu1ac7f6b2023-03-07 15:44:59 +0800556/*
557 * Modulo reduction.
558 *
559 * See: https://www.researchgate.net/publication/285612706_Implementing_GCM_on_ARMv8
560 *
561 * Section 4.3
562 *
563 * Modular reduction is slightly more complex. Write the GCM modulus as f(z) =
564 * z^128 +r(z), where r(z) = z^7+z^2+z+ 1. The well known approach is to
Jerry Yube4fdef2023-03-15 14:50:42 +0800565 * consider that z^128 ≡r(z) (mod z^128 +r(z)), allowing us to write the 256-bit
566 * operand to be reduced as a(z) = h(z)z^128 +l(z)≡h(z)r(z) + l(z). That is, we
567 * simply multiply the higher part of the operand by r(z) and add it to l(z). If
Jerry Yu1ac7f6b2023-03-07 15:44:59 +0800568 * the result is still larger than 128 bits, we reduce again.
569 */
570static inline uint8x16_t poly_mult_reduce(uint8x16x3_t input)
Jerry Yudf87a122023-01-10 18:17:15 +0800571{
Jerry Yu1ac7f6b2023-03-07 15:44:59 +0800572 uint8x16_t const ZERO = vdupq_n_u8(0);
Jerry Yu8b6df3f2023-03-21 16:59:13 +0800573
Jerry Yudf87a122023-01-10 18:17:15 +0800574 uint64x2_t r = vreinterpretq_u64_u8(vdupq_n_u8(0x87));
Jerry Yu8b6df3f2023-03-21 16:59:13 +0800575#if defined(__GNUC__)
576 /* use 'asm' as an optimisation barrier to prevent loading MODULO from
577 * memory. It is for GNUC compatible compilers.
578 */
Dave Rodgmancb5c9fb2023-10-10 10:06:02 +0100579 asm volatile ("" : "+w" (r));
Jerry Yu8b6df3f2023-03-21 16:59:13 +0800580#endif
Jerry Yu1ac7f6b2023-03-07 15:44:59 +0800581 uint8x16_t const MODULO = vreinterpretq_u8_u64(vshrq_n_u64(r, 64 - 8));
Jerry Yu8f810602023-03-14 17:28:52 +0800582 uint8x16_t h, m, l; /* input high/middle/low 128b */
Jerry Yu1ac7f6b2023-03-07 15:44:59 +0800583 uint8x16_t c, d, e, f, g, n, o;
584 h = input.val[0]; /* h3:h2:00:00 */
585 m = input.val[1]; /* :m2:m1:00 */
586 l = input.val[2]; /* : :l1:l0 */
587 c = pmull_high(h, MODULO); /* :c2:c1:00 = reduction of h3 */
588 d = pmull_low(h, MODULO); /* : :d1:d0 = reduction of h2 */
589 e = veorq_u8(c, m); /* :e2:e1:00 = m2:m1:00 + c2:c1:00 */
590 f = pmull_high(e, MODULO); /* : :f1:f0 = reduction of e2 */
591 g = vextq_u8(ZERO, e, 8); /* : :g1:00 = e1:00 */
592 n = veorq_u8(d, l); /* : :n1:n0 = d1:d0 + l1:l0 */
593 o = veorq_u8(n, f); /* o1:o0 = f1:f0 + n1:n0 */
594 return veorq_u8(o, g); /* = o1:o0 + g1:00 */
Jerry Yudf87a122023-01-10 18:17:15 +0800595}
596
597/*
598 * GCM multiplication: c = a times b in GF(2^128)
599 */
600void mbedtls_aesce_gcm_mult(unsigned char c[16],
601 const unsigned char a[16],
602 const unsigned char b[16])
603{
604 uint8x16_t va, vb, vc;
605 va = vrbitq_u8(vld1q_u8(&a[0]));
606 vb = vrbitq_u8(vld1q_u8(&b[0]));
607 vc = vrbitq_u8(poly_mult_reduce(poly_mult_128(va, vb)));
608 vst1q_u8(&c[0], vc);
609}
610
611#endif /* MBEDTLS_GCM_C */
Jerry Yu48b999c2023-03-03 15:51:07 +0800612
613#if defined(MBEDTLS_POP_TARGET_PRAGMA)
614#if defined(__clang__)
615#pragma clang attribute pop
616#elif defined(__GNUC__)
617#pragma GCC pop_options
618#endif
619#undef MBEDTLS_POP_TARGET_PRAGMA
620#endif
621
Dave Rodgman9fd1b522023-10-10 15:23:44 +0100622#endif /* MBEDTLS_ARCH_IS_ARMV8_A */
Jerry Yu49231312023-01-10 16:57:21 +0800623
624#endif /* MBEDTLS_AESCE_C */