Jerry Yu | 4923131 | 2023-01-10 16:57:21 +0800 | [diff] [blame] | 1 | /** |
| 2 | * \file aesce.h |
| 3 | * |
Dave Rodgman | f918d42 | 2023-03-17 17:52:23 +0000 | [diff] [blame] | 4 | * \brief Support hardware AES acceleration on Armv8-A processors with |
Dave Rodgman | ece803b | 2023-10-08 20:24:48 +0100 | [diff] [blame] | 5 | * the Armv8-A Cryptographic Extension. |
Jerry Yu | 4923131 | 2023-01-10 16:57:21 +0800 | [diff] [blame] | 6 | * |
| 7 | * \warning These functions are only for internal use by other library |
| 8 | * functions; you must not call them directly. |
| 9 | */ |
| 10 | /* |
| 11 | * Copyright The Mbed TLS Contributors |
Dave Rodgman | 16799db | 2023-11-02 19:47:20 +0000 | [diff] [blame] | 12 | * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later |
Jerry Yu | 4923131 | 2023-01-10 16:57:21 +0800 | [diff] [blame] | 13 | */ |
| 14 | #ifndef MBEDTLS_AESCE_H |
| 15 | #define MBEDTLS_AESCE_H |
| 16 | |
| 17 | #include "mbedtls/build_info.h" |
Dave Rodgman | 12d1c3a | 2023-11-30 09:38:38 +0000 | [diff] [blame] | 18 | #include "common.h" |
Jerry Yu | 4923131 | 2023-01-10 16:57:21 +0800 | [diff] [blame] | 19 | |
| 20 | #include "mbedtls/aes.h" |
| 21 | |
Jerry Yu | 07d28d8 | 2023-03-20 18:12:36 +0800 | [diff] [blame] | 22 | |
Dave Rodgman | 6eee57b | 2023-11-30 11:01:04 +0000 | [diff] [blame^] | 23 | #if defined(MBEDTLS_AESCE_C) \ |
| 24 | && defined(MBEDTLS_ARCH_IS_ARMV8_A) && defined(MBEDTLS_HAVE_NEON_INTRINSICS) \ |
Dave Rodgman | 410ad44 | 2023-11-28 13:42:17 +0000 | [diff] [blame] | 25 | && (defined(MBEDTLS_COMPILER_IS_GCC) || defined(__clang__) || defined(MSC_VER)) |
Jerry Yu | 72fd0bd | 2023-08-18 16:31:01 +0800 | [diff] [blame] | 26 | |
Dave Rodgman | 410ad44 | 2023-11-28 13:42:17 +0000 | [diff] [blame] | 27 | /* MBEDTLS_AESCE_HAVE_CODE is defined if we have a suitable target platform, and a |
| 28 | * potentially suitable compiler (compiler version & flags are not checked when defining |
| 29 | * this). */ |
Jerry Yu | 72fd0bd | 2023-08-18 16:31:01 +0800 | [diff] [blame] | 30 | #define MBEDTLS_AESCE_HAVE_CODE |
Jerry Yu | 4923131 | 2023-01-10 16:57:21 +0800 | [diff] [blame] | 31 | |
| 32 | #ifdef __cplusplus |
| 33 | extern "C" { |
| 34 | #endif |
Jerry Yu | b95c776 | 2023-01-10 16:59:51 +0800 | [diff] [blame] | 35 | |
Dave Rodgman | 4566132 | 2023-08-04 12:31:58 +0100 | [diff] [blame] | 36 | #if defined(__linux__) && !defined(MBEDTLS_AES_USE_HARDWARE_ONLY) |
| 37 | |
Dave Rodgman | b30adce | 2023-08-04 12:52:51 +0100 | [diff] [blame] | 38 | extern signed char mbedtls_aesce_has_support_result; |
Dave Rodgman | 4566132 | 2023-08-04 12:31:58 +0100 | [diff] [blame] | 39 | |
Jerry Yu | b95c776 | 2023-01-10 16:59:51 +0800 | [diff] [blame] | 40 | /** |
Jerry Yu | c8bcdc8 | 2023-02-21 14:49:02 +0800 | [diff] [blame] | 41 | * \brief Internal function to detect the crypto extension in CPUs. |
Jerry Yu | b95c776 | 2023-01-10 16:59:51 +0800 | [diff] [blame] | 42 | * |
| 43 | * \return 1 if CPU has support for the feature, 0 otherwise |
| 44 | */ |
Dave Rodgman | 4566132 | 2023-08-04 12:31:58 +0100 | [diff] [blame] | 45 | int mbedtls_aesce_has_support_impl(void); |
Jerry Yu | 0d4f4e5 | 2023-03-31 14:32:47 +0800 | [diff] [blame] | 46 | |
Dave Rodgman | f2249ec | 2023-08-04 14:27:58 +0100 | [diff] [blame] | 47 | #define MBEDTLS_AESCE_HAS_SUPPORT() (mbedtls_aesce_has_support_result == -1 ? \ |
Dave Rodgman | 4566132 | 2023-08-04 12:31:58 +0100 | [diff] [blame] | 48 | mbedtls_aesce_has_support_impl() : \ |
| 49 | mbedtls_aesce_has_support_result) |
| 50 | |
| 51 | #else /* defined(__linux__) && !defined(MBEDTLS_AES_USE_HARDWARE_ONLY) */ |
| 52 | |
| 53 | /* If we are not on Linux, we can't detect support so assume that it's supported. |
| 54 | * Similarly, assume support if MBEDTLS_AES_USE_HARDWARE_ONLY is set. |
| 55 | */ |
Dave Rodgman | f2249ec | 2023-08-04 14:27:58 +0100 | [diff] [blame] | 56 | #define MBEDTLS_AESCE_HAS_SUPPORT() 1 |
Dave Rodgman | 4566132 | 2023-08-04 12:31:58 +0100 | [diff] [blame] | 57 | |
| 58 | #endif /* defined(__linux__) && !defined(MBEDTLS_AES_USE_HARDWARE_ONLY) */ |
Jerry Yu | b95c776 | 2023-01-10 16:59:51 +0800 | [diff] [blame] | 59 | |
Jerry Yu | 2bb3d81 | 2023-01-10 17:38:26 +0800 | [diff] [blame] | 60 | /** |
| 61 | * \brief Internal AES-ECB block encryption and decryption |
| 62 | * |
Dave Rodgman | 48fd2ab | 2023-06-16 09:36:50 +0100 | [diff] [blame] | 63 | * \warning This assumes that the context specifies either 10, 12 or 14 |
| 64 | * rounds and will behave incorrectly if this is not the case. |
Dave Rodgman | 96fdfb8 | 2023-06-15 16:21:31 +0100 | [diff] [blame] | 65 | * |
Jerry Yu | 2bb3d81 | 2023-01-10 17:38:26 +0800 | [diff] [blame] | 66 | * \param ctx AES context |
| 67 | * \param mode MBEDTLS_AES_ENCRYPT or MBEDTLS_AES_DECRYPT |
| 68 | * \param input 16-byte input block |
| 69 | * \param output 16-byte output block |
| 70 | * |
| 71 | * \return 0 on success (cannot fail) |
| 72 | */ |
| 73 | int mbedtls_aesce_crypt_ecb(mbedtls_aes_context *ctx, |
| 74 | int mode, |
| 75 | const unsigned char input[16], |
| 76 | unsigned char output[16]); |
| 77 | |
Jerry Yu | 3f2fb71 | 2023-01-10 17:05:42 +0800 | [diff] [blame] | 78 | /** |
Jerry Yu | df87a12 | 2023-01-10 18:17:15 +0800 | [diff] [blame] | 79 | * \brief Internal GCM multiplication: c = a * b in GF(2^128) |
| 80 | * |
| 81 | * \note This function is only for internal use by other library |
| 82 | * functions; you must not call it directly. |
| 83 | * |
| 84 | * \param c Result |
| 85 | * \param a First operand |
| 86 | * \param b Second operand |
| 87 | * |
| 88 | * \note Both operands and result are bit strings interpreted as |
| 89 | * elements of GF(2^128) as per the GCM spec. |
| 90 | */ |
| 91 | void mbedtls_aesce_gcm_mult(unsigned char c[16], |
| 92 | const unsigned char a[16], |
| 93 | const unsigned char b[16]); |
| 94 | |
| 95 | |
Yanray Wang | b67b474 | 2023-10-31 17:10:32 +0800 | [diff] [blame] | 96 | #if !defined(MBEDTLS_BLOCK_CIPHER_NO_DECRYPT) |
Jerry Yu | df87a12 | 2023-01-10 18:17:15 +0800 | [diff] [blame] | 97 | /** |
Jerry Yu | e096da1 | 2023-01-10 17:07:01 +0800 | [diff] [blame] | 98 | * \brief Internal round key inversion. This function computes |
| 99 | * decryption round keys from the encryption round keys. |
| 100 | * |
| 101 | * \param invkey Round keys for the equivalent inverse cipher |
| 102 | * \param fwdkey Original round keys (for encryption) |
| 103 | * \param nr Number of rounds (that is, number of round keys minus one) |
| 104 | */ |
| 105 | void mbedtls_aesce_inverse_key(unsigned char *invkey, |
| 106 | const unsigned char *fwdkey, |
| 107 | int nr); |
Yanray Wang | b67b474 | 2023-10-31 17:10:32 +0800 | [diff] [blame] | 108 | #endif /* !MBEDTLS_BLOCK_CIPHER_NO_DECRYPT */ |
Jerry Yu | e096da1 | 2023-01-10 17:07:01 +0800 | [diff] [blame] | 109 | |
| 110 | /** |
Jerry Yu | 3f2fb71 | 2023-01-10 17:05:42 +0800 | [diff] [blame] | 111 | * \brief Internal key expansion for encryption |
| 112 | * |
| 113 | * \param rk Destination buffer where the round keys are written |
| 114 | * \param key Encryption key |
| 115 | * \param bits Key size in bits (must be 128, 192 or 256) |
| 116 | * |
| 117 | * \return 0 if successful, or MBEDTLS_ERR_AES_INVALID_KEY_LENGTH |
| 118 | */ |
| 119 | int mbedtls_aesce_setkey_enc(unsigned char *rk, |
| 120 | const unsigned char *key, |
| 121 | size_t bits); |
| 122 | |
Jerry Yu | 4923131 | 2023-01-10 16:57:21 +0800 | [diff] [blame] | 123 | #ifdef __cplusplus |
| 124 | } |
| 125 | #endif |
| 126 | |
Dave Rodgman | ece803b | 2023-10-08 20:24:48 +0100 | [diff] [blame] | 127 | #else |
| 128 | |
Dave Rodgman | 9fd1b52 | 2023-10-10 15:23:44 +0100 | [diff] [blame] | 129 | #if defined(MBEDTLS_AES_USE_HARDWARE_ONLY) && defined(MBEDTLS_ARCH_IS_ARMV8_A) |
Dave Rodgman | 410ad44 | 2023-11-28 13:42:17 +0000 | [diff] [blame] | 130 | #error "AES hardware acceleration not supported on this platform / compiler" |
Dave Rodgman | ece803b | 2023-10-08 20:24:48 +0100 | [diff] [blame] | 131 | #endif |
| 132 | |
Dave Rodgman | 6eee57b | 2023-11-30 11:01:04 +0000 | [diff] [blame^] | 133 | #endif /* MBEDTLS_AESCE_C && MBEDTLS_ARCH_IS_ARMV8_A && MBEDTLS_HAVE_NEON_INTRINSICS && |
Dave Rodgman | 410ad44 | 2023-11-28 13:42:17 +0000 | [diff] [blame] | 134 | (MBEDTLS_COMPILER_IS_GCC || __clang__ || MSC_VER) */ |
Jerry Yu | 4923131 | 2023-01-10 16:57:21 +0800 | [diff] [blame] | 135 | |
| 136 | #endif /* MBEDTLS_AESCE_H */ |