| Gilles Peskine | 9ef733f | 2018-02-07 21:05:37 +0100 | [diff] [blame] | 1 | /** | 
|  | 2 | * \file psa/crypto_struct.h | 
|  | 3 | * | 
|  | 4 | * \brief PSA cryptography module: Mbed TLS structured type implementations | 
| Gilles Peskine | 07c91f5 | 2018-06-28 18:02:53 +0200 | [diff] [blame] | 5 | * | 
|  | 6 | * \note This file may not be included directly. Applications must | 
|  | 7 | * include psa/crypto.h. | 
|  | 8 | * | 
|  | 9 | * This file contains the definitions of some data structures with | 
|  | 10 | * implementation-specific definitions. | 
|  | 11 | * | 
|  | 12 | * In implementations with isolation between the application and the | 
|  | 13 | * cryptography module, it is expected that the front-end and the back-end | 
|  | 14 | * would have different versions of this file. | 
| Gilles Peskine | b4e73e9 | 2019-08-13 15:00:57 +0200 | [diff] [blame] | 15 | * | 
|  | 16 | * <h3>Design notes about multipart operation structures</h3> | 
|  | 17 | * | 
| Ronald Cron | 980230e | 2021-04-01 15:37:49 +0200 | [diff] [blame] | 18 | * For multipart operations without driver delegation support, each multipart | 
|  | 19 | * operation structure contains a `psa_algorithm_t alg` field which indicates | 
|  | 20 | * which specific algorithm the structure is for. When the structure is not in | 
|  | 21 | * use, `alg` is 0. Most of the structure consists of a union which is | 
|  | 22 | * discriminated by `alg`. | 
| Gilles Peskine | b4e73e9 | 2019-08-13 15:00:57 +0200 | [diff] [blame] | 23 | * | 
| Ronald Cron | 980230e | 2021-04-01 15:37:49 +0200 | [diff] [blame] | 24 | * For multipart operations with driver delegation support, each multipart | 
|  | 25 | * operation structure contains an `unsigned int id` field indicating which | 
|  | 26 | * driver got assigned to do the operation. When the structure is not in use, | 
|  | 27 | * 'id' is 0. The structure contains also a driver context which is the union | 
|  | 28 | * of the contexts of all drivers able to handle the type of multipart | 
|  | 29 | * operation. | 
|  | 30 | * | 
|  | 31 | * Note that when `alg` or `id` is 0, the content of other fields is undefined. | 
| Gilles Peskine | b4e73e9 | 2019-08-13 15:00:57 +0200 | [diff] [blame] | 32 | * In particular, it is not guaranteed that a freshly-initialized structure | 
|  | 33 | * is all-zero: we initialize structures to something like `{0, 0}`, which | 
|  | 34 | * is only guaranteed to initializes the first member of the union; | 
|  | 35 | * GCC and Clang initialize the whole structure to 0 (at the time of writing), | 
|  | 36 | * but MSVC and CompCert don't. | 
|  | 37 | * | 
|  | 38 | * In Mbed Crypto, multipart operation structures live independently from | 
|  | 39 | * the key. This allows Mbed Crypto to free the key objects when destroying | 
|  | 40 | * a key slot. If a multipart operation needs to remember the key after | 
|  | 41 | * the setup function returns, the operation structure needs to contain a | 
|  | 42 | * copy of the key. | 
| Gilles Peskine | 9ef733f | 2018-02-07 21:05:37 +0100 | [diff] [blame] | 43 | */ | 
|  | 44 | /* | 
| Bence Szépkúti | 1e14827 | 2020-08-07 13:07:28 +0200 | [diff] [blame] | 45 | *  Copyright The Mbed TLS Contributors | 
| Gilles Peskine | 9ef733f | 2018-02-07 21:05:37 +0100 | [diff] [blame] | 46 | *  SPDX-License-Identifier: Apache-2.0 | 
|  | 47 | * | 
|  | 48 | *  Licensed under the Apache License, Version 2.0 (the "License"); you may | 
|  | 49 | *  not use this file except in compliance with the License. | 
|  | 50 | *  You may obtain a copy of the License at | 
|  | 51 | * | 
|  | 52 | *  http://www.apache.org/licenses/LICENSE-2.0 | 
|  | 53 | * | 
|  | 54 | *  Unless required by applicable law or agreed to in writing, software | 
|  | 55 | *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | 
|  | 56 | *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | 
|  | 57 | *  See the License for the specific language governing permissions and | 
|  | 58 | *  limitations under the License. | 
| Gilles Peskine | 9ef733f | 2018-02-07 21:05:37 +0100 | [diff] [blame] | 59 | */ | 
|  | 60 |  | 
|  | 61 | #ifndef PSA_CRYPTO_STRUCT_H | 
|  | 62 | #define PSA_CRYPTO_STRUCT_H | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 63 | #include "mbedtls/private_access.h" | 
| Gilles Peskine | 9ef733f | 2018-02-07 21:05:37 +0100 | [diff] [blame] | 64 |  | 
| Jaeden Amero | 8013f44 | 2019-08-16 16:13:51 +0100 | [diff] [blame] | 65 | #ifdef __cplusplus | 
|  | 66 | extern "C" { | 
|  | 67 | #endif | 
|  | 68 |  | 
| Gilles Peskine | 9ef733f | 2018-02-07 21:05:37 +0100 | [diff] [blame] | 69 | /* Include the Mbed TLS configuration file, the way Mbed TLS does it | 
|  | 70 | * in each of its header files. */ | 
| Bence Szépkúti | c662b36 | 2021-05-27 11:25:03 +0200 | [diff] [blame] | 71 | #include "mbedtls/build_info.h" | 
| Gilles Peskine | 9ef733f | 2018-02-07 21:05:37 +0100 | [diff] [blame] | 72 |  | 
| Gilles Peskine | 9ef733f | 2018-02-07 21:05:37 +0100 | [diff] [blame] | 73 | #include "mbedtls/cmac.h" | 
|  | 74 | #include "mbedtls/gcm.h" | 
| Paul Elliott | 07a30c4 | 2021-04-20 14:13:23 +0100 | [diff] [blame] | 75 | #include "mbedtls/ccm.h" | 
|  | 76 | #include "mbedtls/chachapoly.h" | 
| Steven Cooreman | dbf8ced | 2021-03-04 13:01:18 +0100 | [diff] [blame] | 77 |  | 
| Steven Cooreman | 61398ec | 2021-04-26 12:04:53 +0200 | [diff] [blame] | 78 | /* Include the context definition for the compiled-in drivers for the primitive | 
|  | 79 | * algorithms. */ | 
| Steven Cooreman | 675501d | 2021-04-26 11:54:58 +0200 | [diff] [blame] | 80 | #include "psa/crypto_driver_contexts_primitives.h" | 
| Gilles Peskine | 9ef733f | 2018-02-07 21:05:37 +0100 | [diff] [blame] | 81 |  | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 82 | struct psa_hash_operation_s { | 
| Steven Cooreman | dbf8ced | 2021-03-04 13:01:18 +0100 | [diff] [blame] | 83 | /** Unique ID indicating which driver got assigned to do the | 
|  | 84 | * operation. Since driver contexts are driver-specific, swapping | 
|  | 85 | * drivers halfway through the operation is not supported. | 
| Ronald Cron | 980230e | 2021-04-01 15:37:49 +0200 | [diff] [blame] | 86 | * ID values are auto-generated in psa_driver_wrappers.h. | 
| Steven Cooreman | dbf8ced | 2021-03-04 13:01:18 +0100 | [diff] [blame] | 87 | * ID value zero means the context is not valid or not assigned to | 
| Ronald Cron | 980230e | 2021-04-01 15:37:49 +0200 | [diff] [blame] | 88 | * any driver (i.e. the driver context is not active, in use). */ | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 89 | unsigned int MBEDTLS_PRIVATE(id); | 
|  | 90 | psa_driver_hash_context_t MBEDTLS_PRIVATE(ctx); | 
| Gilles Peskine | 9ef733f | 2018-02-07 21:05:37 +0100 | [diff] [blame] | 91 | }; | 
|  | 92 |  | 
| Janos Follath | 33434a9 | 2021-05-26 09:25:33 +0100 | [diff] [blame] | 93 | #define PSA_HASH_OPERATION_INIT { 0, { 0 } } | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 94 | static inline struct psa_hash_operation_s psa_hash_operation_init(void) | 
| Jaeden Amero | 6a25b41 | 2019-01-04 11:47:44 +0000 | [diff] [blame] | 95 | { | 
|  | 96 | const struct psa_hash_operation_s v = PSA_HASH_OPERATION_INIT; | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 97 | return v; | 
| Jaeden Amero | 6a25b41 | 2019-01-04 11:47:44 +0000 | [diff] [blame] | 98 | } | 
|  | 99 |  | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 100 | struct psa_cipher_operation_s { | 
| Steven Cooreman | 61398ec | 2021-04-26 12:04:53 +0200 | [diff] [blame] | 101 | /** Unique ID indicating which driver got assigned to do the | 
|  | 102 | * operation. Since driver contexts are driver-specific, swapping | 
|  | 103 | * drivers halfway through the operation is not supported. | 
|  | 104 | * ID values are auto-generated in psa_crypto_driver_wrappers.h | 
|  | 105 | * ID value zero means the context is not valid or not assigned to | 
|  | 106 | * any driver (i.e. none of the driver contexts are active). */ | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 107 | unsigned int MBEDTLS_PRIVATE(id); | 
| Steven Cooreman | 61398ec | 2021-04-26 12:04:53 +0200 | [diff] [blame] | 108 |  | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 109 | unsigned int MBEDTLS_PRIVATE(iv_required) : 1; | 
|  | 110 | unsigned int MBEDTLS_PRIVATE(iv_set) : 1; | 
| Steven Cooreman | 61398ec | 2021-04-26 12:04:53 +0200 | [diff] [blame] | 111 |  | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 112 | uint8_t MBEDTLS_PRIVATE(default_iv_length); | 
| Steven Cooreman | 61398ec | 2021-04-26 12:04:53 +0200 | [diff] [blame] | 113 |  | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 114 | psa_driver_cipher_context_t MBEDTLS_PRIVATE(ctx); | 
| Steven Cooreman | 61398ec | 2021-04-26 12:04:53 +0200 | [diff] [blame] | 115 | }; | 
|  | 116 |  | 
| Janos Follath | 33434a9 | 2021-05-26 09:25:33 +0100 | [diff] [blame] | 117 | #define PSA_CIPHER_OPERATION_INIT { 0, 0, 0, 0, { 0 } } | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 118 | static inline struct psa_cipher_operation_s psa_cipher_operation_init(void) | 
| Steven Cooreman | 61398ec | 2021-04-26 12:04:53 +0200 | [diff] [blame] | 119 | { | 
|  | 120 | const struct psa_cipher_operation_s v = PSA_CIPHER_OPERATION_INIT; | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 121 | return v; | 
| Steven Cooreman | 61398ec | 2021-04-26 12:04:53 +0200 | [diff] [blame] | 122 | } | 
|  | 123 |  | 
| Steven Cooreman | 3c8dd63 | 2021-04-26 12:16:27 +0200 | [diff] [blame] | 124 | /* Include the context definition for the compiled-in drivers for the composite | 
|  | 125 | * algorithms. */ | 
|  | 126 | #include "psa/crypto_driver_contexts_composites.h" | 
| Nir Sonnenschein | dcd636a | 2018-06-04 16:03:32 +0300 | [diff] [blame] | 127 |  | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 128 | struct psa_mac_operation_s { | 
| Steven Cooreman | 77e2cc5 | 2021-03-19 17:05:52 +0100 | [diff] [blame] | 129 | /** Unique ID indicating which driver got assigned to do the | 
|  | 130 | * operation. Since driver contexts are driver-specific, swapping | 
|  | 131 | * drivers halfway through the operation is not supported. | 
|  | 132 | * ID values are auto-generated in psa_driver_wrappers.h | 
|  | 133 | * ID value zero means the context is not valid or not assigned to | 
|  | 134 | * any driver (i.e. none of the driver contexts are active). */ | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 135 | unsigned int MBEDTLS_PRIVATE(id); | 
|  | 136 | uint8_t MBEDTLS_PRIVATE(mac_size); | 
|  | 137 | unsigned int MBEDTLS_PRIVATE(is_sign) : 1; | 
|  | 138 | psa_driver_mac_context_t MBEDTLS_PRIVATE(ctx); | 
| Gilles Peskine | 9ef733f | 2018-02-07 21:05:37 +0100 | [diff] [blame] | 139 | }; | 
|  | 140 |  | 
| Janos Follath | 33434a9 | 2021-05-26 09:25:33 +0100 | [diff] [blame] | 141 | #define PSA_MAC_OPERATION_INIT { 0, 0, 0, { 0 } } | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 142 | static inline struct psa_mac_operation_s psa_mac_operation_init(void) | 
| Jaeden Amero | 769ce27 | 2019-01-04 11:48:03 +0000 | [diff] [blame] | 143 | { | 
|  | 144 | const struct psa_mac_operation_s v = PSA_MAC_OPERATION_INIT; | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 145 | return v; | 
| Jaeden Amero | 769ce27 | 2019-01-04 11:48:03 +0000 | [diff] [blame] | 146 | } | 
|  | 147 |  | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 148 | struct psa_aead_operation_s { | 
| Paul Elliott | adb8b16 | 2021-04-20 16:06:57 +0100 | [diff] [blame] | 149 |  | 
| Paul Elliott | 6504aa6 | 2021-04-20 17:09:36 +0100 | [diff] [blame] | 150 | /** Unique ID indicating which driver got assigned to do the | 
|  | 151 | * operation. Since driver contexts are driver-specific, swapping | 
|  | 152 | * drivers halfway through the operation is not supported. | 
|  | 153 | * ID values are auto-generated in psa_crypto_driver_wrappers.h | 
|  | 154 | * ID value zero means the context is not valid or not assigned to | 
|  | 155 | * any driver (i.e. none of the driver contexts are active). */ | 
| Paul Elliott | c7e7fe5 | 2021-09-27 09:23:40 +0100 | [diff] [blame] | 156 | unsigned int MBEDTLS_PRIVATE(id); | 
| Paul Elliott | 6504aa6 | 2021-04-20 17:09:36 +0100 | [diff] [blame] | 157 |  | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 158 | psa_algorithm_t MBEDTLS_PRIVATE(alg); | 
| Paul Elliott | 71b0567 | 2021-09-24 11:18:13 +0100 | [diff] [blame] | 159 | psa_key_type_t MBEDTLS_PRIVATE(key_type); | 
| Paul Elliott | cbbde5f | 2021-05-10 18:19:46 +0100 | [diff] [blame] | 160 |  | 
| Paul Elliott | 71b0567 | 2021-09-24 11:18:13 +0100 | [diff] [blame] | 161 | size_t MBEDTLS_PRIVATE(ad_remaining); | 
|  | 162 | size_t MBEDTLS_PRIVATE(body_remaining); | 
| Paul Elliott | ee4ffe0 | 2021-05-20 17:25:06 +0100 | [diff] [blame] | 163 |  | 
| Paul Elliott | 71b0567 | 2021-09-24 11:18:13 +0100 | [diff] [blame] | 164 | unsigned int MBEDTLS_PRIVATE(nonce_set) : 1; | 
|  | 165 | unsigned int MBEDTLS_PRIVATE(lengths_set) : 1; | 
|  | 166 | unsigned int MBEDTLS_PRIVATE(ad_started) : 1; | 
|  | 167 | unsigned int MBEDTLS_PRIVATE(body_started) : 1; | 
|  | 168 | unsigned int MBEDTLS_PRIVATE(is_encrypt) : 1; | 
| Paul Elliott | 07a30c4 | 2021-04-20 14:13:23 +0100 | [diff] [blame] | 169 |  | 
| Paul Elliott | 71b0567 | 2021-09-24 11:18:13 +0100 | [diff] [blame] | 170 | psa_driver_aead_context_t MBEDTLS_PRIVATE(ctx); | 
| Gilles Peskine | 30a9e41 | 2019-01-14 18:36:12 +0100 | [diff] [blame] | 171 | }; | 
|  | 172 |  | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 173 | #define PSA_AEAD_OPERATION_INIT { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, { 0 } } | 
|  | 174 | static inline struct psa_aead_operation_s psa_aead_operation_init(void) | 
| Gilles Peskine | 30a9e41 | 2019-01-14 18:36:12 +0100 | [diff] [blame] | 175 | { | 
|  | 176 | const struct psa_aead_operation_s v = PSA_AEAD_OPERATION_INIT; | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 177 | return v; | 
| Gilles Peskine | 30a9e41 | 2019-01-14 18:36:12 +0100 | [diff] [blame] | 178 | } | 
|  | 179 |  | 
| Przemek Stekiel | 3e8249c | 2022-06-03 14:05:07 +0200 | [diff] [blame] | 180 | #if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \ | 
|  | 181 | defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \ | 
|  | 182 | defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND) | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 183 | typedef struct { | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 184 | uint8_t *MBEDTLS_PRIVATE(info); | 
|  | 185 | size_t MBEDTLS_PRIVATE(info_length); | 
| Gilles Peskine | bef7f14 | 2018-07-12 17:22:21 +0200 | [diff] [blame] | 186 | #if PSA_HASH_MAX_SIZE > 0xff | 
|  | 187 | #error "PSA_HASH_MAX_SIZE does not fit in uint8_t" | 
|  | 188 | #endif | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 189 | uint8_t MBEDTLS_PRIVATE(offset_in_block); | 
|  | 190 | uint8_t MBEDTLS_PRIVATE(block_number); | 
|  | 191 | unsigned int MBEDTLS_PRIVATE(state) : 2; | 
|  | 192 | unsigned int MBEDTLS_PRIVATE(info_set) : 1; | 
| Gilles Peskine | e3d9c9d | 2021-11-08 22:12:47 +0100 | [diff] [blame] | 193 | uint8_t MBEDTLS_PRIVATE(output_block)[PSA_HASH_MAX_SIZE]; | 
|  | 194 | uint8_t MBEDTLS_PRIVATE(prk)[PSA_HASH_MAX_SIZE]; | 
|  | 195 | struct psa_mac_operation_s MBEDTLS_PRIVATE(hmac); | 
| Gilles Peskine | cbe6650 | 2019-05-16 16:59:18 +0200 | [diff] [blame] | 196 | } psa_hkdf_key_derivation_t; | 
| Przemek Stekiel | 3e8249c | 2022-06-03 14:05:07 +0200 | [diff] [blame] | 197 | #endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF || | 
|  | 198 | MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT || | 
|  | 199 | MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */ | 
| Andrzej Kurek | 08d34b8 | 2022-07-29 10:00:16 -0400 | [diff] [blame] | 200 | #if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 201 | typedef struct { | 
| Andrzej Kurek | 08d34b8 | 2022-07-29 10:00:16 -0400 | [diff] [blame] | 202 | uint8_t MBEDTLS_PRIVATE(data)[PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE]; | 
|  | 203 | } psa_tls12_ecjpake_to_pms_t; | 
|  | 204 | #endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */ | 
| Gilles Peskine | bef7f14 | 2018-07-12 17:22:21 +0200 | [diff] [blame] | 205 |  | 
| Steven Cooreman | ac8d82a | 2021-04-29 18:01:53 +0200 | [diff] [blame] | 206 | #if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \ | 
|  | 207 | defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 208 | typedef enum { | 
| Przemek Stekiel | c4b814a | 2022-04-07 12:28:08 +0200 | [diff] [blame] | 209 | PSA_TLS12_PRF_STATE_INIT,             /* no input provided */ | 
|  | 210 | PSA_TLS12_PRF_STATE_SEED_SET,         /* seed has been set */ | 
|  | 211 | PSA_TLS12_PRF_STATE_OTHER_KEY_SET,    /* other key has been set - optional */ | 
|  | 212 | PSA_TLS12_PRF_STATE_KEY_SET,          /* key has been set */ | 
|  | 213 | PSA_TLS12_PRF_STATE_LABEL_SET,        /* label has been set */ | 
|  | 214 | PSA_TLS12_PRF_STATE_OUTPUT            /* output has been started */ | 
| Janos Follath | 999f648 | 2019-06-11 12:04:10 +0100 | [diff] [blame] | 215 | } psa_tls12_prf_key_derivation_state_t; | 
|  | 216 |  | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 217 | typedef struct psa_tls12_prf_key_derivation_s { | 
| Janos Follath | 999f648 | 2019-06-11 12:04:10 +0100 | [diff] [blame] | 218 | #if PSA_HASH_MAX_SIZE > 0xff | 
|  | 219 | #error "PSA_HASH_MAX_SIZE does not fit in uint8_t" | 
|  | 220 | #endif | 
|  | 221 |  | 
|  | 222 | /* Indicates how many bytes in the current HMAC block have | 
| Janos Follath | 844eb0e | 2019-06-19 12:10:49 +0100 | [diff] [blame] | 223 | * not yet been read by the user. */ | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 224 | uint8_t MBEDTLS_PRIVATE(left_in_block); | 
| Janos Follath | 999f648 | 2019-06-11 12:04:10 +0100 | [diff] [blame] | 225 |  | 
|  | 226 | /* The 1-based number of the block. */ | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 227 | uint8_t MBEDTLS_PRIVATE(block_number); | 
| Janos Follath | 999f648 | 2019-06-11 12:04:10 +0100 | [diff] [blame] | 228 |  | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 229 | psa_tls12_prf_key_derivation_state_t MBEDTLS_PRIVATE(state); | 
| Janos Follath | 999f648 | 2019-06-11 12:04:10 +0100 | [diff] [blame] | 230 |  | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 231 | uint8_t *MBEDTLS_PRIVATE(secret); | 
|  | 232 | size_t MBEDTLS_PRIVATE(secret_length); | 
|  | 233 | uint8_t *MBEDTLS_PRIVATE(seed); | 
|  | 234 | size_t MBEDTLS_PRIVATE(seed_length); | 
|  | 235 | uint8_t *MBEDTLS_PRIVATE(label); | 
|  | 236 | size_t MBEDTLS_PRIVATE(label_length); | 
| Przemek Stekiel | 7f1c89d | 2022-04-19 14:00:37 +0200 | [diff] [blame] | 237 | #if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) | 
| Przemek Stekiel | f4e8f01 | 2022-04-07 12:23:31 +0200 | [diff] [blame] | 238 | uint8_t *MBEDTLS_PRIVATE(other_secret); | 
|  | 239 | size_t MBEDTLS_PRIVATE(other_secret_length); | 
| Przemek Stekiel | 7f1c89d | 2022-04-19 14:00:37 +0200 | [diff] [blame] | 240 | #endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */ | 
| Steven Cooreman | a6df604 | 2021-04-29 19:32:25 +0200 | [diff] [blame] | 241 |  | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 242 | uint8_t MBEDTLS_PRIVATE(Ai)[PSA_HASH_MAX_SIZE]; | 
| Janos Follath | 999f648 | 2019-06-11 12:04:10 +0100 | [diff] [blame] | 243 |  | 
| Janos Follath | 33434a9 | 2021-05-26 09:25:33 +0100 | [diff] [blame] | 244 | /* `HMAC_hash( prk, A( i ) + seed )` in the notation of RFC 5246, Sect. 5. */ | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 245 | uint8_t MBEDTLS_PRIVATE(output_block)[PSA_HASH_MAX_SIZE]; | 
| Janos Follath | 999f648 | 2019-06-11 12:04:10 +0100 | [diff] [blame] | 246 | } psa_tls12_prf_key_derivation_t; | 
| Steven Cooreman | ac8d82a | 2021-04-29 18:01:53 +0200 | [diff] [blame] | 247 | #endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || | 
|  | 248 | * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */ | 
| Hanno Becker | c8a41d7 | 2018-10-09 17:33:01 +0100 | [diff] [blame] | 249 |  | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 250 | struct psa_key_derivation_s { | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 251 | psa_algorithm_t MBEDTLS_PRIVATE(alg); | 
|  | 252 | unsigned int MBEDTLS_PRIVATE(can_output_key) : 1; | 
|  | 253 | size_t MBEDTLS_PRIVATE(capacity); | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 254 | union { | 
| Janos Follath | adbec81 | 2019-06-14 11:05:39 +0100 | [diff] [blame] | 255 | /* Make the union non-empty even with no supported algorithms. */ | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 256 | uint8_t MBEDTLS_PRIVATE(dummy); | 
| Przemek Stekiel | 3e8249c | 2022-06-03 14:05:07 +0200 | [diff] [blame] | 257 | #if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \ | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 258 | defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \ | 
|  | 259 | defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND) | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 260 | psa_hkdf_key_derivation_t MBEDTLS_PRIVATE(hkdf); | 
| Steven Cooreman | ac8d82a | 2021-04-29 18:01:53 +0200 | [diff] [blame] | 261 | #endif | 
|  | 262 | #if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \ | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 263 | defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 264 | psa_tls12_prf_key_derivation_t MBEDTLS_PRIVATE(tls12_prf); | 
| Gilles Peskine | bef7f14 | 2018-07-12 17:22:21 +0200 | [diff] [blame] | 265 | #endif | 
| Andrzej Kurek | 08d34b8 | 2022-07-29 10:00:16 -0400 | [diff] [blame] | 266 | #if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) | 
|  | 267 | psa_tls12_ecjpake_to_pms_t MBEDTLS_PRIVATE(tls12_ecjpake_to_pms); | 
|  | 268 | #endif | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 269 | } MBEDTLS_PRIVATE(ctx); | 
| Gilles Peskine | eab56e4 | 2018-07-12 17:12:33 +0200 | [diff] [blame] | 270 | }; | 
|  | 271 |  | 
| Janos Follath | adbec81 | 2019-06-14 11:05:39 +0100 | [diff] [blame] | 272 | /* This only zeroes out the first byte in the union, the rest is unspecified. */ | 
| Janos Follath | 33434a9 | 2021-05-26 09:25:33 +0100 | [diff] [blame] | 273 | #define PSA_KEY_DERIVATION_OPERATION_INIT { 0, 0, 0, { 0 } } | 
| Janos Follath | 0dcda95 | 2021-06-07 14:52:13 +0100 | [diff] [blame] | 274 | static inline struct psa_key_derivation_s psa_key_derivation_operation_init( | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 275 | void) | 
| Gilles Peskine | eab56e4 | 2018-07-12 17:12:33 +0200 | [diff] [blame] | 276 | { | 
| Gilles Peskine | cbe6650 | 2019-05-16 16:59:18 +0200 | [diff] [blame] | 277 | const struct psa_key_derivation_s v = PSA_KEY_DERIVATION_OPERATION_INIT; | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 278 | return v; | 
| Gilles Peskine | eab56e4 | 2018-07-12 17:12:33 +0200 | [diff] [blame] | 279 | } | 
|  | 280 |  | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 281 | struct psa_key_policy_s { | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 282 | psa_key_usage_t MBEDTLS_PRIVATE(usage); | 
|  | 283 | psa_algorithm_t MBEDTLS_PRIVATE(alg); | 
|  | 284 | psa_algorithm_t MBEDTLS_PRIVATE(alg2); | 
| Gilles Peskine | 7698bcf | 2018-03-03 21:30:44 +0100 | [diff] [blame] | 285 | }; | 
| Gilles Peskine | a3dd737 | 2019-04-19 19:42:26 +0200 | [diff] [blame] | 286 | typedef struct psa_key_policy_s psa_key_policy_t; | 
| Gilles Peskine | 7698bcf | 2018-03-03 21:30:44 +0100 | [diff] [blame] | 287 |  | 
| Janos Follath | 33434a9 | 2021-05-26 09:25:33 +0100 | [diff] [blame] | 288 | #define PSA_KEY_POLICY_INIT { 0, 0, 0 } | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 289 | static inline struct psa_key_policy_s psa_key_policy_init(void) | 
| Jaeden Amero | 70261c5 | 2019-01-04 11:47:20 +0000 | [diff] [blame] | 290 | { | 
|  | 291 | const struct psa_key_policy_s v = PSA_KEY_POLICY_INIT; | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 292 | return v; | 
| Jaeden Amero | 70261c5 | 2019-01-04 11:47:20 +0000 | [diff] [blame] | 293 | } | 
|  | 294 |  | 
| Gilles Peskine | 68cc433b | 2019-07-30 17:42:47 +0200 | [diff] [blame] | 295 | /* The type used internally for key sizes. | 
|  | 296 | * Public interfaces use size_t, but internally we use a smaller type. */ | 
|  | 297 | typedef uint16_t psa_key_bits_t; | 
|  | 298 | /* The maximum value of the type used to represent bit-sizes. | 
|  | 299 | * This is used to mark an invalid key size. */ | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 300 | #define PSA_KEY_BITS_TOO_LARGE          ((psa_key_bits_t) -1) | 
| Gilles Peskine | c744d99 | 2019-07-30 17:26:54 +0200 | [diff] [blame] | 301 | /* The maximum size of a key in bits. | 
| Gilles Peskine | 68cc433b | 2019-07-30 17:42:47 +0200 | [diff] [blame] | 302 | * Currently defined as the maximum that can be represented, rounded down | 
|  | 303 | * to a whole number of bytes. | 
|  | 304 | * This is an uncast value so that it can be used in preprocessor | 
|  | 305 | * conditionals. */ | 
| Gilles Peskine | c744d99 | 2019-07-30 17:26:54 +0200 | [diff] [blame] | 306 | #define PSA_MAX_KEY_BITS 0xfff8 | 
|  | 307 |  | 
| Gilles Peskine | 91e8c33 | 2019-08-02 19:19:39 +0200 | [diff] [blame] | 308 | /** A mask of flags that can be stored in key attributes. | 
|  | 309 | * | 
|  | 310 | * This type is also used internally to store flags in slots. Internal | 
|  | 311 | * flags are defined in library/psa_crypto_core.h. Internal flags may have | 
|  | 312 | * the same value as external flags if they are properly handled during | 
|  | 313 | * key creation and in psa_get_key_attributes. | 
|  | 314 | */ | 
|  | 315 | typedef uint16_t psa_key_attributes_flag_t; | 
|  | 316 |  | 
| Gilles Peskine | c8000c0 | 2019-08-02 20:15:51 +0200 | [diff] [blame] | 317 | #define MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER     \ | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 318 | ((psa_key_attributes_flag_t) 0x0001) | 
| Gilles Peskine | 91e8c33 | 2019-08-02 19:19:39 +0200 | [diff] [blame] | 319 |  | 
|  | 320 | /* A mask of key attribute flags used externally only. | 
|  | 321 | * Only meant for internal checks inside the library. */ | 
|  | 322 | #define MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY (      \ | 
| Gilles Peskine | c8000c0 | 2019-08-02 20:15:51 +0200 | [diff] [blame] | 323 | MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER |    \ | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 324 | 0) | 
| Gilles Peskine | 91e8c33 | 2019-08-02 19:19:39 +0200 | [diff] [blame] | 325 |  | 
|  | 326 | /* A mask of key attribute flags used both internally and externally. | 
|  | 327 | * Currently there aren't any. */ | 
|  | 328 | #define MBEDTLS_PSA_KA_MASK_DUAL_USE (          \ | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 329 | 0) | 
| Gilles Peskine | 91e8c33 | 2019-08-02 19:19:39 +0200 | [diff] [blame] | 330 |  | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 331 | typedef struct { | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 332 | psa_key_type_t MBEDTLS_PRIVATE(type); | 
|  | 333 | psa_key_bits_t MBEDTLS_PRIVATE(bits); | 
|  | 334 | psa_key_lifetime_t MBEDTLS_PRIVATE(lifetime); | 
|  | 335 | mbedtls_svc_key_id_t MBEDTLS_PRIVATE(id); | 
|  | 336 | psa_key_policy_t MBEDTLS_PRIVATE(policy); | 
|  | 337 | psa_key_attributes_flag_t MBEDTLS_PRIVATE(flags); | 
| Gilles Peskine | 7e0cff9 | 2019-07-30 13:48:52 +0200 | [diff] [blame] | 338 | } psa_core_key_attributes_t; | 
|  | 339 |  | 
| Janos Follath | 33434a9 | 2021-05-26 09:25:33 +0100 | [diff] [blame] | 340 | #define PSA_CORE_KEY_ATTRIBUTES_INIT { PSA_KEY_TYPE_NONE, 0,            \ | 
|  | 341 | PSA_KEY_LIFETIME_VOLATILE,       \ | 
|  | 342 | MBEDTLS_SVC_KEY_ID_INIT,         \ | 
|  | 343 | PSA_KEY_POLICY_INIT, 0 } | 
| Gilles Peskine | 7e0cff9 | 2019-07-30 13:48:52 +0200 | [diff] [blame] | 344 |  | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 345 | struct psa_key_attributes_s { | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 346 | psa_core_key_attributes_t MBEDTLS_PRIVATE(core); | 
| Gilles Peskine | c8000c0 | 2019-08-02 20:15:51 +0200 | [diff] [blame] | 347 | #if defined(MBEDTLS_PSA_CRYPTO_SE_C) | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 348 | psa_key_slot_number_t MBEDTLS_PRIVATE(slot_number); | 
| Gilles Peskine | c8000c0 | 2019-08-02 20:15:51 +0200 | [diff] [blame] | 349 | #endif /* MBEDTLS_PSA_CRYPTO_SE_C */ | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 350 | void *MBEDTLS_PRIVATE(domain_parameters); | 
|  | 351 | size_t MBEDTLS_PRIVATE(domain_parameters_size); | 
| Gilles Peskine | 4747d19 | 2019-04-17 15:05:45 +0200 | [diff] [blame] | 352 | }; | 
|  | 353 |  | 
| Gilles Peskine | c8000c0 | 2019-08-02 20:15:51 +0200 | [diff] [blame] | 354 | #if defined(MBEDTLS_PSA_CRYPTO_SE_C) | 
| Janos Follath | 33434a9 | 2021-05-26 09:25:33 +0100 | [diff] [blame] | 355 | #define PSA_KEY_ATTRIBUTES_INIT { PSA_CORE_KEY_ATTRIBUTES_INIT, 0, NULL, 0 } | 
| Gilles Peskine | c8000c0 | 2019-08-02 20:15:51 +0200 | [diff] [blame] | 356 | #else | 
| Janos Follath | 33434a9 | 2021-05-26 09:25:33 +0100 | [diff] [blame] | 357 | #define PSA_KEY_ATTRIBUTES_INIT { PSA_CORE_KEY_ATTRIBUTES_INIT, NULL, 0 } | 
| Gilles Peskine | c8000c0 | 2019-08-02 20:15:51 +0200 | [diff] [blame] | 358 | #endif | 
|  | 359 |  | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 360 | static inline struct psa_key_attributes_s psa_key_attributes_init(void) | 
| Gilles Peskine | 4747d19 | 2019-04-17 15:05:45 +0200 | [diff] [blame] | 361 | { | 
|  | 362 | const struct psa_key_attributes_s v = PSA_KEY_ATTRIBUTES_INIT; | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 363 | return v; | 
| Gilles Peskine | 4747d19 | 2019-04-17 15:05:45 +0200 | [diff] [blame] | 364 | } | 
|  | 365 |  | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 366 | static inline void psa_set_key_id(psa_key_attributes_t *attributes, | 
|  | 367 | mbedtls_svc_key_id_t key) | 
| Gilles Peskine | dc8219a | 2019-05-15 16:11:15 +0200 | [diff] [blame] | 368 | { | 
| Mateusz Starzyk | 363eb29 | 2021-05-19 17:32:44 +0200 | [diff] [blame] | 369 | psa_key_lifetime_t lifetime = attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(lifetime); | 
| Ronald Cron | d98059d | 2020-10-23 18:00:55 +0200 | [diff] [blame] | 370 |  | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 371 | attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(id) = key; | 
| Ronald Cron | d98059d | 2020-10-23 18:00:55 +0200 | [diff] [blame] | 372 |  | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 373 | if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) { | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 374 | attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(lifetime) = | 
| Ronald Cron | d98059d | 2020-10-23 18:00:55 +0200 | [diff] [blame] | 375 | PSA_KEY_LIFETIME_FROM_PERSISTENCE_AND_LOCATION( | 
|  | 376 | PSA_KEY_LIFETIME_PERSISTENT, | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 377 | PSA_KEY_LIFETIME_GET_LOCATION(lifetime)); | 
| Ronald Cron | d98059d | 2020-10-23 18:00:55 +0200 | [diff] [blame] | 378 | } | 
| Gilles Peskine | dc8219a | 2019-05-15 16:11:15 +0200 | [diff] [blame] | 379 | } | 
|  | 380 |  | 
| Ronald Cron | 71016a9 | 2020-08-28 19:01:50 +0200 | [diff] [blame] | 381 | static inline mbedtls_svc_key_id_t psa_get_key_id( | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 382 | const psa_key_attributes_t *attributes) | 
| Gilles Peskine | db4b3ab | 2019-04-18 12:53:01 +0200 | [diff] [blame] | 383 | { | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 384 | return attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(id); | 
| Gilles Peskine | db4b3ab | 2019-04-18 12:53:01 +0200 | [diff] [blame] | 385 | } | 
|  | 386 |  | 
| Ronald Cron | 6b5ff53 | 2020-10-16 14:38:19 +0200 | [diff] [blame] | 387 | #ifdef MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 388 | static inline void mbedtls_set_key_owner_id(psa_key_attributes_t *attributes, | 
|  | 389 | mbedtls_key_owner_id_t owner) | 
| Ronald Cron | 6b5ff53 | 2020-10-16 14:38:19 +0200 | [diff] [blame] | 390 | { | 
| Mateusz Starzyk | 363eb29 | 2021-05-19 17:32:44 +0200 | [diff] [blame] | 391 | attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(id).MBEDTLS_PRIVATE(owner) = owner; | 
| Ronald Cron | 6b5ff53 | 2020-10-16 14:38:19 +0200 | [diff] [blame] | 392 | } | 
|  | 393 | #endif | 
|  | 394 |  | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 395 | static inline void psa_set_key_lifetime(psa_key_attributes_t *attributes, | 
|  | 396 | psa_key_lifetime_t lifetime) | 
| Gilles Peskine | dc8219a | 2019-05-15 16:11:15 +0200 | [diff] [blame] | 397 | { | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 398 | attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(lifetime) = lifetime; | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 399 | if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) { | 
| Ronald Cron | 71016a9 | 2020-08-28 19:01:50 +0200 | [diff] [blame] | 400 | #ifdef MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER | 
| Mateusz Starzyk | 363eb29 | 2021-05-19 17:32:44 +0200 | [diff] [blame] | 401 | attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(id).MBEDTLS_PRIVATE(key_id) = 0; | 
| Jaeden Amero | e3cdf28 | 2019-08-20 12:58:20 +0100 | [diff] [blame] | 402 | #else | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 403 | attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(id) = 0; | 
| Jaeden Amero | e3cdf28 | 2019-08-20 12:58:20 +0100 | [diff] [blame] | 404 | #endif | 
|  | 405 | } | 
| Gilles Peskine | dc8219a | 2019-05-15 16:11:15 +0200 | [diff] [blame] | 406 | } | 
|  | 407 |  | 
| Gilles Peskine | db4b3ab | 2019-04-18 12:53:01 +0200 | [diff] [blame] | 408 | static inline psa_key_lifetime_t psa_get_key_lifetime( | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 409 | const psa_key_attributes_t *attributes) | 
| Gilles Peskine | db4b3ab | 2019-04-18 12:53:01 +0200 | [diff] [blame] | 410 | { | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 411 | return attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(lifetime); | 
| Gilles Peskine | db4b3ab | 2019-04-18 12:53:01 +0200 | [diff] [blame] | 412 | } | 
|  | 413 |  | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 414 | static inline void psa_extend_key_usage_flags(psa_key_usage_t *usage_flags) | 
| Gilles Peskine | 4747d19 | 2019-04-17 15:05:45 +0200 | [diff] [blame] | 415 | { | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 416 | if (*usage_flags & PSA_KEY_USAGE_SIGN_HASH) { | 
| gabor-mezei-arm | 43110b6 | 2021-06-23 16:48:08 +0200 | [diff] [blame] | 417 | *usage_flags |= PSA_KEY_USAGE_SIGN_MESSAGE; | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 418 | } | 
| gabor-mezei-arm | 86bf008 | 2021-04-29 15:57:57 +0200 | [diff] [blame] | 419 |  | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 420 | if (*usage_flags & PSA_KEY_USAGE_VERIFY_HASH) { | 
| gabor-mezei-arm | 43110b6 | 2021-06-23 16:48:08 +0200 | [diff] [blame] | 421 | *usage_flags |= PSA_KEY_USAGE_VERIFY_MESSAGE; | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 422 | } | 
| Gilles Peskine | 4747d19 | 2019-04-17 15:05:45 +0200 | [diff] [blame] | 423 | } | 
|  | 424 |  | 
|  | 425 | static inline void psa_set_key_usage_flags(psa_key_attributes_t *attributes, | 
|  | 426 | psa_key_usage_t usage_flags) | 
|  | 427 | { | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 428 | psa_extend_key_usage_flags(&usage_flags); | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 429 | attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(policy).MBEDTLS_PRIVATE(usage) = usage_flags; | 
| Gilles Peskine | 4747d19 | 2019-04-17 15:05:45 +0200 | [diff] [blame] | 430 | } | 
|  | 431 |  | 
|  | 432 | static inline psa_key_usage_t psa_get_key_usage_flags( | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 433 | const psa_key_attributes_t *attributes) | 
| Gilles Peskine | 4747d19 | 2019-04-17 15:05:45 +0200 | [diff] [blame] | 434 | { | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 435 | return attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(policy).MBEDTLS_PRIVATE(usage); | 
| Gilles Peskine | 4747d19 | 2019-04-17 15:05:45 +0200 | [diff] [blame] | 436 | } | 
|  | 437 |  | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 438 | static inline void psa_set_key_algorithm(psa_key_attributes_t *attributes, | 
|  | 439 | psa_algorithm_t alg) | 
| Gilles Peskine | 4747d19 | 2019-04-17 15:05:45 +0200 | [diff] [blame] | 440 | { | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 441 | attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(policy).MBEDTLS_PRIVATE(alg) = alg; | 
| Gilles Peskine | 4747d19 | 2019-04-17 15:05:45 +0200 | [diff] [blame] | 442 | } | 
|  | 443 |  | 
|  | 444 | static inline psa_algorithm_t psa_get_key_algorithm( | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 445 | const psa_key_attributes_t *attributes) | 
| Gilles Peskine | 4747d19 | 2019-04-17 15:05:45 +0200 | [diff] [blame] | 446 | { | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 447 | return attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(policy).MBEDTLS_PRIVATE(alg); | 
| Gilles Peskine | 4747d19 | 2019-04-17 15:05:45 +0200 | [diff] [blame] | 448 | } | 
|  | 449 |  | 
| Gilles Peskine | 24f10f8 | 2019-05-16 12:18:32 +0200 | [diff] [blame] | 450 | /* This function is declared in crypto_extra.h, which comes after this | 
|  | 451 | * header file, but we need the function here, so repeat the declaration. */ | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 452 | psa_status_t psa_set_key_domain_parameters(psa_key_attributes_t *attributes, | 
| Gilles Peskine | 24f10f8 | 2019-05-16 12:18:32 +0200 | [diff] [blame] | 453 | psa_key_type_t type, | 
|  | 454 | const uint8_t *data, | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 455 | size_t data_length); | 
| Gilles Peskine | 24f10f8 | 2019-05-16 12:18:32 +0200 | [diff] [blame] | 456 |  | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 457 | static inline void psa_set_key_type(psa_key_attributes_t *attributes, | 
|  | 458 | psa_key_type_t type) | 
| Gilles Peskine | 4747d19 | 2019-04-17 15:05:45 +0200 | [diff] [blame] | 459 | { | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 460 | if (attributes->MBEDTLS_PRIVATE(domain_parameters) == NULL) { | 
| Gilles Peskine | b699f07 | 2019-04-26 16:06:02 +0200 | [diff] [blame] | 461 | /* Common case: quick path */ | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 462 | attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(type) = type; | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 463 | } else { | 
| Shaun Case | 8b0ecbc | 2021-12-20 21:14:10 -0800 | [diff] [blame] | 464 | /* Call the bigger function to free the old domain parameters. | 
| Gilles Peskine | b699f07 | 2019-04-26 16:06:02 +0200 | [diff] [blame] | 465 | * Ignore any errors which may arise due to type requiring | 
|  | 466 | * non-default domain parameters, since this function can't | 
|  | 467 | * report errors. */ | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 468 | (void) psa_set_key_domain_parameters(attributes, type, NULL, 0); | 
| Gilles Peskine | b699f07 | 2019-04-26 16:06:02 +0200 | [diff] [blame] | 469 | } | 
| Gilles Peskine | 4747d19 | 2019-04-17 15:05:45 +0200 | [diff] [blame] | 470 | } | 
|  | 471 |  | 
|  | 472 | static inline psa_key_type_t psa_get_key_type( | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 473 | const psa_key_attributes_t *attributes) | 
| Gilles Peskine | 4747d19 | 2019-04-17 15:05:45 +0200 | [diff] [blame] | 474 | { | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 475 | return attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(type); | 
| Gilles Peskine | 4747d19 | 2019-04-17 15:05:45 +0200 | [diff] [blame] | 476 | } | 
|  | 477 |  | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 478 | static inline void psa_set_key_bits(psa_key_attributes_t *attributes, | 
|  | 479 | size_t bits) | 
| Gilles Peskine | 3a4f1f8 | 2019-04-26 13:49:28 +0200 | [diff] [blame] | 480 | { | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 481 | if (bits > PSA_MAX_KEY_BITS) { | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 482 | attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(bits) = PSA_KEY_BITS_TOO_LARGE; | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 483 | } else { | 
| Mateusz Starzyk | 846f021 | 2021-05-19 19:44:07 +0200 | [diff] [blame] | 484 | attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(bits) = (psa_key_bits_t) bits; | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 485 | } | 
| Gilles Peskine | 3a4f1f8 | 2019-04-26 13:49:28 +0200 | [diff] [blame] | 486 | } | 
|  | 487 |  | 
| Gilles Peskine | db4b3ab | 2019-04-18 12:53:01 +0200 | [diff] [blame] | 488 | static inline size_t psa_get_key_bits( | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 489 | const psa_key_attributes_t *attributes) | 
| Gilles Peskine | db4b3ab | 2019-04-18 12:53:01 +0200 | [diff] [blame] | 490 | { | 
| Gilles Peskine | 449bd83 | 2023-01-11 14:50:10 +0100 | [diff] [blame] | 491 | return attributes->MBEDTLS_PRIVATE(core).MBEDTLS_PRIVATE(bits); | 
| Gilles Peskine | db4b3ab | 2019-04-18 12:53:01 +0200 | [diff] [blame] | 492 | } | 
|  | 493 |  | 
| Paul Elliott | 1265f00 | 2022-09-09 17:15:43 +0100 | [diff] [blame] | 494 | /** | 
|  | 495 | * \brief The context for PSA interruptible hash signing. | 
| Paul Elliott | 1265f00 | 2022-09-09 17:15:43 +0100 | [diff] [blame] | 496 | */ | 
|  | 497 | struct psa_sign_hash_interruptible_operation_s { | 
| Paul Elliott | 2d24792 | 2022-11-29 14:54:44 +0000 | [diff] [blame] | 498 | /** Unique ID indicating which driver got assigned to do the | 
|  | 499 | * operation. Since driver contexts are driver-specific, swapping | 
|  | 500 | * drivers halfway through the operation is not supported. | 
|  | 501 | * ID values are auto-generated in psa_crypto_driver_wrappers.h | 
|  | 502 | * ID value zero means the context is not valid or not assigned to | 
|  | 503 | * any driver (i.e. none of the driver contexts are active). */ | 
|  | 504 | unsigned int MBEDTLS_PRIVATE(id); | 
|  | 505 |  | 
| Paul Elliott | 588f8ed | 2022-12-02 18:10:26 +0000 | [diff] [blame] | 506 | psa_driver_sign_hash_interruptible_context_t MBEDTLS_PRIVATE(ctx); | 
|  | 507 |  | 
| Paul Elliott | c977441 | 2023-02-06 15:14:07 +0000 | [diff] [blame] | 508 | unsigned int MBEDTLS_PRIVATE(error_occurred) : 1; | 
|  | 509 |  | 
| Paul Elliott | 296ede9 | 2022-12-15 17:00:30 +0000 | [diff] [blame] | 510 | uint32_t MBEDTLS_PRIVATE(num_ops); | 
| Paul Elliott | 1265f00 | 2022-09-09 17:15:43 +0100 | [diff] [blame] | 511 | }; | 
|  | 512 |  | 
| Paul Elliott | c977441 | 2023-02-06 15:14:07 +0000 | [diff] [blame] | 513 | #define PSA_SIGN_HASH_INTERRUPTIBLE_OPERATION_INIT { 0, { 0 }, 0, 0 } | 
| Paul Elliott | 1265f00 | 2022-09-09 17:15:43 +0100 | [diff] [blame] | 514 |  | 
|  | 515 | static inline struct psa_sign_hash_interruptible_operation_s | 
|  | 516 | psa_sign_hash_interruptible_operation_init(void) | 
|  | 517 | { | 
|  | 518 | const struct psa_sign_hash_interruptible_operation_s v = | 
|  | 519 | PSA_SIGN_HASH_INTERRUPTIBLE_OPERATION_INIT; | 
|  | 520 |  | 
|  | 521 | return v; | 
|  | 522 | } | 
|  | 523 |  | 
|  | 524 | /** | 
|  | 525 | * \brief The context for PSA interruptible hash verification. | 
| Paul Elliott | 1265f00 | 2022-09-09 17:15:43 +0100 | [diff] [blame] | 526 | */ | 
|  | 527 | struct psa_verify_hash_interruptible_operation_s { | 
| Paul Elliott | 2d24792 | 2022-11-29 14:54:44 +0000 | [diff] [blame] | 528 | /** Unique ID indicating which driver got assigned to do the | 
|  | 529 | * operation. Since driver contexts are driver-specific, swapping | 
|  | 530 | * drivers halfway through the operation is not supported. | 
|  | 531 | * ID values are auto-generated in psa_crypto_driver_wrappers.h | 
|  | 532 | * ID value zero means the context is not valid or not assigned to | 
|  | 533 | * any driver (i.e. none of the driver contexts are active). */ | 
|  | 534 | unsigned int MBEDTLS_PRIVATE(id); | 
|  | 535 |  | 
| Paul Elliott | 588f8ed | 2022-12-02 18:10:26 +0000 | [diff] [blame] | 536 | psa_driver_verify_hash_interruptible_context_t MBEDTLS_PRIVATE(ctx); | 
|  | 537 |  | 
| Paul Elliott | c977441 | 2023-02-06 15:14:07 +0000 | [diff] [blame] | 538 | unsigned int MBEDTLS_PRIVATE(error_occurred) : 1; | 
|  | 539 |  | 
| Paul Elliott | 296ede9 | 2022-12-15 17:00:30 +0000 | [diff] [blame] | 540 | uint32_t MBEDTLS_PRIVATE(num_ops); | 
| Paul Elliott | 1265f00 | 2022-09-09 17:15:43 +0100 | [diff] [blame] | 541 | }; | 
|  | 542 |  | 
| Paul Elliott | c977441 | 2023-02-06 15:14:07 +0000 | [diff] [blame] | 543 | #define PSA_VERIFY_HASH_INTERRUPTIBLE_OPERATION_INIT { 0, { 0 }, 0, 0 } | 
| Paul Elliott | 1265f00 | 2022-09-09 17:15:43 +0100 | [diff] [blame] | 544 |  | 
|  | 545 | static inline struct psa_verify_hash_interruptible_operation_s | 
|  | 546 | psa_verify_hash_interruptible_operation_init(void) | 
|  | 547 | { | 
|  | 548 | const struct psa_verify_hash_interruptible_operation_s v = | 
|  | 549 | PSA_VERIFY_HASH_INTERRUPTIBLE_OPERATION_INIT; | 
|  | 550 |  | 
|  | 551 | return v; | 
|  | 552 | } | 
|  | 553 |  | 
| Jaeden Amero | 8013f44 | 2019-08-16 16:13:51 +0100 | [diff] [blame] | 554 | #ifdef __cplusplus | 
|  | 555 | } | 
|  | 556 | #endif | 
|  | 557 |  | 
| Gilles Peskine | 9ef733f | 2018-02-07 21:05:37 +0100 | [diff] [blame] | 558 | #endif /* PSA_CRYPTO_STRUCT_H */ |