blob: 2b09d8f7566effea7d11d18f7733878004bedb82 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Dave Rodgman7ff79652023-11-03 12:04:52 +00006 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskinee59236f2018-01-27 23:32:46 +01007 */
8
Gilles Peskinedb09ef62020-06-03 01:43:33 +02009#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010010
11#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030012
John Durkop07cc04a2020-11-16 22:08:34 -080013#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
14#include "check_crypto_config.h"
15#endif
16
Gilles Peskinee59236f2018-01-27 23:32:46 +010017#include "psa/crypto.h"
18
Ronald Crond6d28882020-12-14 14:56:02 +010019#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010020#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010021#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020022#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010023#include "psa_crypto_ecp.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010024#include "psa_crypto_hash.h"
Steven Cooreman32d56942021-03-19 17:39:17 +010025#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010026#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010027#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020028#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020029#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020030#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010031#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010032/* Include internal declarations that are useful for implementing persistently
33 * stored keys. */
34#include "psa_crypto_storage.h"
35
Gilles Peskineb2b64d32020-12-14 16:43:58 +010036#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010037
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010038#include <stdlib.h>
39#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010040#include "mbedtls/platform.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010041
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010042#include "mbedtls/aes.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010043#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020044#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000045#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020046#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010047#include "mbedtls/blowfish.h"
48#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020049#include "mbedtls/chacha20.h"
50#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010051#include "mbedtls/cipher.h"
52#include "mbedtls/ccm.h"
53#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010054#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020055#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010056#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010057#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010058#include "mbedtls/error.h"
59#include "mbedtls/gcm.h"
60#include "mbedtls/md2.h"
61#include "mbedtls/md4.h"
62#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010063#include "mbedtls/md.h"
64#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010065#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010066#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010067#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000068#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010069#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010070#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010071#include "mbedtls/sha1.h"
72#include "mbedtls/sha256.h"
73#include "mbedtls/sha512.h"
74#include "mbedtls/xtea.h"
75
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010076#define ARRAY_LENGTH(array) (sizeof(array) / sizeof(*(array)))
Gilles Peskine996deb12018-08-01 15:45:45 +020077
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010078/****************************************************************/
79/* Global data, support functions and library management */
80/****************************************************************/
81
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010082static int key_type_is_raw_bytes(psa_key_type_t type)
Gilles Peskine48c0ea12018-06-21 14:15:31 +020083{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010084 return PSA_KEY_TYPE_IS_UNSTRUCTURED(type);
Gilles Peskine48c0ea12018-06-21 14:15:31 +020085}
86
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010087/* Values for psa_global_data_t::rng_state */
88#define RNG_NOT_INITIALIZED 0
89#define RNG_INITIALIZED 1
90#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +010091
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010092typedef struct {
Gilles Peskinec6b69072018-11-20 21:42:52 +010093 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010094 unsigned rng_state : 2;
Gilles Peskineb8006a62021-11-08 22:20:03 +010095 mbedtls_psa_random_context_t rng;
Gilles Peskinee59236f2018-01-27 23:32:46 +010096} psa_global_data_t;
97
98static psa_global_data_t global_data;
99
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100100#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
101mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
102 &global_data.rng.drbg;
103#endif
104
itayzafrir0adf0fc2018-09-06 16:24:41 +0300105#define GUARD_MODULE_INITIALIZED \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100106 if (global_data.initialized == 0) \
107 return PSA_ERROR_BAD_STATE;
itayzafrir0adf0fc2018-09-06 16:24:41 +0300108
David Horstmannc0a2c302023-11-29 17:24:08 +0000109#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
David Horstmann926193a2023-12-13 15:55:25 +0000110
David Horstmannb80e35a2023-12-14 18:12:47 +0000111/* Declare a local copy of an input buffer and a variable that will be used
112 * to store a pointer to the start of the buffer.
David Horstmann926193a2023-12-13 15:55:25 +0000113 *
114 * Note: This macro must be called before any operations which may jump to
115 * the exit label, so that the local input copy object is safe to be freed.
116 *
117 * Assumptions:
118 * - input is the name of a pointer to the buffer to be copied
119 * - The name LOCAL_INPUT_COPY_OF_input is unused in the current scope
David Horstmannb80e35a2023-12-14 18:12:47 +0000120 * - input_copy_name is a name that is unused in the current scope
David Horstmann926193a2023-12-13 15:55:25 +0000121 */
David Horstmannb80e35a2023-12-14 18:12:47 +0000122#define LOCAL_INPUT_DECLARE(input, input_copy_name) \
123 psa_crypto_local_input_t LOCAL_INPUT_COPY_OF_##input = PSA_CRYPTO_LOCAL_INPUT_INIT; \
124 const uint8_t *input_copy_name = NULL;
David Horstmann926193a2023-12-13 15:55:25 +0000125
David Horstmannb80e35a2023-12-14 18:12:47 +0000126/* Allocate a copy of the buffer input and set the pointer input_copy to
127 * point to the start of the copy.
David Horstmann926193a2023-12-13 15:55:25 +0000128 *
David Horstmann34980bd2023-11-29 17:07:13 +0000129 * Assumptions:
130 * - psa_status_t status exists
131 * - An exit label is declared
David Horstmann926193a2023-12-13 15:55:25 +0000132 * - input is the name of a pointer to the buffer to be copied
David Horstmannb80e35a2023-12-14 18:12:47 +0000133 * - LOCAL_INPUT_DECLARE(input, input_copy) has previously been called
David Horstmann34980bd2023-11-29 17:07:13 +0000134 */
David Horstmannb80e35a2023-12-14 18:12:47 +0000135#define LOCAL_INPUT_ALLOC(input, length, input_copy) \
David Horstmann926193a2023-12-13 15:55:25 +0000136 status = psa_crypto_local_input_alloc(input, length, \
137 &LOCAL_INPUT_COPY_OF_##input); \
David Horstmann34980bd2023-11-29 17:07:13 +0000138 if (status != PSA_SUCCESS) { \
139 goto exit; \
140 } \
David Horstmannb80e35a2023-12-14 18:12:47 +0000141 input_copy = LOCAL_INPUT_COPY_OF_##input.buffer;
David Horstmann34980bd2023-11-29 17:07:13 +0000142
David Horstmann926193a2023-12-13 15:55:25 +0000143/* Free the local input copy allocated previously by LOCAL_INPUT_ALLOC()
144 *
David Horstmann1f532132023-12-08 14:08:18 +0000145 * Assumptions:
David Horstmannb80e35a2023-12-14 18:12:47 +0000146 * - input_copy is the name of the input copy pointer set by LOCAL_INPUT_ALLOC()
David Horstmann926193a2023-12-13 15:55:25 +0000147 * - input is the name of the original buffer that was copied
David Horstmann1f532132023-12-08 14:08:18 +0000148 */
David Horstmannb80e35a2023-12-14 18:12:47 +0000149#define LOCAL_INPUT_FREE(input, input_copy) \
150 input_copy = NULL; \
David Horstmann926193a2023-12-13 15:55:25 +0000151 psa_crypto_local_input_free(&LOCAL_INPUT_COPY_OF_##input);
David Horstmann34980bd2023-11-29 17:07:13 +0000152
David Horstmannb80e35a2023-12-14 18:12:47 +0000153/* Declare a local copy of an output buffer and a variable that will be used
154 * to store a pointer to the start of the buffer.
David Horstmann926193a2023-12-13 15:55:25 +0000155 *
156 * Note: This macro must be called before any operations which may jump to
157 * the exit label, so that the local output copy object is safe to be freed.
158 *
159 * Assumptions:
160 * - output is the name of a pointer to the buffer to be copied
161 * - The name LOCAL_OUTPUT_COPY_OF_output is unused in the current scope
David Horstmannb80e35a2023-12-14 18:12:47 +0000162 * - output_copy_name is a name that is unused in the current scope
David Horstmann926193a2023-12-13 15:55:25 +0000163 */
David Horstmannb80e35a2023-12-14 18:12:47 +0000164#define LOCAL_OUTPUT_DECLARE(output, output_copy_name) \
165 psa_crypto_local_output_t LOCAL_OUTPUT_COPY_OF_##output = PSA_CRYPTO_LOCAL_OUTPUT_INIT; \
166 uint8_t *output_copy_name = NULL;
David Horstmann926193a2023-12-13 15:55:25 +0000167
David Horstmannb80e35a2023-12-14 18:12:47 +0000168/* Allocate a copy of the buffer output and set the pointer output_copy to
169 * point to the start of the copy.
David Horstmann926193a2023-12-13 15:55:25 +0000170 *
David Horstmann34980bd2023-11-29 17:07:13 +0000171 * Assumptions:
172 * - psa_status_t status exists
173 * - An exit label is declared
David Horstmann926193a2023-12-13 15:55:25 +0000174 * - output is the name of a pointer to the buffer to be copied
David Horstmannb80e35a2023-12-14 18:12:47 +0000175 * - LOCAL_OUTPUT_DECLARE(output, output_copy) has previously been called
David Horstmann34980bd2023-11-29 17:07:13 +0000176 */
David Horstmannb80e35a2023-12-14 18:12:47 +0000177#define LOCAL_OUTPUT_ALLOC(output, length, output_copy) \
David Horstmann926193a2023-12-13 15:55:25 +0000178 status = psa_crypto_local_output_alloc(output, length, \
179 &LOCAL_OUTPUT_COPY_OF_##output); \
David Horstmann34980bd2023-11-29 17:07:13 +0000180 if (status != PSA_SUCCESS) { \
181 goto exit; \
182 } \
David Horstmannb80e35a2023-12-14 18:12:47 +0000183 output_copy = LOCAL_OUTPUT_COPY_OF_##output.buffer;
David Horstmann34980bd2023-11-29 17:07:13 +0000184
Gabor Mezei3b0c3712024-01-24 13:07:17 +0100185/* Allocate a copy of the buffer output and set the pointer output_copy to
186 * point to the start of the copy.
187 *
188 * Assumptions:
189 * - psa_status_t status exists
190 * - An exit label is declared
191 * - output is the name of a pointer to the buffer to be copied
192 * - LOCAL_OUTPUT_DECLARE(output, output_copy) has previously been called
193 */
194#define LOCAL_OUTPUT_ALLOC_WITH_COPY(output, length, output_copy) \
195 status = psa_crypto_local_output_alloc_with_copy(output, length, \
196 &LOCAL_OUTPUT_COPY_OF_##output); \
197 if (status != PSA_SUCCESS) { \
198 goto exit; \
199 } \
200 output_copy = LOCAL_OUTPUT_COPY_OF_##output.buffer;
201
David Horstmannb80e35a2023-12-14 18:12:47 +0000202/* Free the local output copy allocated previously by LOCAL_OUTPUT_ALLOC()
David Horstmann1f532132023-12-08 14:08:18 +0000203 * after first copying back its contents to the original buffer.
David Horstmann926193a2023-12-13 15:55:25 +0000204 *
David Horstmann1f532132023-12-08 14:08:18 +0000205 * Assumptions:
David Horstmann1f532132023-12-08 14:08:18 +0000206 * - psa_status_t status exists
David Horstmannb80e35a2023-12-14 18:12:47 +0000207 * - output_copy is the name of the output copy pointer set by LOCAL_OUTPUT_ALLOC()
208 * - output is the name of the original buffer that was copied
David Horstmann1f532132023-12-08 14:08:18 +0000209 */
David Horstmannb80e35a2023-12-14 18:12:47 +0000210#define LOCAL_OUTPUT_FREE(output, output_copy) \
211 output_copy = NULL; \
David Horstmann2b70a662023-12-13 14:09:08 +0000212 do { \
213 psa_status_t local_output_status; \
David Horstmann926193a2023-12-13 15:55:25 +0000214 local_output_status = psa_crypto_local_output_free(&LOCAL_OUTPUT_COPY_OF_##output); \
David Horstmann2b70a662023-12-13 14:09:08 +0000215 if (local_output_status != PSA_SUCCESS) { \
216 /* Since this error case is an internal error, it's more serious than \
217 * any existing error code and so it's fine to overwrite the existing \
218 * status. */ \
219 status = local_output_status; \
220 } \
221 } while (0)
David Horstmannc0a2c302023-11-29 17:24:08 +0000222#else /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
David Horstmannb80e35a2023-12-14 18:12:47 +0000223#define LOCAL_INPUT_DECLARE(input, input_copy_name) \
224 const uint8_t *input_copy_name = NULL;
225#define LOCAL_INPUT_ALLOC(input, length, input_copy) \
226 input_copy = input;
227#define LOCAL_INPUT_FREE(input, input_copy) \
228 input_copy = NULL;
229#define LOCAL_OUTPUT_DECLARE(output, output_copy_name) \
230 uint8_t *output_copy_name = NULL;
231#define LOCAL_OUTPUT_ALLOC(output, length, output_copy) \
232 output_copy = output;
233#define LOCAL_OUTPUT_FREE(output, output_copy) \
234 output_copy = NULL;
David Horstmannc0a2c302023-11-29 17:24:08 +0000235#endif /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
David Horstmann34980bd2023-11-29 17:07:13 +0000236
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100237psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100238{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100239 /* Mbed TLS error codes can combine a high-level error code and a
240 * low-level error code. The low-level error usually reflects the
241 * root cause better, so dispatch on that preferably. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100242 int low_level_ret = -(-ret & 0x007f);
243 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100244 case 0:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100245 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100246
247 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
248 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
249 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100250 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100251 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100252 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100253
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200254 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100255 return PSA_ERROR_HARDWARE_FAILURE;
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200256
Gilles Peskine9a944802018-06-21 09:35:35 +0200257 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
258 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
259 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
260 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
261 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100262 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200263 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100264 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200265 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100266 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskine9a944802018-06-21 09:35:35 +0200267
Jaeden Amero93e21112019-02-20 13:57:28 +0000268#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000269 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000270#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
271 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
272#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100273 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100274 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100275 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100276 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100277
Jaeden Amero93e21112019-02-20 13:57:28 +0000278#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000279 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000280#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
281 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
282#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100283 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100284 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100285 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100286 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100287
288 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100289 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100290 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100291 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100292 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100293 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100294
Gilles Peskine26869f22019-05-06 15:25:00 +0200295 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100296 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine26869f22019-05-06 15:25:00 +0200297
298 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100299 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200300 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100301 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200302
Gilles Peskinea5905292018-02-07 20:59:33 +0100303 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100304 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100305 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100306 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100307 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100308 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100309 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100310 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100311 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100312 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100313 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100314 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100315 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100316 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100317 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100318 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100319
320 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100321 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100322
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100323#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
324 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100325 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
326 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100327 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100328 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100329 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
330 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100331 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100332 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100333 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100334#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100335
336 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100337 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100338 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100339 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100340
Gilles Peskinee59236f2018-01-27 23:32:46 +0100341 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
342 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
343 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100344 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100345
346 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100347 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100348 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100349 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100350 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100351 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100352
Gilles Peskine82e57d12020-11-13 21:31:17 +0100353#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100354 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100355 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
356 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100357 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100358 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100359 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
360 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100361 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100362 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100363 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100364#endif
365
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200366 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
367 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
368 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100369 return PSA_ERROR_HARDWARE_FAILURE;
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200370
Gilles Peskinea5905292018-02-07 20:59:33 +0100371 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100372 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100373 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100374 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100375 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100376 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100377 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100378 return PSA_ERROR_STORAGE_FAILURE;
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200379 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100380 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100381
Gilles Peskinef76aa772018-10-29 19:24:33 +0100382 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100383 return PSA_ERROR_STORAGE_FAILURE;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100384 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100385 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100386 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100387 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100388 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100389 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100390 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100391 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100392 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100393 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100394 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100395 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100396 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100397 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100398
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100399 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100400 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100401 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
402 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100403 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100404 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100405 return PSA_ERROR_STORAGE_FAILURE;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100406 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
407 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100408 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100409 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100410 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100411 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
412 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100413 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100414 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100415 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100416 case MBEDTLS_ERR_PK_INVALID_ALG:
417 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
418 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100419 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100420 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100421 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100422 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100423 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100424
Gilles Peskineff2d2002019-05-06 15:26:23 +0200425 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100426 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200427 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100428 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200429
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200430 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100431 return PSA_ERROR_HARDWARE_FAILURE;
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200432
Gilles Peskinea5905292018-02-07 20:59:33 +0100433 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100434 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100435 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100436 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100437 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100438 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100439 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100440 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100441 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
442 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100443 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100444 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100445 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100446 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100447 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100448 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100449 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100450 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100451 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100452 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100453 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100454
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200455 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
456 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
457 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100458 return PSA_ERROR_HARDWARE_FAILURE;
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200459
Gilles Peskinea5905292018-02-07 20:59:33 +0100460 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100461 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100462 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100463 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100464
itayzafrir5c753392018-05-08 11:18:38 +0300465 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300466 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100467 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300468 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100469 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300470 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100471 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300472 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
473 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100474 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300475 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100476 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100477 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100478 return PSA_ERROR_INSUFFICIENT_ENTROPY;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300479 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100480 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskine40d81602020-11-25 00:09:47 +0100481
Janos Follatha13b9052019-11-22 12:48:59 +0000482 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100483 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300484
Gilles Peskinee59236f2018-01-27 23:32:46 +0100485 default:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100486 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100487 }
488}
489
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200490
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200491
492
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100493/****************************************************************/
494/* Key management */
495/****************************************************************/
496
John Durkop9814fa22020-11-04 12:28:15 -0800497#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800498 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
Ronald Cron9ecdd972021-11-19 18:02:34 +0100499 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
500 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) || \
501 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100502mbedtls_ecp_group_id mbedtls_ecc_group_of_psa(psa_ecc_family_t curve,
503 size_t bits,
504 int bits_is_sloppy)
Gilles Peskine12313cd2018-06-20 00:20:32 +0200505{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100506 switch (curve) {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100507 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100508 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100509#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100510 case 192:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100511 return MBEDTLS_ECP_DP_SECP192R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100512#endif
513#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100514 case 224:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100515 return MBEDTLS_ECP_DP_SECP224R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100516#endif
517#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100518 case 256:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100519 return MBEDTLS_ECP_DP_SECP256R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100520#endif
521#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100522 case 384:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100523 return MBEDTLS_ECP_DP_SECP384R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100524#endif
525#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100526 case 521:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100527 return MBEDTLS_ECP_DP_SECP521R1;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100528 case 528:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100529 if (bits_is_sloppy) {
530 return MBEDTLS_ECP_DP_SECP521R1;
531 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100532 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100533#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100534 }
535 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100536
Paul Elliott8ff510a2020-06-02 17:19:28 +0100537 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100538 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100539#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100540 case 256:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100541 return MBEDTLS_ECP_DP_BP256R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100542#endif
543#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100544 case 384:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100545 return MBEDTLS_ECP_DP_BP384R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100546#endif
547#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100548 case 512:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100549 return MBEDTLS_ECP_DP_BP512R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100550#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100551 }
552 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100553
Paul Elliott8ff510a2020-06-02 17:19:28 +0100554 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100555 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100556#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100557 case 255:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100558 return MBEDTLS_ECP_DP_CURVE25519;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100559 case 256:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100560 if (bits_is_sloppy) {
561 return MBEDTLS_ECP_DP_CURVE25519;
562 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100563 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100564#endif
565#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100566 case 448:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100567 return MBEDTLS_ECP_DP_CURVE448;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100568#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100569 }
570 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100571
Paul Elliott8ff510a2020-06-02 17:19:28 +0100572 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100573 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100574#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100575 case 192:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100576 return MBEDTLS_ECP_DP_SECP192K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100577#endif
578#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100579 case 224:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100580 return MBEDTLS_ECP_DP_SECP224K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100581#endif
582#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100583 case 256:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100584 return MBEDTLS_ECP_DP_SECP256K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100585#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100586 }
587 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200588 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100589
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100590 (void) bits_is_sloppy;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100591 return MBEDTLS_ECP_DP_NONE;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200592}
John Durkop9814fa22020-11-04 12:28:15 -0800593#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
Ronald Cron9ecdd972021-11-19 18:02:34 +0100594 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
595 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
596 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) ||
597 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200598
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100599static psa_status_t validate_unstructured_key_bit_size(psa_key_type_t type,
600 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200601{
602 /* Check that the bit size is acceptable for the key type */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100603 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200604 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200605 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200606 case PSA_KEY_TYPE_DERIVE:
607 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100608#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200609 case PSA_KEY_TYPE_AES:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100610 if (bits != 128 && bits != 192 && bits != 256) {
611 return PSA_ERROR_INVALID_ARGUMENT;
612 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200613 break;
614#endif
Gilles Peskine8890f642021-09-21 11:59:39 +0200615#if defined(PSA_WANT_KEY_TYPE_ARIA)
616 case PSA_KEY_TYPE_ARIA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100617 if (bits != 128 && bits != 192 && bits != 256) {
618 return PSA_ERROR_INVALID_ARGUMENT;
619 }
Gilles Peskine8890f642021-09-21 11:59:39 +0200620 break;
621#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100622#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200623 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100624 if (bits != 128 && bits != 192 && bits != 256) {
625 return PSA_ERROR_INVALID_ARGUMENT;
626 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200627 break;
628#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100629#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200630 case PSA_KEY_TYPE_DES:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100631 if (bits != 64 && bits != 128 && bits != 192) {
632 return PSA_ERROR_INVALID_ARGUMENT;
633 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200634 break;
635#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100636#if defined(PSA_WANT_KEY_TYPE_ARC4)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200637 case PSA_KEY_TYPE_ARC4:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100638 if (bits < 8 || bits > 2048) {
639 return PSA_ERROR_INVALID_ARGUMENT;
640 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200641 break;
642#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100643#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200644 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100645 if (bits != 256) {
646 return PSA_ERROR_INVALID_ARGUMENT;
647 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200648 break;
649#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200650 default:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100651 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200652 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100653 if (bits % 8 != 0) {
654 return PSA_ERROR_INVALID_ARGUMENT;
655 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200656
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100657 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200658}
659
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100660/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100661 *
Steven Cooremancd640932021-03-08 12:00:27 +0100662 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
663 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100664 *
665 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100666 * \param[in] key_type The key type of the key to be used with the
667 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100668 *
669 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100670 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100671 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100672 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100673 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100674MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100675 psa_algorithm_t algorithm,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100676 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100677{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100678 if (PSA_ALG_IS_HMAC(algorithm)) {
679 if (key_type == PSA_KEY_TYPE_HMAC) {
680 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100681 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100682 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100683
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100684 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
685 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
686 * key. */
687 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
688 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
689 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
690 * the block length (larger than 1) for block ciphers. */
691 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
692 return PSA_SUCCESS;
693 }
694 }
695 }
696
697 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100698}
699
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100700psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
701 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200702{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100703 if (slot->key.data != NULL) {
704 return PSA_ERROR_ALREADY_EXISTS;
705 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200706
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100707 slot->key.data = mbedtls_calloc(1, buffer_length);
708 if (slot->key.data == NULL) {
709 return PSA_ERROR_INSUFFICIENT_MEMORY;
710 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200711
Ronald Cronea0f8a62020-11-25 17:52:23 +0100712 slot->key.bytes = buffer_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100713 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200714}
715
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100716psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
717 const uint8_t *data,
718 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200719{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100720 psa_status_t status = psa_allocate_buffer_to_slot(slot,
721 data_length);
722 if (status != PSA_SUCCESS) {
723 return status;
724 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200725
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100726 memcpy(slot->key.data, data, data_length);
727 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200728}
729
Ronald Crona0fe59f2020-11-29 11:14:53 +0100730psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100731 const psa_key_attributes_t *attributes,
732 const uint8_t *data, size_t data_length,
733 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100734 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100735{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100736 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
737 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100738
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200739 /* zero-length keys are never supported. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100740 if (data_length == 0) {
741 return PSA_ERROR_NOT_SUPPORTED;
742 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200743
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100744 if (key_type_is_raw_bytes(type)) {
745 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200746
Steven Cooreman75b74362020-07-28 14:30:13 +0200747 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100748 if (data_length > SIZE_MAX / 8) {
749 return PSA_ERROR_NOT_SUPPORTED;
750 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200751
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200752 /* Enforce a size limit, and in particular ensure that the bit
753 * size fits in its representation type. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100754 if ((*bits) > PSA_MAX_KEY_BITS) {
755 return PSA_ERROR_NOT_SUPPORTED;
756 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200757
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100758 status = validate_unstructured_key_bit_size(type, *bits);
759 if (status != PSA_SUCCESS) {
760 return status;
761 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200762
Ronald Crondd04d422020-11-28 15:14:42 +0100763 /* Copy the key material. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100764 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100765 *key_buffer_length = data_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100766 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200767
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100768 return PSA_SUCCESS;
769 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
John Durkop9814fa22020-11-04 12:28:15 -0800770#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100771 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
772 if (PSA_KEY_TYPE_IS_ECC(type)) {
773 return mbedtls_psa_ecp_import_key(attributes,
774 data, data_length,
775 key_buffer, key_buffer_size,
776 key_buffer_length,
777 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100778 }
John Durkop9814fa22020-11-04 12:28:15 -0800779#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
780 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700781#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100782 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
783 if (PSA_KEY_TYPE_IS_RSA(type)) {
784 return mbedtls_psa_rsa_import_key(attributes,
785 data, data_length,
786 key_buffer, key_buffer_size,
787 key_buffer_length,
788 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200789 }
John Durkop9814fa22020-11-04 12:28:15 -0800790#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
791 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100792 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100793
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100794 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100795}
796
Gilles Peskinef603c712019-01-19 13:40:11 +0100797/** Calculate the intersection of two algorithm usage policies.
798 *
799 * Return 0 (which allows no operation) on incompatibility.
800 */
801static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100802 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100803 psa_algorithm_t alg1,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100804 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100805{
Gilles Peskine549ea862019-05-22 11:45:59 +0200806 /* Common case: both sides actually specify the same policy. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100807 if (alg1 == alg2) {
808 return alg1;
809 }
Steven Cooreman03488022021-02-18 12:07:20 +0100810 /* If the policies are from the same hash-and-sign family, check
811 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100812 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
813 PSA_ALG_IS_SIGN_HASH(alg2) &&
814 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
815 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
816 return alg2;
817 }
818 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
819 return alg1;
820 }
Steven Cooreman03488022021-02-18 12:07:20 +0100821 }
822 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100823 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100824 * restrictive tag length. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100825 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
826 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
827 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
828 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
829 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100830 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100831
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100832 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100833 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
834 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
835 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
836 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100837 }
838 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100839 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
840 (alg1_len <= alg2_len)) {
841 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100842 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100843 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
844 (alg2_len <= alg1_len)) {
845 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100846 }
847 }
848 /* If the policies are from the same MAC family, check whether one
849 * of them is a minimum-MAC-length policy. Calculate the most
850 * restrictive tag length. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100851 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
852 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
853 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100854 /* Validate the combination of key type and algorithm. Since the base
855 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100856 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
857 return 0;
858 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100859
Steven Cooreman31a876d2021-03-03 20:47:40 +0100860 /* Get the (exact or at-least) output lengths for both sides of the
861 * requested intersection. None of the currently supported algorithms
862 * have an output length dependent on the actual key size, so setting it
863 * to a bogus value of 0 is currently OK.
864 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100865 * Note that for at-least-this-length wildcard algorithms, the output
866 * length is set to the shortest allowed length, which allows us to
867 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100868 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
869 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100870 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100871
Steven Cooremana1d83222021-02-25 10:20:29 +0100872 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100873 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
874 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
875 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100876 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100877
878 /* If only one is an at-least-this-length policy, the intersection would
879 * be the other (fixed-length) policy as long as said fixed length is
880 * equal to or larger than the shortest allowed length. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100881 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
882 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100883 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100884 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
885 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100886 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100887
Steven Cooremancd640932021-03-08 12:00:27 +0100888 /* If none of them are wildcards, check whether they define the same tag
889 * length. This is still possible here when one is default-length and
890 * the other specific-length. Ensure to always return the
891 * specific-length version for the intersection. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100892 if (alg1_len == alg2_len) {
893 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
894 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100895 }
896 /* If the policies are incompatible, allow nothing. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100897 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100898}
899
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100900static int psa_key_algorithm_permits(psa_key_type_t key_type,
901 psa_algorithm_t policy_alg,
902 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200903{
Gilles Peskine549ea862019-05-22 11:45:59 +0200904 /* Common case: the policy only allows requested_alg. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100905 if (requested_alg == policy_alg) {
906 return 1;
907 }
Steven Cooreman03488022021-02-18 12:07:20 +0100908 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
909 * and requested_alg is the same hash-and-sign family with any hash,
910 * then requested_alg is compliant with policy_alg. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100911 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
912 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
913 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
914 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100915 }
916 /* If policy_alg is a wildcard AEAD algorithm of the same base as
917 * the requested algorithm, check the requested tag length to be
918 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100919 if (PSA_ALG_IS_AEAD(policy_alg) &&
920 PSA_ALG_IS_AEAD(requested_alg) &&
921 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
922 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
923 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
924 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
925 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100926 }
Steven Cooremancd640932021-03-08 12:00:27 +0100927 /* If policy_alg is a MAC algorithm of the same base as the requested
928 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100929 if (PSA_ALG_IS_MAC(policy_alg) &&
930 PSA_ALG_IS_MAC(requested_alg) &&
931 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
932 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100933 /* Validate the combination of key type and algorithm. Since the policy
934 * and requested algorithms are the same, we only need this once. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100935 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
936 return 0;
937 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100938
Steven Cooreman31a876d2021-03-03 20:47:40 +0100939 /* Get both the requested output length for the algorithm which is to be
940 * verified, and the default output length for the base algorithm.
941 * Note that none of the currently supported algorithms have an output
942 * length dependent on actual key size, so setting it to a bogus value
943 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100944 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100945 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100946 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100947 key_type, 0,
948 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100949
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100950 /* If the policy is default-length, only allow an algorithm with
951 * a declared exact-length matching the default. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100952 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
953 return requested_output_length == default_output_length;
954 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100955
956 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100957 * length exactly matches the default length. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100958 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
959 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
960 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100961 }
962
Steven Cooremancd640932021-03-08 12:00:27 +0100963 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
964 * check for the requested MAC length to be equal to or longer than the
965 * minimum allowed length. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100966 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
967 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
968 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100969 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200970 }
Steven Cooremance48e852020-10-05 16:02:45 +0200971 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200972 * a key derivation with that key agreement should also be allowed. This
973 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100974 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
975 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
976 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
977 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +0200978 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100979 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100980 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200981}
982
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100983/** Test whether a policy permits an algorithm.
984 *
985 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100986 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100987 * \note This function requires providing the key type for which the policy is
988 * being validated, since some algorithm policy definitions (e.g. MAC)
989 * have different properties depending on what kind of cipher it is
990 * combined with.
991 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100992 * \retval PSA_SUCCESS When \p alg is a specific algorithm
993 * allowed by the \p policy.
994 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
995 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
996 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100997 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100998static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
999 psa_key_type_t key_type,
1000 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001001{
Steven Cooremand788fab2021-02-25 11:29:17 +01001002 /* '0' is not a valid algorithm */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001003 if (alg == 0) {
1004 return PSA_ERROR_INVALID_ARGUMENT;
1005 }
Steven Cooremand788fab2021-02-25 11:29:17 +01001006
Steven Cooreman7e39f052021-02-23 14:18:32 +01001007 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001008 if (PSA_ALG_IS_WILDCARD(alg)) {
1009 return PSA_ERROR_INVALID_ARGUMENT;
1010 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001011
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001012 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
1013 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
1014 return PSA_SUCCESS;
1015 } else {
1016 return PSA_ERROR_NOT_PERMITTED;
1017 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001018}
1019
Gilles Peskinef603c712019-01-19 13:40:11 +01001020/** Restrict a key policy based on a constraint.
1021 *
Steven Cooreman5a172672021-03-02 21:27:42 +01001022 * \note This function requires providing the key type for which the policy is
1023 * being restricted, since some algorithm policy definitions (e.g. MAC)
1024 * have different properties depending on what kind of cipher it is
1025 * combined with.
1026 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001027 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +01001028 * \param[in,out] policy The policy to restrict.
1029 * \param[in] constraint The policy constraint to apply.
1030 *
1031 * \retval #PSA_SUCCESS
1032 * \c *policy contains the intersection of the original value of
1033 * \c *policy and \c *constraint.
1034 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001035 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +01001036 * \c *policy is unchanged.
1037 */
1038static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001039 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +01001040 psa_key_policy_t *policy,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001041 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +01001042{
1043 psa_algorithm_t intersection_alg =
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001044 psa_key_policy_algorithm_intersection(key_type, policy->alg,
1045 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +02001046 psa_algorithm_t intersection_alg2 =
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001047 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
1048 constraint->alg2);
1049 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
1050 return PSA_ERROR_INVALID_ARGUMENT;
1051 }
1052 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
1053 return PSA_ERROR_INVALID_ARGUMENT;
1054 }
Gilles Peskinef603c712019-01-19 13:40:11 +01001055 policy->usage &= constraint->usage;
1056 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001057 policy->alg2 = intersection_alg2;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001058 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +01001059}
1060
Ronald Cron5c522922020-11-14 16:35:34 +01001061/** Get the description of a key given its identifier and policy constraints
1062 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001063 *
Ronald Cron5c522922020-11-14 16:35:34 +01001064 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +01001065 * nonzero, the key must allow operations with this algorithm. If \p alg is
1066 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +01001067 *
Ronald Cron5c522922020-11-14 16:35:34 +01001068 * In case of a persistent key, the function loads the description of the key
1069 * into a key slot if not already done.
1070 *
1071 * On success, the returned key slot is locked. It is the responsibility of
1072 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001073 */
Ronald Cron5c522922020-11-14 16:35:34 +01001074static psa_status_t psa_get_and_lock_key_slot_with_policy(
1075 mbedtls_svc_key_id_t key,
1076 psa_key_slot_t **p_slot,
1077 psa_key_usage_t usage,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001078 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +01001079{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001080 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1081 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001082
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001083 status = psa_get_and_lock_key_slot(key, p_slot);
1084 if (status != PSA_SUCCESS) {
1085 return status;
1086 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001087 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001088
1089 /* Enforce that usage policy for the key slot contains all the flags
1090 * required by the usage parameter. There is one exception: public
1091 * keys can always be exported, so we treat public key objects as
1092 * if they had the export flag. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001093 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +01001094 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001095 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001096
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001097 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +01001098 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001099 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001100 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001101
Shaun Case0e7791f2021-12-20 21:14:10 -08001102 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001103 if (alg != 0) {
1104 status = psa_key_policy_permits(&slot->attr.policy,
1105 slot->attr.type,
1106 alg);
1107 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +01001108 goto error;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001109 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001110 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001111
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001112 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001113
1114error:
1115 *p_slot = NULL;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001116 psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001117
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001118 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +01001119}
Darryl Green940d72c2018-07-13 13:18:51 +01001120
Ronald Cron5c522922020-11-14 16:35:34 +01001121/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001122 *
1123 * A transparent key is a key for which the key material is directly
Ronald Cron8a0466a2021-08-24 15:39:44 +02001124 * available, as opposed to a key in a secure element and/or to be used
1125 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001126 *
Ronald Cron8a0466a2021-08-24 15:39:44 +02001127 * This is a temporary function that may be used instead of
1128 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
1129 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001130 *
Ronald Cron5c522922020-11-14 16:35:34 +01001131 * On success, the returned key slot is locked. It is the responsibility of the
1132 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001133 */
Ronald Cron5c522922020-11-14 16:35:34 +01001134static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1135 mbedtls_svc_key_id_t key,
1136 psa_key_slot_t **p_slot,
1137 psa_key_usage_t usage,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001138 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +02001139{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001140 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
1141 usage, alg);
1142 if (status != PSA_SUCCESS) {
1143 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001144 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001145
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001146 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
1147 psa_unlock_key_slot(*p_slot);
1148 *p_slot = NULL;
1149 return PSA_ERROR_NOT_SUPPORTED;
1150 }
1151
1152 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001153}
Gilles Peskine28f8f302019-07-24 13:30:31 +02001154
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001155psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +00001156{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001157 /* Data pointer will always be either a valid pointer or NULL in an
1158 * initialized slot, so we can just free it. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001159 if (slot->key.data != NULL) {
1160 mbedtls_platform_zeroize(slot->key.data, slot->key.bytes);
1161 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001162
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001163 mbedtls_free(slot->key.data);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001164 slot->key.data = NULL;
1165 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001166
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001167 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001168}
1169
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001170/** Completely wipe a slot in memory, including its policy.
1171 * Persistent storage is not affected. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001172psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001173{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001174 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001175
1176 /*
1177 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001178 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001179 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1180 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001181 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001182 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001183 if (slot->lock_count != 1) {
Ronald Cronddd3d052020-10-30 14:07:07 +01001184#ifdef MBEDTLS_CHECK_PARAMS
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001185 MBEDTLS_PARAM_FAILED(slot->lock_count == 1);
Ronald Cronddd3d052020-10-30 14:07:07 +01001186#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001187 status = PSA_ERROR_CORRUPTION_DETECTED;
1188 }
1189
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001190 /* Multipart operations may still be using the key. This is safe
1191 * because all multipart operation objects are independent from
1192 * the key slot: if they need to access the key after the setup
1193 * phase, they have a copy of the key. Note that this means that
1194 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001195 /* At this point, key material and other type-specific content has
1196 * been wiped. Clear remaining metadata. We can call memset and not
1197 * zeroize because the metadata is not particularly sensitive. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001198 memset(slot, 0, sizeof(*slot));
1199 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001200}
1201
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001202psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001203{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001204 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001205 psa_status_t status; /* status of the last operation */
1206 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001207#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1208 psa_se_drv_table_entry_t *driver;
1209#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001210
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001211 if (mbedtls_svc_key_id_is_null(key)) {
1212 return PSA_SUCCESS;
1213 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001214
Ronald Cronf2911112020-10-29 17:51:10 +01001215 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001216 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001217 * key, this will load the key description from persistent memory if not
1218 * done yet. We cannot avoid this loading as without it we don't know if
1219 * the key is operated by an SE or not and this information is needed by
1220 * the current implementation.
1221 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001222 status = psa_get_and_lock_key_slot(key, &slot);
1223 if (status != PSA_SUCCESS) {
1224 return status;
1225 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001226
Ronald Cronf2911112020-10-29 17:51:10 +01001227 /*
1228 * If the key slot containing the key description is under access by the
1229 * library (apart from the present access), the key cannot be destroyed
1230 * yet. For the time being, just return in error. Eventually (to be
1231 * implemented), the key should be destroyed when all accesses have
1232 * stopped.
1233 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001234 if (slot->lock_count > 1) {
1235 psa_unlock_key_slot(slot);
1236 return PSA_ERROR_GENERIC_ERROR;
Ronald Cronf2911112020-10-29 17:51:10 +01001237 }
1238
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001239 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine251c7742021-04-21 22:32:05 +02001240 /* Refuse the destruction of a read-only key (which may or may not work
1241 * if we attempt it, depending on whether the key is merely read-only
1242 * by policy or actually physically read-only).
Gilles Peskine2bfbb172021-06-07 23:27:54 +02001243 * Just do the best we can, which is to wipe the copy in memory
1244 * (done in this function's cleanup code). */
1245 overall_status = PSA_ERROR_NOT_PERMITTED;
1246 goto exit;
Gilles Peskine251c7742021-04-21 22:32:05 +02001247 }
1248
Gilles Peskine354f7672019-07-12 23:46:38 +02001249#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001250 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1251 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001252 /* For a key in a secure element, we need to do three things:
1253 * remove the key file in internal storage, destroy the
1254 * key inside the secure element, and update the driver's
1255 * persistent data. Start a transaction that will encompass these
1256 * three actions. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001257 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001258 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001259 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001260 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001261 status = psa_crypto_save_transaction();
1262 if (status != PSA_SUCCESS) {
1263 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001264 /* We should still try to destroy the key in the secure
1265 * element and the key metadata in storage. This is especially
1266 * important if the error is that the storage is full.
1267 * But how to do it exactly without risking an inconsistent
1268 * state after a reset?
1269 * https://github.com/ARMmbed/mbed-crypto/issues/215
1270 */
1271 overall_status = status;
1272 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001273 }
1274
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001275 status = psa_destroy_se_key(driver,
1276 psa_key_slot_get_slot_number(slot));
1277 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001278 overall_status = status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001279 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001280 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001281#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1282
Darryl Greend49a4992018-06-18 17:27:26 +01001283#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001284 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
1285 status = psa_destroy_persistent_key(slot->attr.id);
1286 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001287 overall_status = status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001288 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001289
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001290 /* TODO: other slots may have a copy of the same key. We should
1291 * invalidate them.
1292 * https://github.com/ARMmbed/mbed-crypto/issues/214
1293 */
Darryl Greend49a4992018-06-18 17:27:26 +01001294 }
1295#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001296
Gilles Peskinefc762652019-07-22 19:30:34 +02001297#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001298 if (driver != NULL) {
1299 status = psa_save_se_persistent_data(driver);
1300 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001301 overall_status = status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001302 }
1303 status = psa_crypto_stop_transaction();
1304 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001305 overall_status = status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001306 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001307 }
1308#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1309
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001310exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001311 status = psa_wipe_key_slot(slot);
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001312 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001313 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001314 overall_status = status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001315 }
1316 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001317}
1318
John Durkop07cc04a2020-11-16 22:08:34 -08001319#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001320 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001321static psa_status_t psa_get_rsa_public_exponent(
1322 const mbedtls_rsa_context *rsa,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001323 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001324{
1325 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001326 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001327 uint8_t *buffer = NULL;
1328 size_t buflen;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001329 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001330
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001331 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1332 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001333 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001334 }
1335 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001336 /* It's the default value, which is reported as an empty string,
1337 * so there's nothing to do. */
1338 goto exit;
1339 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001340
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001341 buflen = mbedtls_mpi_size(&mpi);
1342 buffer = mbedtls_calloc(1, buflen);
1343 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001344 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1345 goto exit;
1346 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001347 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1348 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001349 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001350 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001351 attributes->domain_parameters = buffer;
1352 attributes->domain_parameters_size = buflen;
1353
1354exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001355 mbedtls_mpi_free(&mpi);
1356 if (ret != 0) {
1357 mbedtls_free(buffer);
1358 }
1359 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001360}
John Durkop07cc04a2020-11-16 22:08:34 -08001361#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001362 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001363
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001364/** Retrieve all the publicly-accessible attributes of a key.
1365 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001366psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1367 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001368{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001369 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001370 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001371 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001372
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001373 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001374
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001375 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1376 if (status != PSA_SUCCESS) {
1377 return status;
1378 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001379
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001380 attributes->core = slot->attr;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001381 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1382 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001383
1384#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001385 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1386 psa_set_key_slot_number(attributes,
1387 psa_key_slot_get_slot_number(slot));
1388 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001389#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001390
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001391 switch (slot->attr.type) {
John Durkop07cc04a2020-11-16 22:08:34 -08001392#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001393 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001394 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001395 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001396 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001397 * is not yet implemented.
1398 * https://github.com/ARMmbed/mbed-crypto/issues/216
1399 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001400 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001401 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001402
Ronald Cron90857082020-11-25 14:58:33 +01001403 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001404 slot->attr.type,
1405 slot->key.data,
1406 slot->key.bytes,
1407 &rsa);
1408 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001409 break;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001410 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001411
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001412 status = psa_get_rsa_public_exponent(rsa,
1413 attributes);
1414 mbedtls_rsa_free(rsa);
1415 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001416 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001417 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001418#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001419 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001420 default:
1421 /* Nothing else to do. */
1422 break;
1423 }
1424
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001425 if (status != PSA_SUCCESS) {
1426 psa_reset_key_attributes(attributes);
1427 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001428
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001429 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001430
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001431 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001432}
1433
Gilles Peskinec8000c02019-08-02 20:15:51 +02001434#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1435psa_status_t psa_get_key_slot_number(
1436 const psa_key_attributes_t *attributes,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001437 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001438{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001439 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001440 *slot_number = attributes->slot_number;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001441 return PSA_SUCCESS;
1442 } else {
1443 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001444 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001445}
1446#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1447
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001448static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1449 size_t key_buffer_size,
1450 uint8_t *data,
1451 size_t data_size,
1452 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001453{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001454 if (key_buffer_size > data_size) {
1455 return PSA_ERROR_BUFFER_TOO_SMALL;
1456 }
1457 memcpy(data, key_buffer, key_buffer_size);
1458 memset(data + key_buffer_size, 0,
1459 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001460 *data_length = key_buffer_size;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001461 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001462}
1463
Ronald Cron7285cda2020-11-26 14:46:37 +01001464psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001465 const psa_key_attributes_t *attributes,
1466 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001467 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001468{
Ronald Crond18b5f82020-11-25 16:46:05 +01001469 psa_key_type_t type = attributes->core.type;
1470
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001471 if (key_type_is_raw_bytes(type) ||
1472 PSA_KEY_TYPE_IS_RSA(type) ||
1473 PSA_KEY_TYPE_IS_ECC(type)) {
1474 return psa_export_key_buffer_internal(
1475 key_buffer, key_buffer_size,
1476 data, data_size, data_length);
1477 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001478 /* This shouldn't happen in the reference implementation, but
1479 it is valid for a special-purpose implementation to omit
1480 support for exporting certain key types. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001481 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001482 }
1483}
1484
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001485psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1486 uint8_t *data,
1487 size_t data_size,
1488 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001489{
1490 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1491 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1492 psa_key_slot_t *slot;
1493
Ronald Crone907e552021-01-18 13:22:38 +01001494 /* Reject a zero-length output buffer now, since this can never be a
1495 * valid key representation. This way we know that data must be a valid
1496 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001497 if (data_size == 0) {
1498 return PSA_ERROR_BUFFER_TOO_SMALL;
1499 }
Ronald Crone907e552021-01-18 13:22:38 +01001500
Ronald Cron9486f9d2020-11-26 13:36:23 +01001501 /* Set the key to empty now, so that even when there are errors, we always
1502 * set data_length to a value between 0 and data_size. On error, setting
1503 * the key to empty is a good choice because an empty key representation is
1504 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001505 *data_length = 0;
1506
Ronald Cron9486f9d2020-11-26 13:36:23 +01001507 /* Export requires the EXPORT flag. There is an exception for public keys,
1508 * which don't require any flag, but
1509 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1510 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001511 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1512 PSA_KEY_USAGE_EXPORT, 0);
1513 if (status != PSA_SUCCESS) {
1514 return status;
1515 }
mohammad160306e79202018-03-28 13:17:44 +03001516
Ronald Crond18b5f82020-11-25 16:46:05 +01001517 psa_key_attributes_t attributes = {
1518 .core = slot->attr
1519 };
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001520 status = psa_driver_wrapper_export_key(&attributes,
1521 slot->key.data, slot->key.bytes,
1522 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001523
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001524 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001525
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001526 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001527}
1528
Ronald Cron7285cda2020-11-26 14:46:37 +01001529psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001530 const psa_key_attributes_t *attributes,
1531 const uint8_t *key_buffer,
1532 size_t key_buffer_size,
1533 uint8_t *data,
1534 size_t data_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001535 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001536{
Ronald Crond18b5f82020-11-25 16:46:05 +01001537 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001538
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001539 if (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type)) {
1540 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type)) {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001541 /* Exporting public -> public */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001542 return psa_export_key_buffer_internal(
1543 key_buffer, key_buffer_size,
1544 data, data_size, data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001545 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001546
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001547 if (PSA_KEY_TYPE_IS_RSA(type)) {
John Durkop0e005192020-10-31 22:06:54 -07001548#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001549 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1550 return mbedtls_psa_rsa_export_public_key(attributes,
1551 key_buffer,
1552 key_buffer_size,
1553 data,
1554 data_size,
1555 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001556#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001557 /* We don't know how to convert a private RSA key to public. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001558 return PSA_ERROR_NOT_SUPPORTED;
John Durkop9814fa22020-11-04 12:28:15 -08001559#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1560 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001561 } else {
John Durkop6ba40d12020-11-10 08:50:04 -08001562#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001563 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1564 return mbedtls_psa_ecp_export_public_key(attributes,
1565 key_buffer,
1566 key_buffer_size,
1567 data,
1568 data_size,
1569 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001570#else
1571 /* We don't know how to convert a private ECC key to public */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001572 return PSA_ERROR_NOT_SUPPORTED;
John Durkop9814fa22020-11-04 12:28:15 -08001573#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1574 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001575 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001576 } else {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001577 /* This shouldn't happen in the reference implementation, but
1578 it is valid for a special-purpose implementation to omit
1579 support for exporting certain key types. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001580 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001581 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001582}
Ronald Crond18b5f82020-11-25 16:46:05 +01001583
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001584psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1585 uint8_t *data,
1586 size_t data_size,
1587 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001588{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001589 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001590 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01001591 psa_key_attributes_t attributes;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001592 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001593
Ronald Crone907e552021-01-18 13:22:38 +01001594 /* Reject a zero-length output buffer now, since this can never be a
1595 * valid key representation. This way we know that data must be a valid
1596 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001597 if (data_size == 0) {
1598 return PSA_ERROR_BUFFER_TOO_SMALL;
1599 }
Ronald Crone907e552021-01-18 13:22:38 +01001600
Darryl Greendd8fb772018-11-07 16:00:44 +00001601 /* Set the key to empty now, so that even when there are errors, we always
1602 * set data_length to a value between 0 and data_size. On error, setting
1603 * the key to empty is a good choice because an empty key representation is
1604 * unlikely to be accepted anywhere. */
1605 *data_length = 0;
1606
1607 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001608 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1609 if (status != PSA_SUCCESS) {
1610 return status;
1611 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001612
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001613 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1614 status = PSA_ERROR_INVALID_ARGUMENT;
1615 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001616 }
1617
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01001618 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001619 .core = slot->attr
1620 };
Ronald Cron67227982020-11-26 15:16:05 +01001621 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001622 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001623 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001624
1625exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001626 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001627
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001628 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001629}
1630
Tom Cosgrovebdd01a72023-03-08 14:19:51 +00001631MBEDTLS_STATIC_ASSERT((MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1632 "One or more key attribute flag is listed as both external-only and dual-use")
1633MBEDTLS_STATIC_ASSERT((PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1634 "One or more key attribute flag is listed as both internal-only and dual-use")
1635MBEDTLS_STATIC_ASSERT((PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1636 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001637
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001638/** Validate that a key policy is internally well-formed.
1639 *
1640 * This function only rejects invalid policies. It does not validate the
1641 * consistency of the policy with respect to other attributes of the key
1642 * such as the key type.
1643 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001644static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001645{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001646 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1647 PSA_KEY_USAGE_COPY |
1648 PSA_KEY_USAGE_ENCRYPT |
1649 PSA_KEY_USAGE_DECRYPT |
1650 PSA_KEY_USAGE_SIGN_MESSAGE |
1651 PSA_KEY_USAGE_VERIFY_MESSAGE |
1652 PSA_KEY_USAGE_SIGN_HASH |
1653 PSA_KEY_USAGE_VERIFY_HASH |
1654 PSA_KEY_USAGE_DERIVE)) != 0) {
1655 return PSA_ERROR_INVALID_ARGUMENT;
1656 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001657
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001658 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001659}
1660
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001661/** Validate the internal consistency of key attributes.
1662 *
1663 * This function only rejects invalid attribute values. If does not
1664 * validate the consistency of the attributes with any key data that may
1665 * be involved in the creation of the key.
1666 *
1667 * Call this function early in the key creation process.
1668 *
1669 * \param[in] attributes Key attributes for the new key.
1670 * \param[out] p_drv On any return, the driver for the key, if any.
1671 * NULL for a transparent key.
1672 *
1673 */
1674static psa_status_t psa_validate_key_attributes(
1675 const psa_key_attributes_t *attributes,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001676 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001677{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001678 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001679 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1680 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001681
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001682 status = psa_validate_key_location(lifetime, p_drv);
1683 if (status != PSA_SUCCESS) {
1684 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001685 }
1686
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001687 status = psa_validate_key_persistence(lifetime);
1688 if (status != PSA_SUCCESS) {
1689 return status;
1690 }
1691
1692 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1693 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1694 return PSA_ERROR_INVALID_ARGUMENT;
1695 }
1696 } else {
1697 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1698 return PSA_ERROR_INVALID_ARGUMENT;
1699 }
1700 }
1701
1702 status = psa_validate_key_policy(&attributes->core.policy);
1703 if (status != PSA_SUCCESS) {
1704 return status;
1705 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001706
1707 /* Refuse to create overly large keys.
1708 * Note that this doesn't trigger on import if the attributes don't
1709 * explicitly specify a size (so psa_get_key_bits returns 0), so
1710 * psa_import_key() needs its own checks. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001711 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1712 return PSA_ERROR_NOT_SUPPORTED;
1713 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001714
Gilles Peskine91e8c332019-08-02 19:19:39 +02001715 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001716 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1717 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1718 return PSA_ERROR_INVALID_ARGUMENT;
1719 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001720
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001721 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001722}
1723
Gilles Peskine4747d192019-04-17 15:05:45 +02001724/** Prepare a key slot to receive key material.
1725 *
1726 * This function allocates a key slot and sets its metadata.
1727 *
1728 * If this function fails, call psa_fail_key_creation().
1729 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001730 * This function is intended to be used as follows:
1731 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001732 * it with the specified attributes, and in case of a volatile key assign it
1733 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001734 * -# Populate the slot with the key material.
1735 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1736 * In case of failure at any step, stop the sequence and call
1737 * psa_fail_key_creation().
1738 *
Ronald Cron5c522922020-11-14 16:35:34 +01001739 * On success, the key slot is locked. It is the responsibility of the caller
1740 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001741 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001742 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001743 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001744 * \param[out] p_slot On success, a pointer to the prepared slot.
1745 * \param[out] p_drv On any return, the driver for the key, if any.
1746 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001747 *
1748 * \retval #PSA_SUCCESS
1749 * The key slot is ready to receive key material.
1750 * \return If this function fails, the key slot is an invalid state.
1751 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001752 */
1753static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001754 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001755 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001756 psa_key_slot_t **p_slot,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001757 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001758{
1759 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001760 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001761 psa_key_slot_t *slot;
1762
Gilles Peskinedf179142019-07-15 22:02:14 +02001763 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001764 *p_drv = NULL;
1765
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001766 status = psa_validate_key_attributes(attributes, p_drv);
1767 if (status != PSA_SUCCESS) {
1768 return status;
1769 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001770
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001771 status = psa_get_empty_key_slot(&volatile_key_id, p_slot);
1772 if (status != PSA_SUCCESS) {
1773 return status;
1774 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001775 slot = *p_slot;
1776
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001777 /* We're storing the declared bit-size of the key. It's up to each
1778 * creation mechanism to verify that this information is correct.
1779 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001780 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001781 * is optional (import, copy). In case of a volatile key, assign it the
1782 * volatile key identifier associated to the slot returned to contain its
1783 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001784
1785 slot->attr = attributes->core;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001786 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001787#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1788 slot->attr.id = volatile_key_id;
1789#else
1790 slot->attr.id.key_id = volatile_key_id;
1791#endif
1792 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001793
Gilles Peskine91e8c332019-08-02 19:19:39 +02001794 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001795 * external-only flags, query `attributes`. Thanks to the check
1796 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001797 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001798 * may have set. */
1799 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001800
Gilles Peskinecbaff462019-07-12 23:46:04 +02001801#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001802 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001803 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001804 * create the key file in internal storage, create the
1805 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001806 * persistent data. This is done by starting a transaction that will
1807 * encompass these three actions.
1808 * For registering a volatile key, we just need to find an appropriate
1809 * slot number inside the SE. Since the key is designated volatile, creating
1810 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001811 /* The first thing to do is to find a slot number for the new key.
1812 * We save the slot number in persistent storage as part of the
1813 * transaction data. It will be needed to recover if the power
1814 * fails during the key creation process, to clean up on the secure
1815 * element side after restarting. Obtaining a slot number from the
1816 * secure element driver updates its persistent state, but we do not yet
1817 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001818 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001819 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001820 psa_key_slot_number_t slot_number;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001821 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1822 &slot_number);
1823 if (status != PSA_SUCCESS) {
1824 return status;
1825 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001826
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001827 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1828 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001829 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001830 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001831 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001832 status = psa_crypto_save_transaction();
1833 if (status != PSA_SUCCESS) {
1834 (void) psa_crypto_stop_transaction();
1835 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001836 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001837 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001838
1839 status = psa_copy_key_material_into_slot(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001840 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001841 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001842
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001843 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001844 /* Key registration only makes sense with a secure element. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001845 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001846 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001847#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1848
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001849 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001850}
Gilles Peskine4747d192019-04-17 15:05:45 +02001851
1852/** Finalize the creation of a key once its key material has been set.
1853 *
1854 * This entails writing the key to persistent storage.
1855 *
1856 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001857 * See the documentation of psa_start_key_creation() for the intended use
1858 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001859 *
Ronald Cron5c522922020-11-14 16:35:34 +01001860 * If the finalization succeeds, the function unlocks the key slot (it was
1861 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1862 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001863 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001864 * \param[in,out] slot Pointer to the slot with key material.
1865 * \param[in] driver The secure element driver for the key,
1866 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001867 * \param[out] key On success, identifier of the key. Note that the
1868 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001869 *
1870 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001871 * The key was successfully created.
Gilles Peskineec1eff32023-02-14 19:21:09 +01001872 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1873 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1874 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1875 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1876 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1877 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001878 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001879 * \return If this function fails, the key slot is an invalid state.
1880 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001881 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001882static psa_status_t psa_finish_key_creation(
1883 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001884 psa_se_drv_table_entry_t *driver,
1885 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001886{
1887 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001888 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001889 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001890
1891#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001892 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001893#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001894 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001895 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001896 psa_key_slot_number_t slot_number =
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001897 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001898
Tom Cosgrovebdd01a72023-03-08 14:19:51 +00001899 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1900 sizeof(data.slot_number),
1901 "Slot number size does not match psa_se_key_data_storage_t");
1902
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001903 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1904 status = psa_save_persistent_key(&slot->attr,
1905 (uint8_t *) &data,
1906 sizeof(data));
1907 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001908#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1909 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001910 /* Key material is saved in export representation in the slot, so
1911 * just pass the slot buffer for storage. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001912 status = psa_save_persistent_key(&slot->attr,
1913 slot->key.data,
1914 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001915 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001916 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001917#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1918
Gilles Peskinecbaff462019-07-12 23:46:04 +02001919#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001920 /* Finish the transaction for a key creation. This does not
1921 * happen when registering an existing key. Detect this case
1922 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001923 * creation of a persistent key in a secure element requires a transaction,
1924 * but registration or volatile key creation doesn't use one). */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001925 if (driver != NULL &&
1926 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1927 status = psa_save_se_persistent_data(driver);
1928 if (status != PSA_SUCCESS) {
1929 psa_destroy_persistent_key(slot->attr.id);
1930 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001931 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001932 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001933 }
1934#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1935
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001936 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001937 *key = slot->attr.id;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001938 status = psa_unlock_key_slot(slot);
1939 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001940 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001941 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001942 }
Ronald Cron50972942020-11-14 11:28:25 +01001943
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001944 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001945}
1946
1947/** Abort the creation of a key.
1948 *
1949 * You may call this function after calling psa_start_key_creation(),
1950 * or after psa_finish_key_creation() fails. In other circumstances, this
1951 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001952 * See the documentation of psa_start_key_creation() for the intended use
1953 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001954 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001955 * \param[in,out] slot Pointer to the slot with key material.
1956 * \param[in] driver The secure element driver for the key,
1957 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001958 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001959static void psa_fail_key_creation(psa_key_slot_t *slot,
1960 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001961{
Gilles Peskine011e4282019-06-26 18:34:38 +02001962 (void) driver;
1963
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001964 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001965 return;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001966 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001967
1968#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001969 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001970 * element, and the failure happened later (when saving metadata
1971 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001972 * element.
1973 * https://github.com/ARMmbed/mbed-crypto/issues/217
1974 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001975
Gilles Peskined7729582019-08-05 15:55:54 +02001976 /* Abort the ongoing transaction if any (there may not be one if
1977 * the creation process failed before starting one, or if the
1978 * key creation is a registration of a key in a secure element).
1979 * Earlier functions must already have done what it takes to undo any
1980 * partial creation. All that's left is to update the transaction data
1981 * itself. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001982 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001983#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1984
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001985 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02001986}
1987
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001988/** Validate optional attributes during key creation.
1989 *
1990 * Some key attributes are optional during key creation. If they are
1991 * specified in the attributes structure, check that they are consistent
1992 * with the data in the slot.
1993 *
1994 * This function should be called near the end of key creation, after
1995 * the slot in memory is fully populated but before saving persistent data.
1996 */
1997static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001998 const psa_key_slot_t *slot,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001999 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002000{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002001 if (attributes->core.type != 0) {
2002 if (attributes->core.type != slot->attr.type) {
2003 return PSA_ERROR_INVALID_ARGUMENT;
2004 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002005 }
2006
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002007 if (attributes->domain_parameters_size != 0) {
John Durkop0e005192020-10-31 22:06:54 -07002008#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002009 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
2010 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02002011 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002012 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002013 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002014
Ronald Cron90857082020-11-25 14:58:33 +01002015 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002016 slot->attr.type,
2017 slot->key.data,
2018 slot->key.bytes,
2019 &rsa);
2020 if (status != PSA_SUCCESS) {
2021 return status;
2022 }
Steven Cooreman75b74362020-07-28 14:30:13 +02002023
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002024 mbedtls_mpi_init(&actual);
2025 mbedtls_mpi_init(&required);
2026 ret = mbedtls_rsa_export(rsa,
2027 NULL, NULL, NULL, NULL, &actual);
2028 mbedtls_rsa_free(rsa);
2029 mbedtls_free(rsa);
2030 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002031 goto rsa_exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002032 }
2033 ret = mbedtls_mpi_read_binary(&required,
2034 attributes->domain_parameters,
2035 attributes->domain_parameters_size);
2036 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002037 goto rsa_exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002038 }
2039 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002040 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002041 }
2042rsa_exit:
2043 mbedtls_mpi_free(&actual);
2044 mbedtls_mpi_free(&required);
2045 if (ret != 0) {
2046 return mbedtls_to_psa_error(ret);
2047 }
2048 } else
John Durkop9814fa22020-11-04 12:28:15 -08002049#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
2050 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002051 {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002052 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002053 }
2054 }
2055
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002056 if (attributes->core.bits != 0) {
2057 if (attributes->core.bits != slot->attr.bits) {
2058 return PSA_ERROR_INVALID_ARGUMENT;
2059 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002060 }
2061
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002062 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002063}
2064
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002065psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
Ryan Everett6b970252024-01-19 16:02:59 +00002066 const uint8_t *data_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002067 size_t data_length,
2068 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002069{
2070 psa_status_t status;
Ryan Everett6b970252024-01-19 16:02:59 +00002071 LOCAL_INPUT_DECLARE(data_external, data);
Gilles Peskine4747d192019-04-17 15:05:45 +02002072 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002073 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002074 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002075
Ronald Cron81709fc2020-11-14 12:10:32 +01002076 *key = MBEDTLS_SVC_KEY_ID_INIT;
2077
Gilles Peskine0f84d622019-09-12 19:03:13 +02002078 /* Reject zero-length symmetric keys (including raw data key objects).
2079 * This also rejects any key which might be encoded as an empty string,
2080 * which is never valid. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002081 if (data_length == 0) {
2082 return PSA_ERROR_INVALID_ARGUMENT;
2083 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002084
Ryan Everett6b970252024-01-19 16:02:59 +00002085 LOCAL_INPUT_ALLOC(data_external, data_length, data);
2086
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002087 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2088 &slot, &driver);
2089 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002090 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002091 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002092
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002093 /* In the case of a transparent key or an opaque key stored in local
2094 * storage (thus not in the case of generating a key in a secure element
2095 * or cryptoprocessor with storage), we have to allocate a buffer to
2096 * hold the generated key material. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002097 if (slot->key.data == NULL) {
2098 status = psa_allocate_buffer_to_slot(slot, data_length);
2099 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002100 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002101 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002102 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002103
2104 bits = slot->attr.bits;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002105 status = psa_driver_wrapper_import_key(attributes,
2106 data, data_length,
2107 slot->key.data,
2108 slot->key.bytes,
2109 &slot->key.bytes, &bits);
2110 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002111 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002112 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002113
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002114 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002115 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002116 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002117 status = PSA_ERROR_INVALID_ARGUMENT;
2118 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002119 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002120
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002121 status = psa_validate_optional_attributes(slot, attributes);
2122 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002123 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002124 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002125
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002126 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002127exit:
Ryan Everett6b970252024-01-19 16:02:59 +00002128 LOCAL_INPUT_FREE(data_external, data);
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002129 if (status != PSA_SUCCESS) {
2130 psa_fail_key_creation(slot, driver);
2131 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002132
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002133 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002134}
2135
Gilles Peskined7729582019-08-05 15:55:54 +02002136#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2137psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002138 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002139{
2140 psa_status_t status;
2141 psa_key_slot_t *slot = NULL;
2142 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002143 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002144
2145 /* Leaving attributes unspecified is not currently supported.
2146 * It could make sense to query the key type and size from the
2147 * secure element, but not all secure elements support this
2148 * and the driver HAL doesn't currently support it. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002149 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2150 return PSA_ERROR_NOT_SUPPORTED;
2151 }
2152 if (psa_get_key_bits(attributes) == 0) {
2153 return PSA_ERROR_NOT_SUPPORTED;
2154 }
Gilles Peskined7729582019-08-05 15:55:54 +02002155
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002156 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2157 &slot, &driver);
2158 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002159 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002160 }
Gilles Peskined7729582019-08-05 15:55:54 +02002161
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002162 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002163
2164exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002165 if (status != PSA_SUCCESS) {
2166 psa_fail_key_creation(slot, driver);
2167 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002168
Gilles Peskined7729582019-08-05 15:55:54 +02002169 /* Registration doesn't keep the key in RAM. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002170 psa_close_key(key);
2171 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002172}
2173#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2174
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002175static psa_status_t psa_copy_key_material(const psa_key_slot_t *source,
2176 psa_key_slot_t *target)
Gilles Peskinef603c712019-01-19 13:40:11 +01002177{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002178 psa_status_t status = psa_copy_key_material_into_slot(target,
2179 source->key.data,
2180 source->key.bytes);
2181 if (status != PSA_SUCCESS) {
2182 return status;
2183 }
Gilles Peskinef603c712019-01-19 13:40:11 +01002184
Steven Cooreman398aee52020-10-13 14:35:45 +02002185 target->attr.type = source->attr.type;
2186 target->attr.bits = source->attr.bits;
2187
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002188 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +01002189}
2190
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002191psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2192 const psa_key_attributes_t *specified_attributes,
2193 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002194{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002195 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002196 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002197 psa_key_slot_t *source_slot = NULL;
2198 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002199 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002200 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002201
Ronald Cron81709fc2020-11-14 12:10:32 +01002202 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2203
Ronald Cron5c522922020-11-14 16:35:34 +01002204 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002205 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2206 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002207 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002208 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002209
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002210 status = psa_validate_optional_attributes(source_slot,
2211 specified_attributes);
2212 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002213 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002214 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002215
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002216 status = psa_restrict_key_policy(source_slot->attr.type,
2217 &actual_attributes.core.policy,
2218 &source_slot->attr.policy);
2219 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002220 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002221 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002222
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002223 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2224 &target_slot, &driver);
2225 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002226 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002227 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002228
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002229#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002230 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002231 /* Copying to a secure element is not implemented yet. */
2232 status = PSA_ERROR_NOT_SUPPORTED;
2233 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002234 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002235#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002236
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002237 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
Ronald Cron6cc66312021-04-02 12:27:47 +02002238 /*
2239 * Copying through an opaque driver is not implemented yet, consider
2240 * a lifetime with an external location as an invalid parameter for
2241 * now.
2242 */
2243 status = PSA_ERROR_INVALID_ARGUMENT;
2244 goto exit;
2245 }
2246
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002247 status = psa_copy_key_material(source_slot, target_slot);
2248 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002249 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002250 }
Gilles Peskinef603c712019-01-19 13:40:11 +01002251
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002252 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002253exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002254 if (status != PSA_SUCCESS) {
2255 psa_fail_key_creation(target_slot, driver);
2256 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002257
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002258 unlock_status = psa_unlock_key_slot(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002259
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002260 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002261}
2262
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002263
2264
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002265/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002266/* Message digests */
2267/****************************************************************/
2268
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002269psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002270{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002271 /* Aborting a non-active operation is allowed */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002272 if (operation->id == 0) {
2273 return PSA_SUCCESS;
2274 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002275
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002276 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002277 operation->id = 0;
2278
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002279 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002280}
2281
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002282psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2283 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002284{
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002285 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002286
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002287 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002288 if (operation->id != 0) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002289 status = PSA_ERROR_BAD_STATE;
2290 goto exit;
2291 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002292
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002293 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002294 status = PSA_ERROR_INVALID_ARGUMENT;
2295 goto exit;
2296 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002297
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002298 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2299 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002300 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002301
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002302 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002303
2304exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002305 if (status != PSA_SUCCESS) {
2306 psa_hash_abort(operation);
2307 }
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002308
2309 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002310}
2311
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002312psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2313 const uint8_t *input,
2314 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002315{
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002316 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2317
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002318 if (operation->id == 0) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002319 status = PSA_ERROR_BAD_STATE;
2320 goto exit;
2321 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002322
Steven Cooremanc8288352021-03-04 14:02:19 +01002323 /* Don't require hash implementations to behave correctly on a
2324 * zero-length input, which may have an invalid pointer. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002325 if (input_length == 0) {
2326 return PSA_SUCCESS;
2327 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002328
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002329 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002330
2331exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002332 if (status != PSA_SUCCESS) {
2333 psa_hash_abort(operation);
2334 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002335
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002336 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002337}
2338
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002339psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2340 uint8_t *hash,
2341 size_t hash_size,
2342 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002343{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002344 *hash_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002345 if (operation->id == 0) {
2346 return PSA_ERROR_BAD_STATE;
2347 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002348
Steven Cooreman1e582352021-02-18 17:24:37 +01002349 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002350 operation, hash, hash_size, hash_length);
2351 psa_hash_abort(operation);
2352 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002353}
2354
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002355psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2356 const uint8_t *hash,
2357 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002358{
Ronald Cron3a95d2b2021-10-18 09:47:58 +02002359 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002360 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002361 psa_status_t status = psa_hash_finish(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002362 operation,
2363 actual_hash, sizeof(actual_hash),
2364 &actual_hash_length);
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002365
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002366 if (status != PSA_SUCCESS) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002367 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002368 }
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002369
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002370 if (actual_hash_length != hash_length) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002371 status = PSA_ERROR_INVALID_SIGNATURE;
2372 goto exit;
2373 }
2374
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002375 if (mbedtls_psa_safer_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002376 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002377 }
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002378
2379exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002380 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2381 if (status != PSA_SUCCESS) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002382 psa_hash_abort(operation);
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002383 }
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002384
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002385 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002386}
2387
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002388psa_status_t psa_hash_compute(psa_algorithm_t alg,
2389 const uint8_t *input, size_t input_length,
2390 uint8_t *hash, size_t hash_size,
2391 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002392{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002393 *hash_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002394 if (!PSA_ALG_IS_HASH(alg)) {
2395 return PSA_ERROR_INVALID_ARGUMENT;
2396 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002397
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002398 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2399 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002400}
2401
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002402psa_status_t psa_hash_compare(psa_algorithm_t alg,
2403 const uint8_t *input, size_t input_length,
2404 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002405{
Ronald Cron3a95d2b2021-10-18 09:47:58 +02002406 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002407 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002408
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002409 if (!PSA_ALG_IS_HASH(alg)) {
2410 return PSA_ERROR_INVALID_ARGUMENT;
2411 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002412
Steven Cooreman1e582352021-02-18 17:24:37 +01002413 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002414 alg, input, input_length,
2415 actual_hash, sizeof(actual_hash),
2416 &actual_hash_length);
2417 if (status != PSA_SUCCESS) {
Gilles Peskineb3f4e5b2021-12-13 12:33:18 +01002418 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002419 }
2420 if (actual_hash_length != hash_length) {
Gilles Peskineb3f4e5b2021-12-13 12:33:18 +01002421 status = PSA_ERROR_INVALID_SIGNATURE;
2422 goto exit;
2423 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002424 if (mbedtls_psa_safer_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskineb3f4e5b2021-12-13 12:33:18 +01002425 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002426 }
Gilles Peskineb3f4e5b2021-12-13 12:33:18 +01002427
2428exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002429 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2430 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002431}
2432
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002433psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2434 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002435{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002436 if (source_operation->id == 0 ||
2437 target_operation->id != 0) {
2438 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002439 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002440
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002441 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2442 target_operation);
2443 if (status != PSA_SUCCESS) {
2444 psa_hash_abort(target_operation);
2445 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002446
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002447 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002448}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002449
2450
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002451/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002452/* MAC */
2453/****************************************************************/
2454
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002455psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002456{
Steven Cooreman07897832021-03-19 18:28:56 +01002457 /* Aborting a non-active operation is allowed */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002458 if (operation->id == 0) {
2459 return PSA_SUCCESS;
2460 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002461
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002462 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman15f0d922021-05-07 14:14:37 +02002463 operation->mac_size = 0;
2464 operation->is_sign = 0;
Steven Cooreman07897832021-03-19 18:28:56 +01002465 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002466
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002467 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002468}
2469
Ronald Cron1c650a12021-06-17 16:33:22 +02002470static psa_status_t psa_mac_finalize_alg_and_key_validation(
2471 psa_algorithm_t alg,
Ronald Crondef68e72021-06-17 16:46:44 +02002472 const psa_key_attributes_t *attributes,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002473 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002474{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002475 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002476 psa_key_type_t key_type = psa_get_key_type(attributes);
2477 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002478
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002479 if (!PSA_ALG_IS_MAC(alg)) {
2480 return PSA_ERROR_INVALID_ARGUMENT;
2481 }
Steven Cooreman07897832021-03-19 18:28:56 +01002482
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002483 /* Validate the combination of key type and algorithm */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002484 status = psa_mac_key_can_do(alg, key_type);
2485 if (status != PSA_SUCCESS) {
2486 return status;
2487 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002488
Steven Cooremana6474de2021-05-10 11:13:41 +02002489 /* Get the output length for the algorithm and key combination */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002490 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002491
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002492 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002493 /* A very short MAC is too short for security since it can be
2494 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2495 * so we make this our minimum, even though 32 bits is still
2496 * too small for security. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002497 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002498 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002499
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002500 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2501 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002502 /* It's impossible to "truncate" to a larger length than the full length
2503 * of the algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002504 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002505 }
2506
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002507 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinebc795822022-03-16 13:54:49 +01002508 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2509 * that is disabled in the compile-time configuration. The result can
2510 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2511 * configuration into account. In this case, force a return of
2512 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2513 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2514 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2515 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2516 * systematically generated tests. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002517 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinebc795822022-03-16 13:54:49 +01002518 }
2519
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002520 return PSA_SUCCESS;
Ronald Cron1c650a12021-06-17 16:33:22 +02002521}
2522
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002523static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2524 mbedtls_svc_key_id_t key,
2525 psa_algorithm_t alg,
2526 int is_sign)
Ronald Cron1c650a12021-06-17 16:33:22 +02002527{
2528 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2529 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002530 psa_key_attributes_t attributes;
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002531 psa_key_slot_t *slot = NULL;
Ronald Cron1c650a12021-06-17 16:33:22 +02002532
2533 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002534 if (operation->id != 0) {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002535 status = PSA_ERROR_BAD_STATE;
2536 goto exit;
2537 }
Ronald Cron1c650a12021-06-17 16:33:22 +02002538
2539 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002540 key,
2541 &slot,
2542 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2543 alg);
2544 if (status != PSA_SUCCESS) {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002545 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002546 }
Ronald Cron1c650a12021-06-17 16:33:22 +02002547
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002548 attributes = (psa_key_attributes_t) {
Ronald Cron1c650a12021-06-17 16:33:22 +02002549 .core = slot->attr
2550 };
2551
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002552 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2553 &operation->mac_size);
2554 if (status != PSA_SUCCESS) {
Ronald Cron1c650a12021-06-17 16:33:22 +02002555 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002556 }
Ronald Cron1c650a12021-06-17 16:33:22 +02002557
2558 operation->is_sign = is_sign;
Steven Cooreman07897832021-03-19 18:28:56 +01002559 /* Dispatch the MAC setup call with validated input */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002560 if (is_sign) {
2561 status = psa_driver_wrapper_mac_sign_setup(operation,
2562 &attributes,
2563 slot->key.data,
2564 slot->key.bytes,
2565 alg);
2566 } else {
2567 status = psa_driver_wrapper_mac_verify_setup(operation,
2568 &attributes,
2569 slot->key.data,
2570 slot->key.bytes,
2571 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002572 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002573
Gilles Peskinefbfac682018-07-08 20:51:54 +02002574exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002575 if (status != PSA_SUCCESS) {
2576 psa_mac_abort(operation);
2577 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002578
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002579 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002580
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002581 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002582}
2583
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002584psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2585 mbedtls_svc_key_id_t key,
2586 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002587{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002588 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002589}
2590
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002591psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2592 mbedtls_svc_key_id_t key,
2593 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002594{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002595 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002596}
2597
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002598psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2599 const uint8_t *input,
2600 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002601{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002602 if (operation->id == 0) {
2603 return PSA_ERROR_BAD_STATE;
2604 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002605
Steven Cooreman11743f92021-03-19 18:38:46 +01002606 /* Don't require hash implementations to behave correctly on a
2607 * zero-length input, which may have an invalid pointer. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002608 if (input_length == 0) {
2609 return PSA_SUCCESS;
2610 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002611
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002612 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2613 input, input_length);
2614 if (status != PSA_SUCCESS) {
2615 psa_mac_abort(operation);
2616 }
Steven Cooreman11743f92021-03-19 18:38:46 +01002617
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002618 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002619}
2620
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002621psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2622 uint8_t *mac,
2623 size_t mac_size,
2624 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002625{
Steven Cooreman87885df2021-03-19 19:04:39 +01002626 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2627 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002628
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002629 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002630 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002631 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002632 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002633
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002634 if (!operation->is_sign) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002635 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002636 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002637 }
Steven Cooreman15f0d922021-05-07 14:14:37 +02002638
Steven Cooremanf8ad2122021-05-11 11:09:13 +02002639 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2640 * once all the error checks are done. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002641 if (operation->mac_size == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002642 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002643 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002644 }
Steven Cooremanf8ad2122021-05-11 11:09:13 +02002645
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002646 if (mac_size < operation->mac_size) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002647 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman478ab542021-06-25 09:09:02 +01002648 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002649 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002650
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002651 status = psa_driver_wrapper_mac_sign_finish(operation,
2652 mac, operation->mac_size,
2653 mac_length);
Steven Cooreman15f0d922021-05-07 14:14:37 +02002654
Dave Rodgman478ab542021-06-25 09:09:02 +01002655exit:
Ronald Cron882eb782021-06-18 13:05:48 +02002656 /* In case of success, set the potential excess room in the output buffer
2657 * to an invalid value, to avoid potentially leaking a longer MAC.
2658 * In case of error, set the output length and content to a safe default,
2659 * such that in case the caller misses an error check, the output would be
2660 * an unachievable MAC.
2661 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002662 if (status != PSA_SUCCESS) {
Steven Cooreman15f0d922021-05-07 14:14:37 +02002663 *mac_length = mac_size;
Ronald Cron882eb782021-06-18 13:05:48 +02002664 operation->mac_size = 0;
Steven Cooreman15f0d922021-05-07 14:14:37 +02002665 }
mohammad16036df908f2018-04-02 08:34:15 -07002666
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002667 if (mac_size > operation->mac_size) {
2668 memset(&mac[operation->mac_size], '!',
2669 mac_size - operation->mac_size);
2670 }
Ronald Cron882eb782021-06-18 13:05:48 +02002671
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002672 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002673
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002674 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002675}
2676
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002677psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2678 const uint8_t *mac,
2679 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002680{
Steven Cooreman87885df2021-03-19 19:04:39 +01002681 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2682 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002683
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002684 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002685 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002686 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002687 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002688
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002689 if (operation->is_sign) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002690 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002691 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002692 }
Steven Cooreman15f0d922021-05-07 14:14:37 +02002693
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002694 if (operation->mac_size != mac_length) {
Steven Cooreman15f0d922021-05-07 14:14:37 +02002695 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002696 goto exit;
Steven Cooreman15f0d922021-05-07 14:14:37 +02002697 }
2698
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002699 status = psa_driver_wrapper_mac_verify_finish(operation,
2700 mac, mac_length);
Steven Cooreman15f0d922021-05-07 14:14:37 +02002701
Dave Rodgman478ab542021-06-25 09:09:02 +01002702exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002703 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002704
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002705 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002706}
2707
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002708static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2709 psa_algorithm_t alg,
2710 const uint8_t *input,
2711 size_t input_length,
2712 uint8_t *mac,
2713 size_t mac_size,
2714 size_t *mac_length,
2715 int is_sign)
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002716{
2717 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crondbb86462021-06-17 17:17:20 +02002718 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002719 psa_key_attributes_t attributes;
Ronald Crondbb86462021-06-17 17:17:20 +02002720 psa_key_slot_t *slot;
2721 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002722
Ronald Crondbb86462021-06-17 17:17:20 +02002723 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002724 key,
2725 &slot,
2726 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2727 alg);
2728 if (status != PSA_SUCCESS) {
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002729 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002730 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002731
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002732 attributes = (psa_key_attributes_t) {
Ronald Crondbb86462021-06-17 17:17:20 +02002733 .core = slot->attr
2734 };
2735
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002736 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2737 &operation_mac_size);
2738 if (status != PSA_SUCCESS) {
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002739 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002740 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002741
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002742 if (mac_size < operation_mac_size) {
Ronald Crondbb86462021-06-17 17:17:20 +02002743 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002744 goto exit;
Ronald Crondbb86462021-06-17 17:17:20 +02002745 }
2746
2747 status = psa_driver_wrapper_mac_compute(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002748 &attributes,
2749 slot->key.data, slot->key.bytes,
2750 alg,
2751 input, input_length,
2752 mac, operation_mac_size, mac_length);
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002753
2754exit:
Ronald Cron882eb782021-06-18 13:05:48 +02002755 /* In case of success, set the potential excess room in the output buffer
2756 * to an invalid value, to avoid potentially leaking a longer MAC.
2757 * In case of error, set the output length and content to a safe default,
2758 * such that in case the caller misses an error check, the output would be
2759 * an unachievable MAC.
2760 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002761 if (status != PSA_SUCCESS) {
Ronald Crondbb86462021-06-17 17:17:20 +02002762 *mac_length = mac_size;
Ronald Cron882eb782021-06-18 13:05:48 +02002763 operation_mac_size = 0;
Ronald Crondbb86462021-06-17 17:17:20 +02002764 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002765 if (mac_size > operation_mac_size) {
2766 memset(&mac[operation_mac_size], '!', mac_size - operation_mac_size);
2767 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002768
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002769 unlock_status = psa_unlock_key_slot(slot);
Ronald Crondbb86462021-06-17 17:17:20 +02002770
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002771 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002772}
2773
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002774psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002775 psa_algorithm_t alg,
2776 const uint8_t *input,
2777 size_t input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002778 uint8_t *mac,
2779 size_t mac_size,
2780 size_t *mac_length)
2781{
2782 return psa_mac_compute_internal(key, alg,
2783 input, input_length,
2784 mac, mac_size, mac_length, 1);
2785}
2786
2787psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2788 psa_algorithm_t alg,
2789 const uint8_t *input,
2790 size_t input_length,
2791 const uint8_t *mac,
2792 size_t mac_length)
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002793{
2794 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron4ed83682021-06-18 14:51:29 +02002795 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2796 size_t actual_mac_length;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002797
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002798 status = psa_mac_compute_internal(key, alg,
2799 input, input_length,
2800 actual_mac, sizeof(actual_mac),
2801 &actual_mac_length, 0);
2802 if (status != PSA_SUCCESS) {
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002803 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002804 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002805
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002806 if (mac_length != actual_mac_length) {
Ronald Cron4ed83682021-06-18 14:51:29 +02002807 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002808 goto exit;
Ronald Cron4ed83682021-06-18 14:51:29 +02002809 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002810 if (mbedtls_psa_safer_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Cron4ed83682021-06-18 14:51:29 +02002811 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002812 goto exit;
Ronald Cron4ed83682021-06-18 14:51:29 +02002813 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002814
2815exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002816 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002817
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002818 return status;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002819}
Gilles Peskine20035e32018-02-03 22:44:14 +01002820
Gilles Peskine20035e32018-02-03 22:44:14 +01002821/****************************************************************/
2822/* Asymmetric cryptography */
2823/****************************************************************/
2824
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002825static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2826 psa_algorithm_t alg)
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002827{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002828 if (input_is_message) {
2829 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2830 return PSA_ERROR_INVALID_ARGUMENT;
2831 }
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002832
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002833 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2834 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2835 return PSA_ERROR_INVALID_ARGUMENT;
2836 }
2837 }
2838 } else {
2839 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2840 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm56980482021-05-05 13:56:27 +02002841 }
2842 }
gabor-mezei-arm56980482021-05-05 13:56:27 +02002843
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002844 return PSA_SUCCESS;
gabor-mezei-arm56980482021-05-05 13:56:27 +02002845}
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002846
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002847static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2848 int input_is_message,
2849 psa_algorithm_t alg,
2850 const uint8_t *input,
2851 size_t input_length,
2852 uint8_t *signature,
2853 size_t signature_size,
2854 size_t *signature_length)
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002855{
2856 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2857 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002858 psa_key_attributes_t attributes;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002859 psa_key_slot_t *slot;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002860
2861 *signature_length = 0;
2862
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002863 status = psa_sign_verify_check_alg(input_is_message, alg);
2864 if (status != PSA_SUCCESS) {
gabor-mezei-arm56980482021-05-05 13:56:27 +02002865 return status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002866 }
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002867
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002868 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12ff4d52021-05-05 13:54:55 +02002869 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002870 * buffer can in principle be empty since it doesn't actually have
2871 * to be a hash.) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002872 if (signature_size == 0) {
2873 return PSA_ERROR_BUFFER_TOO_SMALL;
2874 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002875
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002876 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002877 key, &slot,
2878 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2879 PSA_KEY_USAGE_SIGN_HASH,
2880 alg);
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002881
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002882 if (status != PSA_SUCCESS) {
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002883 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002884 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002885
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002886 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002887 status = PSA_ERROR_INVALID_ARGUMENT;
2888 goto exit;
2889 }
2890
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002891 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002892 .core = slot->attr
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002893 };
2894
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002895 if (input_is_message) {
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002896 status = psa_driver_wrapper_sign_message(
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002897 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002898 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002899 signature, signature_size, signature_length);
2900 } else {
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002901
2902 status = psa_driver_wrapper_sign_hash(
2903 &attributes, slot->key.data, slot->key.bytes,
2904 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002905 signature, signature_size, signature_length);
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002906 }
2907
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002908
2909exit:
2910 /* Fill the unused part of the output buffer (the whole buffer on error,
2911 * the trailing part on success) with something that isn't a valid signature
2912 * (barring an attack on the signature and deliberately-crafted input),
2913 * in case the caller doesn't check the return status properly. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002914 if (status == PSA_SUCCESS) {
2915 memset(signature + *signature_length, '!',
2916 signature_size - *signature_length);
2917 } else {
2918 memset(signature, '!', signature_size);
2919 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002920 /* If signature_size is 0 then we have nothing to do. We must not call
2921 * memset because signature may be NULL in this case. */
2922
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002923 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002924
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002925 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002926}
2927
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002928static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2929 int input_is_message,
2930 psa_algorithm_t alg,
2931 const uint8_t *input,
2932 size_t input_length,
2933 const uint8_t *signature,
2934 size_t signature_length)
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002935{
2936 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2937 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2938 psa_key_slot_t *slot;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002939
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002940 status = psa_sign_verify_check_alg(input_is_message, alg);
2941 if (status != PSA_SUCCESS) {
gabor-mezei-arm56980482021-05-05 13:56:27 +02002942 return status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002943 }
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002944
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002945 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002946 key, &slot,
2947 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2948 PSA_KEY_USAGE_VERIFY_HASH,
2949 alg);
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002950
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002951 if (status != PSA_SUCCESS) {
2952 return status;
2953 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002954
2955 psa_key_attributes_t attributes = {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002956 .core = slot->attr
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002957 };
2958
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002959 if (input_is_message) {
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002960 status = psa_driver_wrapper_verify_message(
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002961 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002962 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002963 signature, signature_length);
2964 } else {
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002965 status = psa_driver_wrapper_verify_hash(
2966 &attributes, slot->key.data, slot->key.bytes,
2967 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002968 signature, signature_length);
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002969 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002970
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002971 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002972
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002973 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002974
2975}
2976
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002977psa_status_t psa_sign_message_builtin(
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002978 const psa_key_attributes_t *attributes,
2979 const uint8_t *key_buffer,
2980 size_t key_buffer_size,
2981 psa_algorithm_t alg,
2982 const uint8_t *input,
2983 size_t input_length,
2984 uint8_t *signature,
2985 size_t signature_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002986 size_t *signature_length)
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002987{
2988 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002989
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002990 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002991 size_t hash_length;
2992 uint8_t hash[PSA_HASH_MAX_SIZE];
2993
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002994 status = psa_driver_wrapper_hash_compute(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002995 PSA_ALG_SIGN_GET_HASH(alg),
2996 input, input_length,
2997 hash, sizeof(hash), &hash_length);
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002998
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002999 if (status != PSA_SUCCESS) {
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02003000 return status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003001 }
gabor-mezei-arm9719a842021-05-03 16:26:20 +02003002
3003 return psa_driver_wrapper_sign_hash(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003004 attributes, key_buffer, key_buffer_size,
3005 alg, hash, hash_length,
3006 signature, signature_size, signature_length);
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02003007 }
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003008
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003009 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003010}
3011
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003012psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3013 psa_algorithm_t alg,
Thomas Daubney290aac42024-01-18 17:23:02 +00003014 const uint8_t *input_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003015 size_t input_length,
Thomas Daubney290aac42024-01-18 17:23:02 +00003016 uint8_t *signature_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003017 size_t signature_size,
3018 size_t *signature_length)
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003019{
Thomas Daubney290aac42024-01-18 17:23:02 +00003020 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3021 LOCAL_INPUT_DECLARE(input_external, input);
3022 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3023
3024 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3025 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3026 status = psa_sign_internal(key, 1, alg, input, input_length, signature,
3027 signature_size, signature_length);
3028
Thomas Daubneyf446b892024-01-30 13:36:01 +00003029#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney290aac42024-01-18 17:23:02 +00003030exit:
Thomas Daubneyf446b892024-01-30 13:36:01 +00003031#endif
Thomas Daubney290aac42024-01-18 17:23:02 +00003032 LOCAL_INPUT_FREE(input_external, input);
3033 LOCAL_OUTPUT_FREE(signature_external, signature);
3034 return status;
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003035}
3036
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02003037psa_status_t psa_verify_message_builtin(
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003038 const psa_key_attributes_t *attributes,
3039 const uint8_t *key_buffer,
3040 size_t key_buffer_size,
3041 psa_algorithm_t alg,
3042 const uint8_t *input,
3043 size_t input_length,
3044 const uint8_t *signature,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003045 size_t signature_length)
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003046{
3047 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003048
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003049 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-arm9719a842021-05-03 16:26:20 +02003050 size_t hash_length;
3051 uint8_t hash[PSA_HASH_MAX_SIZE];
3052
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02003053 status = psa_driver_wrapper_hash_compute(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003054 PSA_ALG_SIGN_GET_HASH(alg),
3055 input, input_length,
3056 hash, sizeof(hash), &hash_length);
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003057
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003058 if (status != PSA_SUCCESS) {
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02003059 return status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003060 }
gabor-mezei-arm9719a842021-05-03 16:26:20 +02003061
3062 return psa_driver_wrapper_verify_hash(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003063 attributes, key_buffer, key_buffer_size,
3064 alg, hash, hash_length,
3065 signature, signature_length);
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02003066 }
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003067
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003068 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003069}
3070
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003071psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3072 psa_algorithm_t alg,
Thomas Daubney290aac42024-01-18 17:23:02 +00003073 const uint8_t *input_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003074 size_t input_length,
Thomas Daubney290aac42024-01-18 17:23:02 +00003075 const uint8_t *signature_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003076 size_t signature_length)
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003077{
Thomas Daubney290aac42024-01-18 17:23:02 +00003078 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3079 LOCAL_INPUT_DECLARE(input_external, input);
3080 LOCAL_INPUT_DECLARE(signature_external, signature);
3081
3082 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3083 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3084 status = psa_verify_internal(key, 1, alg, input, input_length, signature,
3085 signature_length);
3086
Thomas Daubneyf446b892024-01-30 13:36:01 +00003087#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney290aac42024-01-18 17:23:02 +00003088exit:
Thomas Daubneyf446b892024-01-30 13:36:01 +00003089#endif
Thomas Daubney290aac42024-01-18 17:23:02 +00003090 LOCAL_INPUT_FREE(input_external, input);
3091 LOCAL_INPUT_FREE(signature_external, signature);
3092
3093 return status;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02003094}
3095
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02003096psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003097 const psa_key_attributes_t *attributes,
3098 const uint8_t *key_buffer, size_t key_buffer_size,
3099 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003100 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskine20035e32018-02-03 22:44:14 +01003101{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003102 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3103 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3104 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003105#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003106 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3107 return mbedtls_psa_rsa_sign_hash(
3108 attributes,
3109 key_buffer, key_buffer_size,
3110 alg, hash, hash_length,
3111 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003112#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3113 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003114 } else {
3115 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003116 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003117 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3118 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003119#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003120 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3121 return mbedtls_psa_ecdsa_sign_hash(
3122 attributes,
3123 key_buffer, key_buffer_size,
3124 alg, hash, hash_length,
3125 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003126#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3127 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003128 } else {
3129 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003130 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003131 }
Ronald Cron4501c982021-03-19 20:09:32 +01003132
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003133 (void) key_buffer;
3134 (void) key_buffer_size;
3135 (void) hash;
3136 (void) hash_length;
3137 (void) signature;
3138 (void) signature_size;
3139 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003140
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003141 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003142}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003143
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003144psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3145 psa_algorithm_t alg,
Thomas Daubney290aac42024-01-18 17:23:02 +00003146 const uint8_t *hash_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003147 size_t hash_length,
Thomas Daubney290aac42024-01-18 17:23:02 +00003148 uint8_t *signature_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003149 size_t signature_size,
3150 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003151{
Thomas Daubney290aac42024-01-18 17:23:02 +00003152 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3153 LOCAL_INPUT_DECLARE(hash_external, hash);
3154 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3155
3156 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3157 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3158 status = psa_sign_internal(key, 0, alg, hash, hash_length, signature,
3159 signature_size, signature_length);
3160
Thomas Daubneyf446b892024-01-30 13:36:01 +00003161#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney290aac42024-01-18 17:23:02 +00003162exit:
Thomas Daubneyf446b892024-01-30 13:36:01 +00003163#endif
Thomas Daubney290aac42024-01-18 17:23:02 +00003164 LOCAL_INPUT_FREE(hash_external, hash);
3165 LOCAL_OUTPUT_FREE(signature_external, signature);
3166
3167 return status;
itayzafrir5c753392018-05-08 11:18:38 +03003168}
3169
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02003170psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003171 const psa_key_attributes_t *attributes,
3172 const uint8_t *key_buffer, size_t key_buffer_size,
3173 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003174 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003175{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003176 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3177 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3178 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003179#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003180 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3181 return mbedtls_psa_rsa_verify_hash(
3182 attributes,
3183 key_buffer, key_buffer_size,
3184 alg, hash, hash_length,
3185 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003186#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3187 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003188 } else {
3189 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003190 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003191 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3192 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003193#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003194 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3195 return mbedtls_psa_ecdsa_verify_hash(
3196 attributes,
3197 key_buffer, key_buffer_size,
3198 alg, hash, hash_length,
3199 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003200#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3201 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003202 } else {
3203 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003204 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003205 }
Ronald Cron4501c982021-03-19 20:09:32 +01003206
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003207 (void) key_buffer;
3208 (void) key_buffer_size;
3209 (void) hash;
3210 (void) hash_length;
3211 (void) signature;
3212 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003213
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003214 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003215}
3216
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003217psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3218 psa_algorithm_t alg,
Thomas Daubney290aac42024-01-18 17:23:02 +00003219 const uint8_t *hash_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003220 size_t hash_length,
Thomas Daubney290aac42024-01-18 17:23:02 +00003221 const uint8_t *signature_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003222 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003223{
Thomas Daubney290aac42024-01-18 17:23:02 +00003224 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3225 LOCAL_INPUT_DECLARE(hash_external, hash);
3226 LOCAL_INPUT_DECLARE(signature_external, signature);
3227
3228 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3229 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3230 status = psa_verify_internal(key, 0, alg, hash, hash_length, signature,
3231 signature_length);
3232
Thomas Daubneyf446b892024-01-30 13:36:01 +00003233#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney290aac42024-01-18 17:23:02 +00003234exit:
Thomas Daubneyf446b892024-01-30 13:36:01 +00003235#endif
Thomas Daubney290aac42024-01-18 17:23:02 +00003236 LOCAL_INPUT_FREE(hash_external, hash);
3237 LOCAL_INPUT_FREE(signature_external, signature);
3238
3239 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01003240}
3241
John Durkop0e005192020-10-31 22:06:54 -07003242#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003243static void psa_rsa_oaep_set_padding_mode(psa_algorithm_t alg,
3244 mbedtls_rsa_context *rsa)
Gilles Peskine072ac562018-06-30 00:21:29 +02003245{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003246 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH(alg);
3247 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa(hash_alg);
3248 mbedtls_md_type_t md_alg = mbedtls_md_get_type(md_info);
3249 mbedtls_rsa_set_padding(rsa, MBEDTLS_RSA_PKCS_V21, md_alg);
Gilles Peskine072ac562018-06-30 00:21:29 +02003250}
John Durkop0e005192020-10-31 22:06:54 -07003251#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003252
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003253psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3254 psa_algorithm_t alg,
3255 const uint8_t *input,
3256 size_t input_length,
3257 const uint8_t *salt,
3258 size_t salt_length,
3259 uint8_t *output,
3260 size_t output_size,
3261 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003262{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003263 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003264 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003265 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003266
Darryl Green5cc689a2018-07-24 15:34:10 +01003267 (void) input;
3268 (void) input_length;
3269 (void) salt;
3270 (void) output;
3271 (void) output_size;
3272
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003273 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003274
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003275 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3276 return PSA_ERROR_INVALID_ARGUMENT;
3277 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003278
Ronald Cron5c522922020-11-14 16:35:34 +01003279 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003280 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3281 if (status != PSA_SUCCESS) {
3282 return status;
3283 }
3284 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3285 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003286 status = PSA_ERROR_INVALID_ARGUMENT;
3287 goto exit;
3288 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003289
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003290 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Ronald Cron7207d572021-09-08 14:28:35 +02003291#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003292 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooremana2371e52020-07-28 14:30:39 +02003293 mbedtls_rsa_context *rsa = NULL;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003294 status = mbedtls_psa_rsa_load_representation(slot->attr.type,
3295 slot->key.data,
3296 slot->key.bytes,
3297 &rsa);
3298 if (status != PSA_SUCCESS) {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003299 goto rsa_exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003300 }
Steven Cooremana2371e52020-07-28 14:30:39 +02003301
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003302 if (output_size < mbedtls_rsa_get_len(rsa)) {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003303 status = PSA_ERROR_BUFFER_TOO_SMALL;
3304 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003305 }
Ronald Cron7207d572021-09-08 14:28:35 +02003306#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3307 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003308 if (alg == PSA_ALG_RSA_PKCS1V15_CRYPT) {
Ronald Cron7207d572021-09-08 14:28:35 +02003309#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003310 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003311 mbedtls_rsa_pkcs1_encrypt(rsa,
3312 mbedtls_psa_get_random,
3313 MBEDTLS_PSA_RANDOM_STATE,
3314 MBEDTLS_RSA_PUBLIC,
3315 input_length,
3316 input,
3317 output));
Ronald Cron7207d572021-09-08 14:28:35 +02003318#else
3319 status = PSA_ERROR_NOT_SUPPORTED;
3320#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003321 } else
3322 if (PSA_ALG_IS_RSA_OAEP(alg)) {
Ronald Cron7207d572021-09-08 14:28:35 +02003323#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003324 psa_rsa_oaep_set_padding_mode(alg, rsa);
Steven Cooreman4fed4552020-08-03 14:46:03 +02003325 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003326 mbedtls_rsa_rsaes_oaep_encrypt(rsa,
3327 mbedtls_psa_get_random,
3328 MBEDTLS_PSA_RANDOM_STATE,
3329 MBEDTLS_RSA_PUBLIC,
3330 salt, salt_length,
3331 input_length,
3332 input,
3333 output));
Ronald Cron7207d572021-09-08 14:28:35 +02003334#else
3335 status = PSA_ERROR_NOT_SUPPORTED;
3336#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003337 } else {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003338 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003339 }
Ronald Cron7207d572021-09-08 14:28:35 +02003340#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003341 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003342rsa_exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003343 if (status == PSA_SUCCESS) {
3344 *output_length = mbedtls_rsa_get_len(rsa);
3345 }
Steven Cooremana01795d2020-07-24 22:48:15 +02003346
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003347 mbedtls_rsa_free(rsa);
3348 mbedtls_free(rsa);
John Durkop9814fa22020-11-04 12:28:15 -08003349#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003350 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003351 } else {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003352 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003353 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003354
3355exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003356 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003357
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003358 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003359}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003360
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003361psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3362 psa_algorithm_t alg,
3363 const uint8_t *input,
3364 size_t input_length,
3365 const uint8_t *salt,
3366 size_t salt_length,
3367 uint8_t *output,
3368 size_t output_size,
3369 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003370{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003371 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003372 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003373 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003374
Darryl Green5cc689a2018-07-24 15:34:10 +01003375 (void) input;
3376 (void) input_length;
3377 (void) salt;
3378 (void) output;
3379 (void) output_size;
3380
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003381 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003382
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003383 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3384 return PSA_ERROR_INVALID_ARGUMENT;
3385 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003386
Ronald Cron5c522922020-11-14 16:35:34 +01003387 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003388 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3389 if (status != PSA_SUCCESS) {
3390 return status;
3391 }
3392 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003393 status = PSA_ERROR_INVALID_ARGUMENT;
3394 goto exit;
3395 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003396
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003397 if (slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
Ronald Cron7207d572021-09-08 14:28:35 +02003398#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003399 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003400 mbedtls_rsa_context *rsa = NULL;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003401 status = mbedtls_psa_rsa_load_representation(slot->attr.type,
3402 slot->key.data,
3403 slot->key.bytes,
3404 &rsa);
3405 if (status != PSA_SUCCESS) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003406 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003407 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003408
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003409 if (input_length != mbedtls_rsa_get_len(rsa)) {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003410 status = PSA_ERROR_INVALID_ARGUMENT;
3411 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003412 }
Ronald Cron7207d572021-09-08 14:28:35 +02003413#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3414 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003415
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003416 if (alg == PSA_ALG_RSA_PKCS1V15_CRYPT) {
Ronald Cron7207d572021-09-08 14:28:35 +02003417#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003418 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003419 mbedtls_rsa_pkcs1_decrypt(rsa,
3420 mbedtls_psa_get_random,
3421 MBEDTLS_PSA_RANDOM_STATE,
3422 MBEDTLS_RSA_PRIVATE,
3423 output_length,
3424 input,
3425 output,
3426 output_size));
Ronald Cron7207d572021-09-08 14:28:35 +02003427#else
3428 status = PSA_ERROR_NOT_SUPPORTED;
3429#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003430 } else
3431 if (PSA_ALG_IS_RSA_OAEP(alg)) {
Ronald Cron7207d572021-09-08 14:28:35 +02003432#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003433 psa_rsa_oaep_set_padding_mode(alg, rsa);
Steven Cooreman4fed4552020-08-03 14:46:03 +02003434 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003435 mbedtls_rsa_rsaes_oaep_decrypt(rsa,
3436 mbedtls_psa_get_random,
3437 MBEDTLS_PSA_RANDOM_STATE,
3438 MBEDTLS_RSA_PRIVATE,
3439 salt, salt_length,
3440 output_length,
3441 input,
3442 output,
3443 output_size));
Ronald Cron7207d572021-09-08 14:28:35 +02003444#else
3445 status = PSA_ERROR_NOT_SUPPORTED;
3446#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003447 } else {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003448 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003449 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003450
Ronald Cron7207d572021-09-08 14:28:35 +02003451#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003452 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003453rsa_exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003454 mbedtls_rsa_free(rsa);
3455 mbedtls_free(rsa);
John Durkop6ba40d12020-11-10 08:50:04 -08003456#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3457 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003458 } else {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003459 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003460 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003461
3462exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003463 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003464
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003465 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003466}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003467
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003468
3469
mohammad1603503973b2018-03-12 15:59:30 +02003470/****************************************************************/
3471/* Symmetric cryptography */
3472/****************************************************************/
3473
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003474static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
3475 mbedtls_svc_key_id_t key,
3476 psa_algorithm_t alg,
3477 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02003478{
3479 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3480 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003481 psa_key_attributes_t attributes;
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003482 psa_key_slot_t *slot = NULL;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003483 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
3484 PSA_KEY_USAGE_ENCRYPT :
3485 PSA_KEY_USAGE_DECRYPT);
Ronald Cronab99ac22020-10-01 16:38:28 +02003486
3487 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003488 if (operation->id != 0) {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003489 status = PSA_ERROR_BAD_STATE;
3490 goto exit;
3491 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003492
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003493 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003494 status = PSA_ERROR_INVALID_ARGUMENT;
3495 goto exit;
3496 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003497
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003498 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
3499 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003500 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003501 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003502
Ronald Cron49fafa92021-03-10 08:34:23 +01003503 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003504 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003505 * so we only set it (in the driver wrapper) after resources have been
3506 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003507 operation->iv_set = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003508 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003509 operation->iv_required = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003510 } else if (slot->attr.type == PSA_KEY_TYPE_ARC4) {
Gilles Peskine4a83c102022-04-20 17:00:22 +02003511 operation->iv_required = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003512 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02003513 operation->iv_required = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003514 }
3515 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02003516
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003517 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003518 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01003519 };
3520
Ronald Cronab99ac22020-10-01 16:38:28 +02003521 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003522 if (cipher_operation == MBEDTLS_ENCRYPT) {
3523 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
3524 &attributes,
3525 slot->key.data,
3526 slot->key.bytes,
3527 alg);
3528 } else {
3529 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
3530 &attributes,
3531 slot->key.data,
3532 slot->key.bytes,
3533 alg);
3534 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003535
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003536exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003537 if (status != PSA_SUCCESS) {
3538 psa_cipher_abort(operation);
3539 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003540
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003541 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003542
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003543 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02003544}
3545
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003546psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
3547 mbedtls_svc_key_id_t key,
3548 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003549{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003550 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003551}
3552
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003553psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
3554 mbedtls_svc_key_id_t key,
3555 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003556{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003557 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003558}
3559
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003560psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
3561 uint8_t *iv,
3562 size_t iv_size,
3563 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02003564{
Ronald Cron6d051732020-10-01 14:10:20 +02003565 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc423acb2021-07-05 12:31:44 +02003566 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergey04eb7c02023-03-06 15:37:23 -07003567 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01003568
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003569 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003570 status = PSA_ERROR_BAD_STATE;
3571 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003572 }
3573
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003574 if (operation->iv_set || !operation->iv_required) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003575 status = PSA_ERROR_BAD_STATE;
3576 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003577 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003578
Ronald Cronc423acb2021-07-05 12:31:44 +02003579 default_iv_length = operation->default_iv_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003580 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01003581 status = PSA_ERROR_BUFFER_TOO_SMALL;
3582 goto exit;
3583 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003584
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003585 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc423acb2021-07-05 12:31:44 +02003586 status = PSA_ERROR_GENERIC_ERROR;
3587 goto exit;
3588 }
3589
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003590 status = psa_generate_random(local_iv, default_iv_length);
3591 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01003592 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003593 }
Ronald Cron5618a392021-03-26 09:52:26 +01003594
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003595 status = psa_driver_wrapper_cipher_set_iv(operation,
3596 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01003597
3598exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003599 if (status == PSA_SUCCESS) {
3600 memcpy(iv, local_iv, default_iv_length);
Ronald Cronc423acb2021-07-05 12:31:44 +02003601 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02003602 operation->iv_set = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003603 } else {
Ronald Cronc423acb2021-07-05 12:31:44 +02003604 *iv_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003605 psa_cipher_abort(operation);
Ronald Cronc423acb2021-07-05 12:31:44 +02003606 }
Ronald Cron6d051732020-10-01 14:10:20 +02003607
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003608 return status;
mohammad1603503973b2018-03-12 15:59:30 +02003609}
3610
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003611psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
3612 const uint8_t *iv,
3613 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02003614{
Ronald Cron6d051732020-10-01 14:10:20 +02003615 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003616
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003617 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003618 status = PSA_ERROR_BAD_STATE;
3619 goto exit;
3620 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003621
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003622 if (operation->iv_set || !operation->iv_required) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003623 status = PSA_ERROR_BAD_STATE;
3624 goto exit;
3625 }
Ronald Crona0d68172021-03-26 10:15:08 +01003626
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003627 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003628 status = PSA_ERROR_INVALID_ARGUMENT;
3629 goto exit;
3630 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003631
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003632 status = psa_driver_wrapper_cipher_set_iv(operation,
3633 iv,
3634 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02003635
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003636exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003637 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03003638 operation->iv_set = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003639 } else {
3640 psa_cipher_abort(operation);
3641 }
3642 return status;
mohammad1603503973b2018-03-12 15:59:30 +02003643}
3644
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003645psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
3646 const uint8_t *input,
3647 size_t input_length,
3648 uint8_t *output,
3649 size_t output_size,
3650 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02003651{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003652 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003653
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003654 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003655 status = PSA_ERROR_BAD_STATE;
3656 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003657 }
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003658
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003659 if (operation->iv_required && !operation->iv_set) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003660 status = PSA_ERROR_BAD_STATE;
3661 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003662 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003663
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003664 status = psa_driver_wrapper_cipher_update(operation,
3665 input,
3666 input_length,
3667 output,
3668 output_size,
3669 output_length);
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003670
3671exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003672 if (status != PSA_SUCCESS) {
3673 psa_cipher_abort(operation);
3674 }
Ronald Cron6d051732020-10-01 14:10:20 +02003675
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003676 return status;
mohammad1603503973b2018-03-12 15:59:30 +02003677}
3678
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003679psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
3680 uint8_t *output,
3681 size_t output_size,
3682 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02003683{
David Saadab4ecc272019-02-14 13:48:10 +02003684 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003685
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003686 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003687 status = PSA_ERROR_BAD_STATE;
3688 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003689 }
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003690
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003691 if (operation->iv_required && !operation->iv_set) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003692 status = PSA_ERROR_BAD_STATE;
3693 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003694 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003695
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003696 status = psa_driver_wrapper_cipher_finish(operation,
3697 output,
3698 output_size,
3699 output_length);
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003700
3701exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003702 if (status == PSA_SUCCESS) {
3703 return psa_cipher_abort(operation);
3704 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02003705 *output_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003706 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01003707
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003708 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003709 }
mohammad1603503973b2018-03-12 15:59:30 +02003710}
3711
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003712psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02003713{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003714 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02003715 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003716 * in use. It's ok to call abort on such an object, and there's
3717 * nothing to do. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003718 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02003719 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003720
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003721 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02003722
Ronald Cron49fafa92021-03-10 08:34:23 +01003723 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003724 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003725 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003726
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003727 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02003728}
3729
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003730psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
3731 psa_algorithm_t alg,
David Horstmann926193a2023-12-13 15:55:25 +00003732 const uint8_t *input_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003733 size_t input_length,
David Horstmann926193a2023-12-13 15:55:25 +00003734 uint8_t *output_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003735 size_t output_size,
3736 size_t *output_length)
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003737{
3738 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003739 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003740 psa_key_attributes_t attributes;
Ronald Cron16377072021-07-08 19:00:07 +02003741 psa_key_slot_t *slot = NULL;
Ronald Cron4c224fe2021-07-09 18:44:58 +02003742 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
3743 size_t default_iv_length = 0;
gabor-mezei-arm52ae8712021-06-25 15:21:11 +02003744
David Horstmannb80e35a2023-12-14 18:12:47 +00003745 LOCAL_INPUT_DECLARE(input_external, input);
3746 LOCAL_OUTPUT_DECLARE(output_external, output);
3747
David Horstmann926193a2023-12-13 15:55:25 +00003748 LOCAL_INPUT_ALLOC(input_external, input_length, input);
David Horstmann926193a2023-12-13 15:55:25 +00003749 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmannd2ad8862023-11-27 17:43:05 +00003750
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003751 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron16377072021-07-08 19:00:07 +02003752 status = PSA_ERROR_INVALID_ARGUMENT;
3753 goto exit;
3754 }
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003755
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003756 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3757 PSA_KEY_USAGE_ENCRYPT,
3758 alg);
3759 if (status != PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003760 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003761 }
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003762
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003763 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003764 .core = slot->attr
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003765 };
3766
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003767 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
3768 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron4c224fe2021-07-09 18:44:58 +02003769 status = PSA_ERROR_GENERIC_ERROR;
3770 goto exit;
3771 }
3772
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003773 if (default_iv_length > 0) {
3774 if (output_size < default_iv_length) {
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003775 status = PSA_ERROR_BUFFER_TOO_SMALL;
3776 goto exit;
3777 }
3778
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003779 status = psa_generate_random(local_iv, default_iv_length);
3780 if (status != PSA_SUCCESS) {
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003781 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003782 }
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003783 }
3784
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003785 status = psa_driver_wrapper_cipher_encrypt(
3786 &attributes, slot->key.data, slot->key.bytes,
Ronald Cron4c224fe2021-07-09 18:44:58 +02003787 alg, local_iv, default_iv_length, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003788 mbedtls_buffer_offset(output, default_iv_length),
3789 output_size - default_iv_length, output_length);
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003790
3791exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003792 unlock_status = psa_unlock_key_slot(slot);
3793 if (status == PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003794 status = unlock_status;
Ronald Cron4c224fe2021-07-09 18:44:58 +02003795 }
Ronald Cron16377072021-07-08 19:00:07 +02003796
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003797 if (status == PSA_SUCCESS) {
3798 if (default_iv_length > 0) {
3799 memcpy(output, local_iv, default_iv_length);
3800 }
3801 *output_length += default_iv_length;
3802 } else {
3803 *output_length = 0;
3804 }
3805
David Horstmannb80e35a2023-12-14 18:12:47 +00003806 LOCAL_INPUT_FREE(input_external, input);
3807 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannd2ad8862023-11-27 17:43:05 +00003808
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003809 return status;
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003810}
3811
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003812psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
3813 psa_algorithm_t alg,
3814 const uint8_t *input,
3815 size_t input_length,
3816 uint8_t *output,
3817 size_t output_size,
3818 size_t *output_length)
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003819{
3820 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003821 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003822 psa_key_attributes_t attributes;
Ronald Cron16377072021-07-08 19:00:07 +02003823 psa_key_slot_t *slot = NULL;
gabor-mezei-arm52ae8712021-06-25 15:21:11 +02003824
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003825 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron16377072021-07-08 19:00:07 +02003826 status = PSA_ERROR_INVALID_ARGUMENT;
3827 goto exit;
3828 }
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003829
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003830 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3831 PSA_KEY_USAGE_DECRYPT,
3832 alg);
3833 if (status != PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003834 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003835 }
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003836
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003837 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003838 .core = slot->attr
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003839 };
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003840
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003841 if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm3fd792d2021-06-25 15:25:38 +02003842 status = PSA_ERROR_INVALID_ARGUMENT;
3843 goto exit;
3844 }
3845
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003846 status = psa_driver_wrapper_cipher_decrypt(
3847 &attributes, slot->key.data, slot->key.bytes,
3848 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003849 output, output_size, output_length);
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003850
gabor-mezei-arm3fd792d2021-06-25 15:25:38 +02003851exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003852 unlock_status = psa_unlock_key_slot(slot);
3853 if (status == PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003854 status = unlock_status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003855 }
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003856
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003857 if (status != PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003858 *output_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003859 }
Ronald Cron16377072021-07-08 19:00:07 +02003860
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003861 return status;
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003862}
3863
3864
mohammad16035955c982018-04-26 00:53:03 +03003865/****************************************************************/
3866/* AEAD */
3867/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003868
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003869psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
3870 psa_algorithm_t alg,
3871 const uint8_t *nonce,
3872 size_t nonce_length,
3873 const uint8_t *additional_data,
3874 size_t additional_data_length,
3875 const uint8_t *plaintext,
3876 size_t plaintext_length,
3877 uint8_t *ciphertext,
3878 size_t ciphertext_size,
3879 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03003880{
Ronald Cron215633c2021-03-16 17:15:37 +01003881 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3882 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003883
mohammad1603f08a5502018-06-03 15:05:47 +03003884 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003885
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003886 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
3887 return PSA_ERROR_NOT_SUPPORTED;
3888 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01003889
Ronald Cron9a986162021-03-26 12:40:07 +01003890 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003891 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3892 if (status != PSA_SUCCESS) {
3893 return status;
3894 }
mohammad16035955c982018-04-26 00:53:03 +03003895
Ronald Cron215633c2021-03-16 17:15:37 +01003896 psa_key_attributes_t attributes = {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003897 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01003898 };
mohammad16035955c982018-04-26 00:53:03 +03003899
Ronald Cronde822812021-03-17 16:08:20 +01003900 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003901 &attributes, slot->key.data, slot->key.bytes,
3902 alg,
3903 nonce, nonce_length,
3904 additional_data, additional_data_length,
3905 plaintext, plaintext_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003906 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02003907
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003908 if (status != PSA_SUCCESS && ciphertext_size != 0) {
3909 memset(ciphertext, 0, ciphertext_size);
3910 }
Gilles Peskine2d277862018-06-18 15:41:12 +02003911
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003912 psa_unlock_key_slot(slot);
mohammad16035955c982018-04-26 00:53:03 +03003913
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003914 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02003915}
3916
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003917psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
3918 psa_algorithm_t alg,
3919 const uint8_t *nonce,
3920 size_t nonce_length,
3921 const uint8_t *additional_data,
3922 size_t additional_data_length,
3923 const uint8_t *ciphertext,
3924 size_t ciphertext_length,
3925 uint8_t *plaintext,
3926 size_t plaintext_size,
3927 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03003928{
Ronald Cron215633c2021-03-16 17:15:37 +01003929 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3930 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003931
Gilles Peskineee652a32018-06-01 19:23:52 +02003932 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003933
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003934 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
3935 return PSA_ERROR_NOT_SUPPORTED;
3936 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01003937
Ronald Cron9a986162021-03-26 12:40:07 +01003938 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003939 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3940 if (status != PSA_SUCCESS) {
3941 return status;
3942 }
mohammad16035955c982018-04-26 00:53:03 +03003943
Ronald Cron215633c2021-03-16 17:15:37 +01003944 psa_key_attributes_t attributes = {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003945 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01003946 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003947
Ronald Cronde822812021-03-17 16:08:20 +01003948 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003949 &attributes, slot->key.data, slot->key.bytes,
3950 alg,
3951 nonce, nonce_length,
3952 additional_data, additional_data_length,
3953 ciphertext, ciphertext_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003954 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02003955
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003956 if (status != PSA_SUCCESS && plaintext_size != 0) {
3957 memset(plaintext, 0, plaintext_size);
3958 }
mohammad160360a64d02018-06-03 17:20:42 +03003959
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003960 psa_unlock_key_slot(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01003961
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003962 return status;
mohammad16035955c982018-04-26 00:53:03 +03003963}
3964
Gilles Peskinee59236f2018-01-27 23:32:46 +01003965/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003966/* Generators */
3967/****************************************************************/
3968
John Durkop07cc04a2020-11-16 22:08:34 -08003969#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3970 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3971 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3972#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman9878a162021-05-06 17:58:36 +02003973#endif /* At least one builtin KDF */
3974
3975#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3976 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3977 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3978static psa_status_t psa_key_derivation_start_hmac(
3979 psa_mac_operation_t *operation,
3980 psa_algorithm_t hash_alg,
3981 const uint8_t *hmac_key,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003982 size_t hmac_key_length)
Steven Cooreman9878a162021-05-06 17:58:36 +02003983{
3984 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3985 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003986 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
3987 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
3988 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman9878a162021-05-06 17:58:36 +02003989
Steven Cooreman15f0d922021-05-07 14:14:37 +02003990 operation->is_sign = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003991 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman15f0d922021-05-07 14:14:37 +02003992
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003993 status = psa_driver_wrapper_mac_sign_setup(operation,
3994 &attributes,
3995 hmac_key, hmac_key_length,
3996 PSA_ALG_HMAC(hash_alg));
Steven Cooreman9878a162021-05-06 17:58:36 +02003997
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003998 psa_reset_key_attributes(&attributes);
3999 return status;
Steven Cooreman9878a162021-05-06 17:58:36 +02004000}
4001#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08004002
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004003#define HKDF_STATE_INIT 0 /* no input yet */
4004#define HKDF_STATE_STARTED 1 /* got salt */
4005#define HKDF_STATE_KEYED 2 /* got key */
4006#define HKDF_STATE_OUTPUT 3 /* output started */
4007
Gilles Peskinecbe66502019-05-16 16:59:18 +02004008static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004009 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004010{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004011 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
4012 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
4013 } else {
4014 return operation->alg;
4015 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004016}
4017
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004018psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02004019{
4020 psa_status_t status = PSA_SUCCESS;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004021 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
4022 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02004023 /* The object has (apparently) been initialized but it is not
4024 * in use. It's ok to call abort on such an object, and there's
4025 * nothing to do. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004026 } else
John Durkopd0321952020-10-29 21:37:36 -07004027#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004028 if (PSA_ALG_IS_HKDF(kdf_alg)) {
4029 mbedtls_free(operation->ctx.hkdf.info);
4030 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
4031 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004032#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4033#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4034 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004035 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
4036 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
4037 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
4038 if (operation->ctx.tls12_prf.secret != NULL) {
4039 mbedtls_platform_zeroize(operation->ctx.tls12_prf.secret,
4040 operation->ctx.tls12_prf.secret_length);
4041 mbedtls_free(operation->ctx.tls12_prf.secret);
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004042 }
4043
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004044 if (operation->ctx.tls12_prf.seed != NULL) {
4045 mbedtls_platform_zeroize(operation->ctx.tls12_prf.seed,
4046 operation->ctx.tls12_prf.seed_length);
4047 mbedtls_free(operation->ctx.tls12_prf.seed);
Janos Follath6a1d2622019-06-11 10:37:28 +01004048 }
4049
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004050 if (operation->ctx.tls12_prf.label != NULL) {
4051 mbedtls_platform_zeroize(operation->ctx.tls12_prf.label,
4052 operation->ctx.tls12_prf.label_length);
4053 mbedtls_free(operation->ctx.tls12_prf.label);
Janos Follath6a1d2622019-06-11 10:37:28 +01004054 }
4055
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004056 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01004057
4058 /* We leave the fields Ai and output_block to be erased safely by the
4059 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004060 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004061#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4062 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004063 {
4064 status = PSA_ERROR_BAD_STATE;
4065 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004066 mbedtls_platform_zeroize(operation, sizeof(*operation));
4067 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004068}
4069
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004070psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004071 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02004072{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004073 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004074 /* This is a blank key derivation operation. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004075 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004076 }
4077
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004078 *capacity = operation->capacity;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004079 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004080}
4081
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004082psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
4083 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004084{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004085 if (operation->alg == 0) {
4086 return PSA_ERROR_BAD_STATE;
4087 }
4088 if (capacity > operation->capacity) {
4089 return PSA_ERROR_INVALID_ARGUMENT;
4090 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004091 operation->capacity = capacity;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004092 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004093}
4094
John Durkopd0321952020-10-29 21:37:36 -07004095#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004096/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004097 * of the expand phase of the HKDF algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004098static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
4099 psa_algorithm_t hash_alg,
4100 uint8_t *output,
4101 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02004102{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004103 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremanb27e3502021-04-29 19:11:25 +02004104 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004105 psa_status_t status;
4106
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004107 if (hkdf->state < HKDF_STATE_KEYED || !hkdf->info_set) {
4108 return PSA_ERROR_BAD_STATE;
4109 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004110 hkdf->state = HKDF_STATE_OUTPUT;
4111
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004112 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02004113 /* Copy what remains of the current block */
4114 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004115 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02004116 n = (uint8_t) output_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004117 }
4118 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02004119 output += n;
4120 output_length -= n;
4121 hkdf->offset_in_block += n;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004122 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02004123 break;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004124 }
Gilles Peskined54931c2018-07-17 21:06:59 +02004125 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004126 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004127 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004128 * object was corrupted or if this function is called directly
4129 * inside the library. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004130 if (hkdf->block_number == 0xff) {
4131 return PSA_ERROR_BAD_STATE;
4132 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004133
4134 /* We need a new block */
4135 ++hkdf->block_number;
4136 hkdf->offset_in_block = 0;
Steven Cooremanb27e3502021-04-29 19:11:25 +02004137
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004138 status = psa_key_derivation_start_hmac(&hkdf->hmac,
4139 hash_alg,
4140 hkdf->prk,
4141 hash_length);
4142 if (status != PSA_SUCCESS) {
4143 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004144 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004145
4146 if (hkdf->block_number != 1) {
4147 status = psa_mac_update(&hkdf->hmac,
4148 hkdf->output_block,
4149 hash_length);
4150 if (status != PSA_SUCCESS) {
4151 return status;
4152 }
4153 }
4154 status = psa_mac_update(&hkdf->hmac,
4155 hkdf->info,
4156 hkdf->info_length);
4157 if (status != PSA_SUCCESS) {
4158 return status;
4159 }
4160 status = psa_mac_update(&hkdf->hmac,
4161 &hkdf->block_number, 1);
4162 if (status != PSA_SUCCESS) {
4163 return status;
4164 }
4165 status = psa_mac_sign_finish(&hkdf->hmac,
4166 hkdf->output_block,
4167 sizeof(hkdf->output_block),
4168 &hmac_output_length);
4169 if (status != PSA_SUCCESS) {
4170 return status;
4171 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004172 }
4173
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004174 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004175}
John Durkop07cc04a2020-11-16 22:08:34 -08004176#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004177
John Durkop07cc04a2020-11-16 22:08:34 -08004178#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4179 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01004180static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4181 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004182 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01004183{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004184 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
4185 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004186 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
4187 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01004188 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004189
Janos Follath7742fee2019-06-17 12:58:10 +01004190 /* We can't be wanting more output after block 0xff, otherwise
4191 * the capacity check in psa_key_derivation_output_bytes() would have
4192 * prevented this call. It could happen only if the operation
4193 * object was corrupted or if this function is called directly
4194 * inside the library. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004195 if (tls12_prf->block_number == 0xff) {
4196 return PSA_ERROR_CORRUPTION_DETECTED;
4197 }
Janos Follath7742fee2019-06-17 12:58:10 +01004198
4199 /* We need a new block */
4200 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004201 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004202
4203 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4204 *
4205 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4206 *
4207 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4208 * HMAC_hash(secret, A(2) + seed) +
4209 * HMAC_hash(secret, A(3) + seed) + ...
4210 *
4211 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004212 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004213 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004214 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004215 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004216 * is currently extracted as `output_block` and where i is
4217 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004218 */
4219
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004220 status = psa_key_derivation_start_hmac(&hmac,
4221 hash_alg,
4222 tls12_prf->secret,
4223 tls12_prf->secret_length);
4224 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004225 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004226 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004227
4228 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004229 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004230 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4231 * the variable seed and in this instance means it in the context of the
4232 * P_hash function, where seed = label + seed.) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004233 status = psa_mac_update(&hmac,
4234 tls12_prf->label,
4235 tls12_prf->label_length);
4236 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004237 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004238 }
4239 status = psa_mac_update(&hmac,
4240 tls12_prf->seed,
4241 tls12_prf->seed_length);
4242 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004243 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004244 }
4245 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01004246 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004247 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
4248 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004249 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004250 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004251 }
4252
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004253 status = psa_mac_sign_finish(&hmac,
4254 tls12_prf->Ai, hash_length,
4255 &hmac_output_length);
4256 if (hmac_output_length != hash_length) {
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004257 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004258 }
4259 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004260 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004261 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004262
4263 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004264 status = psa_key_derivation_start_hmac(&hmac,
4265 hash_alg,
4266 tls12_prf->secret,
4267 tls12_prf->secret_length);
4268 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004269 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004270 }
4271 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
4272 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004273 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004274 }
4275 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
4276 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004277 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004278 }
4279 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
4280 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004281 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004282 }
4283 status = psa_mac_sign_finish(&hmac,
4284 tls12_prf->output_block, hash_length,
4285 &hmac_output_length);
4286 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004287 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004288 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004289
Janos Follath7742fee2019-06-17 12:58:10 +01004290
4291cleanup:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004292 cleanup_status = psa_mac_abort(&hmac);
4293 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004294 status = cleanup_status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004295 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004296
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004297 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01004298}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004299
Janos Follath844eb0e2019-06-19 12:10:49 +01004300static psa_status_t psa_key_derivation_tls12_prf_read(
4301 psa_tls12_prf_key_derivation_t *tls12_prf,
4302 psa_algorithm_t alg,
4303 uint8_t *output,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004304 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01004305{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004306 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
4307 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01004308 psa_status_t status;
4309 uint8_t offset, length;
4310
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004311 switch (tls12_prf->state) {
Gilles Peskinef216f0d2021-06-11 22:41:46 +02004312 case PSA_TLS12_PRF_STATE_LABEL_SET:
4313 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4314 break;
4315 case PSA_TLS12_PRF_STATE_OUTPUT:
4316 break;
4317 default:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004318 return PSA_ERROR_BAD_STATE;
Gilles Peskinef216f0d2021-06-11 22:41:46 +02004319 }
4320
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004321 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01004322 /* Check if we have fully processed the current block. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004323 if (tls12_prf->left_in_block == 0) {
4324 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
4325 alg);
4326 if (status != PSA_SUCCESS) {
4327 return status;
4328 }
Janos Follath844eb0e2019-06-19 12:10:49 +01004329
4330 continue;
4331 }
4332
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004333 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01004334 length = (uint8_t) output_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004335 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01004336 length = tls12_prf->left_in_block;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004337 }
Janos Follath844eb0e2019-06-19 12:10:49 +01004338
4339 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004340 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01004341 output += length;
4342 output_length -= length;
4343 tls12_prf->left_in_block -= length;
4344 }
4345
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004346 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01004347}
John Durkop07cc04a2020-11-16 22:08:34 -08004348#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4349 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004350
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004351psa_status_t psa_key_derivation_output_bytes(
4352 psa_key_derivation_operation_t *operation,
4353 uint8_t *output,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004354 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02004355{
4356 psa_status_t status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004357 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02004358
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004359 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004360 /* This is a blank operation. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004361 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004362 }
4363
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004364 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004365 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004366 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004367 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004368 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004369 goto exit;
4370 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004371 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004372 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004373 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004374 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4375 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004376 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004377 * output_length > 0. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004378 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004379 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004380 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004381
John Durkopd0321952020-10-29 21:37:36 -07004382#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004383 if (PSA_ALG_IS_HKDF(kdf_alg)) {
4384 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
4385 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, hash_alg,
4386 output, output_length);
4387 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004388#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4389#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4390 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004391 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
4392 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
4393 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
4394 kdf_alg, output,
4395 output_length);
4396 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004397#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4398 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004399 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004400 (void) kdf_alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004401 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004402 }
4403
4404exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004405 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004406 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004407 * This allows us to differentiate between exhausted operations and
4408 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4409 * operations. */
4410 psa_algorithm_t alg = operation->alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004411 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004412 operation->alg = alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004413 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02004414 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004415 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004416}
4417
David Brown7807bf72021-02-09 16:28:23 -07004418#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004419static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02004420{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004421 if (data_size >= 8) {
4422 mbedtls_des_key_set_parity(data);
4423 }
4424 if (data_size >= 16) {
4425 mbedtls_des_key_set_parity(data + 8);
4426 }
4427 if (data_size >= 24) {
4428 mbedtls_des_key_set_parity(data + 16);
4429 }
Gilles Peskine08542d82018-07-19 17:05:42 +02004430}
David Brown7807bf72021-02-09 16:28:23 -07004431#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004432
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004433static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004434 psa_key_slot_t *slot,
4435 size_t bits,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004436 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02004437{
4438 uint8_t *data = NULL;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004439 size_t bytes = PSA_BITS_TO_BYTES(bits);
Gilles Peskineeab56e42018-07-12 17:12:33 +02004440 psa_status_t status;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01004441 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004442
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004443 if (!key_type_is_raw_bytes(slot->attr.type)) {
4444 return PSA_ERROR_INVALID_ARGUMENT;
4445 }
4446 if (bits % 8 != 0) {
4447 return PSA_ERROR_INVALID_ARGUMENT;
4448 }
4449 data = mbedtls_calloc(1, bytes);
4450 if (data == NULL) {
4451 return PSA_ERROR_INSUFFICIENT_MEMORY;
4452 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02004453
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004454 status = psa_key_derivation_output_bytes(operation, data, bytes);
4455 if (status != PSA_SUCCESS) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02004456 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004457 }
David Brown12ca5032021-02-11 11:02:00 -07004458#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004459 if (slot->attr.type == PSA_KEY_TYPE_DES) {
4460 psa_des_set_key_parity(data, bytes);
4461 }
David Brown8107e312021-02-12 08:08:46 -07004462#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004463
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004464 status = psa_allocate_buffer_to_slot(slot, bytes);
4465 if (status != PSA_SUCCESS) {
Paul Elliottda3e7db2021-02-09 18:58:20 +00004466 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004467 }
Ronald Crondd04d422020-11-28 15:14:42 +01004468
Ronald Cronbf33c932020-11-28 18:06:53 +01004469 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01004470 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004471 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004472 };
4473
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004474 status = psa_driver_wrapper_import_key(&attributes,
4475 data, bytes,
4476 slot->key.data,
4477 slot->key.bytes,
4478 &slot->key.bytes, &bits);
4479 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01004480 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004481 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02004482
4483exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004484 mbedtls_free(data);
4485 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004486}
4487
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004488psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
4489 psa_key_derivation_operation_t *operation,
4490 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004491{
4492 psa_status_t status;
4493 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004494 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004495
Ronald Cron81709fc2020-11-14 12:10:32 +01004496 *key = MBEDTLS_SVC_KEY_ID_INIT;
4497
Gilles Peskine0f84d622019-09-12 19:03:13 +02004498 /* Reject any attempt to create a zero-length key so that we don't
4499 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004500 if (psa_get_key_bits(attributes) == 0) {
4501 return PSA_ERROR_INVALID_ARGUMENT;
4502 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02004503
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004504 if (operation->alg == PSA_ALG_NONE) {
4505 return PSA_ERROR_BAD_STATE;
4506 }
Dave Rodgman021e7242021-11-16 10:32:48 +00004507
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004508 if (!operation->can_output_key) {
4509 return PSA_ERROR_NOT_PERMITTED;
4510 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004511
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004512 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
4513 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004514#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004515 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004516 /* Deriving a key in a secure element is not implemented yet. */
4517 status = PSA_ERROR_NOT_SUPPORTED;
4518 }
4519#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004520 if (status == PSA_SUCCESS) {
4521 status = psa_generate_derived_key_internal(slot,
4522 attributes->core.bits,
4523 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004524 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004525 if (status == PSA_SUCCESS) {
4526 status = psa_finish_key_creation(slot, driver, key);
4527 }
4528 if (status != PSA_SUCCESS) {
4529 psa_fail_key_creation(slot, driver);
4530 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004531
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004532 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004533}
4534
Gilles Peskineeab56e42018-07-12 17:12:33 +02004535
4536
4537/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004538/* Key derivation */
4539/****************************************************************/
4540
Steven Cooreman932ffb72021-02-15 12:14:32 +01004541#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004542static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskinecdacf042021-04-29 21:10:00 +02004543{
4544#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004545 if (PSA_ALG_IS_HKDF(kdf_alg)) {
4546 return 1;
4547 }
Gilles Peskinecdacf042021-04-29 21:10:00 +02004548#endif
4549#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004550 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
4551 return 1;
4552 }
Gilles Peskinecdacf042021-04-29 21:10:00 +02004553#endif
4554#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004555 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
4556 return 1;
4557 }
Gilles Peskinecdacf042021-04-29 21:10:00 +02004558#endif
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004559 return 0;
Gilles Peskinecdacf042021-04-29 21:10:00 +02004560}
4561
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004562static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004563{
4564 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004565 psa_status_t status = psa_hash_setup(&operation, alg);
4566 psa_hash_abort(&operation);
4567 return status;
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004568}
4569
Gilles Peskine969c5d62019-01-16 15:53:06 +01004570static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004571 psa_key_derivation_operation_t *operation,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004572 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004573{
Janos Follath5fe19732019-06-20 15:09:30 +01004574 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4575 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004576 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01004577
Gilles Peskine969c5d62019-01-16 15:53:06 +01004578 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004579 if (!is_kdf_alg_supported(kdf_alg)) {
4580 return PSA_ERROR_NOT_SUPPORTED;
4581 }
John Durkop07cc04a2020-11-16 22:08:34 -08004582
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004583 /* All currently supported key derivation algorithms are based on a
4584 * hash algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004585 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
4586 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
4587 if (hash_size == 0) {
4588 return PSA_ERROR_NOT_SUPPORTED;
4589 }
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004590
4591 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
4592 * we might fail later, which is somewhat unfriendly and potentially
4593 * risk-prone. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004594 psa_status_t status = psa_hash_try_support(hash_alg);
4595 if (status != PSA_SUCCESS) {
4596 return status;
4597 }
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004598
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004599 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
4600 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
4601 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
4602 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004603 }
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004604
Gilles Peskinecdacf042021-04-29 21:10:00 +02004605 operation->capacity = 255 * hash_size;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004606 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004607}
Gilles Peskine739c98c2021-04-29 21:34:33 +02004608
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004609static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine739c98c2021-04-29 21:34:33 +02004610{
4611#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004612 if (alg == PSA_ALG_ECDH) {
4613 return PSA_SUCCESS;
4614 }
Gilles Peskine739c98c2021-04-29 21:34:33 +02004615#endif
4616 (void) alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004617 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine739c98c2021-04-29 21:34:33 +02004618}
John Durkop07cc04a2020-11-16 22:08:34 -08004619#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004620
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004621psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
4622 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004623{
4624 psa_status_t status;
4625
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004626 if (operation->alg != 0) {
4627 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004628 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004629
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004630 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
4631 return PSA_ERROR_INVALID_ARGUMENT;
4632 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
4633#if defined(AT_LEAST_ONE_BUILTIN_KDF)
4634 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
4635 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
4636 status = psa_key_agreement_try_support(ka_alg);
4637 if (status != PSA_SUCCESS) {
4638 return status;
4639 }
4640 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
4641#else
4642 return PSA_ERROR_NOT_SUPPORTED;
4643#endif /* AT_LEAST_ONE_BUILTIN_KDF */
4644 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
4645#if defined(AT_LEAST_ONE_BUILTIN_KDF)
4646 status = psa_key_derivation_setup_kdf(operation, alg);
4647#else
4648 return PSA_ERROR_NOT_SUPPORTED;
4649#endif /* AT_LEAST_ONE_BUILTIN_KDF */
4650 } else {
4651 return PSA_ERROR_INVALID_ARGUMENT;
4652 }
4653
4654 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004655 operation->alg = alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004656 }
4657 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004658}
4659
John Durkopd0321952020-10-29 21:37:36 -07004660#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004661static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
4662 psa_algorithm_t hash_alg,
4663 psa_key_derivation_step_t step,
4664 const uint8_t *data,
4665 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004666{
4667 psa_status_t status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004668 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02004669 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004670 if (hkdf->state != HKDF_STATE_INIT) {
4671 return PSA_ERROR_BAD_STATE;
4672 } else {
4673 status = psa_key_derivation_start_hmac(&hkdf->hmac,
4674 hash_alg,
4675 data, data_length);
4676 if (status != PSA_SUCCESS) {
4677 return status;
4678 }
Steven Cooremanb27e3502021-04-29 19:11:25 +02004679 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004680 return PSA_SUCCESS;
Steven Cooremanb27e3502021-04-29 19:11:25 +02004681 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004682 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004683 /* If no salt was provided, use an empty salt. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004684 if (hkdf->state == HKDF_STATE_INIT) {
4685 status = psa_key_derivation_start_hmac(&hkdf->hmac,
4686 hash_alg,
4687 NULL, 0);
4688 if (status != PSA_SUCCESS) {
4689 return status;
4690 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004691 hkdf->state = HKDF_STATE_STARTED;
4692 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004693 if (hkdf->state != HKDF_STATE_STARTED) {
4694 return PSA_ERROR_BAD_STATE;
4695 }
4696 status = psa_mac_update(&hkdf->hmac,
4697 data, data_length);
4698 if (status != PSA_SUCCESS) {
4699 return status;
4700 }
4701 status = psa_mac_sign_finish(&hkdf->hmac,
4702 hkdf->prk,
4703 sizeof(hkdf->prk),
4704 &data_length);
4705 if (status != PSA_SUCCESS) {
4706 return status;
4707 }
4708 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Gilles Peskine2b522db2019-04-12 15:11:49 +02004709 hkdf->block_number = 0;
4710 hkdf->state = HKDF_STATE_KEYED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004711 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02004712 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004713 if (hkdf->state == HKDF_STATE_OUTPUT) {
4714 return PSA_ERROR_BAD_STATE;
4715 }
4716 if (hkdf->info_set) {
4717 return PSA_ERROR_BAD_STATE;
4718 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004719 hkdf->info_length = data_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004720 if (data_length != 0) {
4721 hkdf->info = mbedtls_calloc(1, data_length);
4722 if (hkdf->info == NULL) {
4723 return PSA_ERROR_INSUFFICIENT_MEMORY;
4724 }
4725 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004726 }
4727 hkdf->info_set = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004728 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004729 default:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004730 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004731 }
4732}
John Durkop07cc04a2020-11-16 22:08:34 -08004733#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004734
John Durkop07cc04a2020-11-16 22:08:34 -08004735#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4736 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004737static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
4738 const uint8_t *data,
4739 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01004740{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004741 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
4742 return PSA_ERROR_BAD_STATE;
4743 }
Janos Follathf08e2652019-06-13 09:05:41 +01004744
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004745 if (data_length != 0) {
4746 prf->seed = mbedtls_calloc(1, data_length);
4747 if (prf->seed == NULL) {
4748 return PSA_ERROR_INSUFFICIENT_MEMORY;
4749 }
Janos Follathf08e2652019-06-13 09:05:41 +01004750
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004751 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01004752 prf->seed_length = data_length;
4753 }
Janos Follathf08e2652019-06-13 09:05:41 +01004754
Gilles Peskine43f958b2020-12-13 14:55:14 +01004755 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004756
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004757 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01004758}
4759
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004760static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
4761 const uint8_t *data,
4762 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01004763{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004764 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
4765 return PSA_ERROR_BAD_STATE;
4766 }
Janos Follath81550542019-06-13 14:26:34 +01004767
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004768 if (data_length != 0) {
4769 prf->secret = mbedtls_calloc(1, data_length);
4770 if (prf->secret == NULL) {
4771 return PSA_ERROR_INSUFFICIENT_MEMORY;
4772 }
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004773
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004774 memcpy(prf->secret, data, data_length);
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004775 prf->secret_length = data_length;
4776 }
Janos Follath81550542019-06-13 14:26:34 +01004777
Gilles Peskine43f958b2020-12-13 14:55:14 +01004778 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004779
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004780 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01004781}
4782
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004783static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
4784 const uint8_t *data,
4785 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01004786{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004787 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
4788 return PSA_ERROR_BAD_STATE;
4789 }
Janos Follath63028dd2019-06-13 09:15:47 +01004790
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004791 if (data_length != 0) {
4792 prf->label = mbedtls_calloc(1, data_length);
4793 if (prf->label == NULL) {
4794 return PSA_ERROR_INSUFFICIENT_MEMORY;
4795 }
Janos Follath63028dd2019-06-13 09:15:47 +01004796
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004797 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01004798 prf->label_length = data_length;
4799 }
Janos Follath63028dd2019-06-13 09:15:47 +01004800
Gilles Peskine43f958b2020-12-13 14:55:14 +01004801 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004802
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004803 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01004804}
4805
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004806static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
4807 psa_key_derivation_step_t step,
4808 const uint8_t *data,
4809 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01004810{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004811 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01004812 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004813 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01004814 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004815 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01004816 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004817 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01004818 default:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004819 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01004820 }
4821}
John Durkop07cc04a2020-11-16 22:08:34 -08004822#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4823 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4824
4825#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4826static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4827 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004828 const uint8_t *data,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004829 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08004830{
4831 psa_status_t status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004832 uint8_t pms[4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE];
John Durkop07cc04a2020-11-16 22:08:34 -08004833 uint8_t *cur = pms;
4834
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004835 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
4836 return PSA_ERROR_INVALID_ARGUMENT;
4837 }
John Durkop07cc04a2020-11-16 22:08:34 -08004838
4839 /* Quoting RFC 4279, Section 2:
4840 *
4841 * The premaster secret is formed as follows: if the PSK is N octets
4842 * long, concatenate a uint16 with the value N, N zero octets, a second
4843 * uint16 with the value N, and the PSK itself.
4844 */
4845
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004846 *cur++ = MBEDTLS_BYTE_1(data_length);
4847 *cur++ = MBEDTLS_BYTE_0(data_length);
4848 memset(cur, 0, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08004849 cur += data_length;
4850 *cur++ = pms[0];
4851 *cur++ = pms[1];
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004852 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08004853 cur += data_length;
4854
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004855 status = psa_tls12_prf_set_key(prf, pms, cur - pms);
John Durkop07cc04a2020-11-16 22:08:34 -08004856
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004857 mbedtls_platform_zeroize(pms, sizeof(pms));
4858 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08004859}
Janos Follath6660f0e2019-06-17 08:44:03 +01004860
4861static psa_status_t psa_tls12_prf_psk_to_ms_input(
4862 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004863 psa_key_derivation_step_t step,
4864 const uint8_t *data,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004865 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01004866{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004867 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
4868 return psa_tls12_prf_psk_to_ms_set_key(prf,
4869 data, data_length);
Janos Follath0c1ed842019-06-28 13:35:36 +01004870 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004871
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004872 return psa_tls12_prf_input(prf, step, data, data_length);
Janos Follath6660f0e2019-06-17 08:44:03 +01004873}
John Durkop07cc04a2020-11-16 22:08:34 -08004874#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004875
Gilles Peskineb8965192019-09-24 16:21:10 +02004876/** Check whether the given key type is acceptable for the given
4877 * input step of a key derivation.
4878 *
4879 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4880 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4881 * Both secret and non-secret inputs can alternatively have the type
4882 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4883 * that the input was passed as a buffer rather than via a key object.
4884 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004885static int psa_key_derivation_check_input_type(
4886 psa_key_derivation_step_t step,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004887 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02004888{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004889 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02004890 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004891 if (key_type == PSA_KEY_TYPE_DERIVE) {
4892 return PSA_SUCCESS;
4893 }
4894 if (key_type == PSA_KEY_TYPE_NONE) {
4895 return PSA_SUCCESS;
4896 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02004897 break;
4898 case PSA_KEY_DERIVATION_INPUT_LABEL:
4899 case PSA_KEY_DERIVATION_INPUT_SALT:
4900 case PSA_KEY_DERIVATION_INPUT_INFO:
4901 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004902 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
4903 return PSA_SUCCESS;
4904 }
4905 if (key_type == PSA_KEY_TYPE_NONE) {
4906 return PSA_SUCCESS;
4907 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02004908 break;
4909 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004910 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02004911}
4912
Janos Follathb80a94e2019-06-12 15:54:46 +01004913static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004914 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004915 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004916 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004917 const uint8_t *data,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004918 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004919{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004920 psa_status_t status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004921 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004922
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004923 status = psa_key_derivation_check_input_type(step, key_type);
4924 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02004925 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004926 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02004927
John Durkopd0321952020-10-29 21:37:36 -07004928#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004929 if (PSA_ALG_IS_HKDF(kdf_alg)) {
4930 status = psa_hkdf_input(&operation->ctx.hkdf,
4931 PSA_ALG_HKDF_GET_HASH(kdf_alg),
4932 step, data, data_length);
4933 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004934#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4935#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004936 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
4937 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
4938 step, data, data_length);
4939 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004940#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4941#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004942 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
4943 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
4944 step, data, data_length);
4945 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004946#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004947 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004948 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004949 (void) data;
4950 (void) data_length;
4951 (void) kdf_alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004952 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004953 }
4954
Gilles Peskine224b0d62019-09-23 18:13:17 +02004955exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004956 if (status != PSA_SUCCESS) {
4957 psa_key_derivation_abort(operation);
4958 }
4959 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004960}
4961
Janos Follath51f4a0f2019-06-14 11:35:55 +01004962psa_status_t psa_key_derivation_input_bytes(
4963 psa_key_derivation_operation_t *operation,
4964 psa_key_derivation_step_t step,
4965 const uint8_t *data,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004966 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004967{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004968 return psa_key_derivation_input_internal(operation, step,
4969 PSA_KEY_TYPE_NONE,
4970 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004971}
4972
Janos Follath51f4a0f2019-06-14 11:35:55 +01004973psa_status_t psa_key_derivation_input_key(
4974 psa_key_derivation_operation_t *operation,
4975 psa_key_derivation_step_t step,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004976 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004977{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004978 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004979 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004980 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004981
Ronald Cron5c522922020-11-14 16:35:34 +01004982 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004983 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
4984 if (status != PSA_SUCCESS) {
4985 psa_key_derivation_abort(operation);
4986 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02004987 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004988
4989 /* Passing a key object as a SECRET input unlocks the permission
4990 * to output to a key object. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004991 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004992 operation->can_output_key = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004993 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004994
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004995 status = psa_key_derivation_input_internal(operation,
4996 step, slot->attr.type,
4997 slot->key.data,
4998 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004999
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005000 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02005001
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005002 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005003}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005004
5005
5006
5007/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005008/* Key agreement */
5009/****************************************************************/
5010
John Durkop6ba40d12020-11-10 08:50:04 -08005011#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005012static psa_status_t psa_key_agreement_ecdh(const uint8_t *peer_key,
5013 size_t peer_key_length,
5014 const mbedtls_ecp_keypair *our_key,
5015 uint8_t *shared_secret,
5016 size_t shared_secret_size,
5017 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005018{
Steven Cooremand4867872020-08-05 16:31:39 +02005019 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005020 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005021 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005022 size_t bits = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005023 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa(our_key->grp.id, &bits);
5024 mbedtls_ecdh_init(&ecdh);
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005025
Ronald Cron90857082020-11-25 14:58:33 +01005026 status = mbedtls_psa_ecp_load_representation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005027 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5028 bits,
5029 peer_key,
5030 peer_key_length,
5031 &their_key);
5032 if (status != PSA_SUCCESS) {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005033 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005034 }
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005035
Jaeden Amero97271b32019-01-10 19:38:51 +00005036 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005037 mbedtls_ecdh_get_params(&ecdh, their_key, MBEDTLS_ECDH_THEIRS));
5038 if (status != PSA_SUCCESS) {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005039 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005040 }
Jaeden Amero97271b32019-01-10 19:38:51 +00005041 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005042 mbedtls_ecdh_get_params(&ecdh, our_key, MBEDTLS_ECDH_OURS));
5043 if (status != PSA_SUCCESS) {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005044 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005045 }
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005046
Jaeden Amero97271b32019-01-10 19:38:51 +00005047 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005048 mbedtls_ecdh_calc_secret(&ecdh,
5049 shared_secret_length,
5050 shared_secret, shared_secret_size,
5051 mbedtls_psa_get_random,
5052 MBEDTLS_PSA_RANDOM_STATE));
5053 if (status != PSA_SUCCESS) {
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005054 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005055 }
5056 if (PSA_BITS_TO_BYTES(bits) != *shared_secret_length) {
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005057 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005058 }
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005059
5060exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005061 if (status != PSA_SUCCESS) {
5062 mbedtls_platform_zeroize(shared_secret, shared_secret_size);
5063 }
5064 mbedtls_ecdh_free(&ecdh);
5065 mbedtls_ecp_keypair_free(their_key);
5066 mbedtls_free(their_key);
Steven Cooremana2371e52020-07-28 14:30:39 +02005067
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005068 return status;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005069}
John Durkop6ba40d12020-11-10 08:50:04 -08005070#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005071
Gilles Peskine01d718c2018-09-18 12:01:02 +02005072#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5073
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005074static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
5075 psa_key_slot_t *private_key,
5076 const uint8_t *peer_key,
5077 size_t peer_key_length,
5078 uint8_t *shared_secret,
5079 size_t shared_secret_size,
5080 size_t *shared_secret_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02005081{
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01005082 mbedtls_ecp_keypair *ecp = NULL;
5083 psa_status_t status;
Agathiyan Bragadeeshe7eb8052023-07-31 16:16:38 +01005084
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005085 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08005086#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005087 case PSA_ALG_ECDH:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005088 if (!PSA_KEY_TYPE_IS_ECC_KEY_PAIR(private_key->attr.type)) {
5089 return PSA_ERROR_INVALID_ARGUMENT;
5090 }
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01005091 status = mbedtls_psa_ecp_load_representation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005092 private_key->attr.type,
5093 private_key->attr.bits,
5094 private_key->key.data,
5095 private_key->key.bytes,
5096 &ecp);
5097 if (status != PSA_SUCCESS) {
5098 return status;
5099 }
5100 status = psa_key_agreement_ecdh(peer_key, peer_key_length,
5101 ecp,
5102 shared_secret, shared_secret_size,
5103 shared_secret_length);
5104 mbedtls_ecp_keypair_free(ecp);
5105 mbedtls_free(ecp);
5106 return status;
John Durkop6ba40d12020-11-10 08:50:04 -08005107#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005108 default:
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01005109 (void) ecp;
5110 (void) status;
Gilles Peskine93f85002018-11-16 16:43:31 +01005111 (void) private_key;
5112 (void) peer_key;
5113 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005114 (void) shared_secret;
5115 (void) shared_secret_size;
5116 (void) shared_secret_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005117 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005118 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005119}
5120
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005121/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005122 * to potentially free embedded data structures and wipe confidential data.
5123 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005124static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
5125 psa_key_derivation_step_t step,
5126 psa_key_slot_t *private_key,
5127 const uint8_t *peer_key,
5128 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02005129{
5130 psa_status_t status;
5131 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5132 size_t shared_secret_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005133 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02005134
5135 /* Step 1: run the secret agreement algorithm to generate the shared
5136 * secret. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005137 status = psa_key_agreement_raw_internal(ka_alg,
5138 private_key,
5139 peer_key, peer_key_length,
5140 shared_secret,
5141 sizeof(shared_secret),
5142 &shared_secret_length);
5143 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02005144 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005145 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02005146
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005147 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005148 * the shared secret. A shared secret is permitted wherever a key
5149 * of type DERIVE is permitted. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005150 status = psa_key_derivation_input_internal(operation, step,
5151 PSA_KEY_TYPE_DERIVE,
5152 shared_secret,
5153 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02005154exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005155 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
5156 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02005157}
5158
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005159psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
5160 psa_key_derivation_step_t step,
5161 mbedtls_svc_key_id_t private_key,
5162 const uint8_t *peer_key,
5163 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02005164{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005165 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005166 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005167 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005168
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005169 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5170 return PSA_ERROR_INVALID_ARGUMENT;
5171 }
Ronald Cron5c522922020-11-14 16:35:34 +01005172 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005173 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
5174 if (status != PSA_SUCCESS) {
5175 return status;
5176 }
5177 status = psa_key_agreement_internal(operation, step,
5178 slot,
5179 peer_key, peer_key_length);
5180 if (status != PSA_SUCCESS) {
5181 psa_key_derivation_abort(operation);
5182 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005183 /* If a private key has been added as SECRET, we allow the derived
5184 * key material to be used as a key in PSA Crypto. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005185 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005186 operation->can_output_key = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005187 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005188 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005189
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005190 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02005191
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005192 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005193}
5194
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005195psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
5196 mbedtls_svc_key_id_t private_key,
5197 const uint8_t *peer_key,
5198 size_t peer_key_length,
5199 uint8_t *output,
5200 size_t output_size,
5201 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005202{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005203 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005204 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005205 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01005206 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005207
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005208 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02005209 status = PSA_ERROR_INVALID_ARGUMENT;
5210 goto exit;
5211 }
Ronald Cron5c522922020-11-14 16:35:34 +01005212 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005213 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
5214 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02005215 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005216 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005217
Gilles Peskine42313fb2022-04-14 00:17:15 +02005218 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
5219 * for the output size. The PSA specification only guarantees that this
5220 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
5221 * but it might be nice to allow smaller buffers if the output fits.
5222 * At the time of writing this comment, with only ECDH implemented,
5223 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
5224 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
5225 * be exact for it as well. */
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01005226 expected_length =
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005227 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
5228 if (output_size < expected_length) {
Gilles Peskine42313fb2022-04-14 00:17:15 +02005229 status = PSA_ERROR_BUFFER_TOO_SMALL;
5230 goto exit;
5231 }
5232
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005233 status = psa_key_agreement_raw_internal(alg, slot,
5234 peer_key, peer_key_length,
5235 output, output_size,
5236 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02005237
5238exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005239 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02005240 /* If an error happens and is not handled properly, the output
5241 * may be used as a key to protect sensitive data. Arrange for such
5242 * a key to be random, which is likely to result in decryption or
5243 * verification errors. This is better than filling the buffer with
5244 * some constant data such as zeros, which would result in the data
5245 * being protected with a reproducible, easily knowable key.
5246 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005247 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02005248 *output_length = output_size;
5249 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005250
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005251 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02005252
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005253 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005254}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005255
5256
Gilles Peskine30524eb2020-11-13 17:02:26 +01005257
Gilles Peskine86a440b2018-11-12 18:39:40 +01005258/****************************************************************/
5259/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005260/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005261
Gilles Peskine9a9d5ee2023-04-28 21:00:28 +02005262#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5263#include "mbedtls/entropy_poll.h"
5264#endif
5265
Gilles Peskine30524eb2020-11-13 17:02:26 +01005266/** Initialize the PSA random generator.
5267 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005268static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01005269{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005270#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005271 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005272#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5273
Gilles Peskine30524eb2020-11-13 17:02:26 +01005274 /* Set default configuration if
5275 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005276 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005277 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005278 }
5279 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005280 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005281 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01005282
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005283 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01005284#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5285 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5286 /* The PSA entropy injection feature depends on using NV seed as an entropy
5287 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005288 mbedtls_entropy_add_source(&rng->entropy,
5289 mbedtls_nv_seed_poll, NULL,
5290 MBEDTLS_ENTROPY_BLOCK_SIZE,
5291 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01005292#endif
5293
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005294 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005295#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005296}
5297
5298/** Deinitialize the PSA random generator.
5299 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005300static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01005301{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005302#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005303 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005304#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005305 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
5306 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005307#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005308}
5309
5310/** Seed the PSA random generator.
5311 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005312static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01005313{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005314#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5315 /* Do nothing: the external RNG seeds itself. */
5316 (void) rng;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005317 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005318#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005319 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005320 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
5321 drbg_seed, sizeof(drbg_seed) - 1);
5322 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005323#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005324}
5325
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005326psa_status_t psa_generate_random(uint8_t *output,
5327 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005328{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005329 GUARD_MODULE_INITIALIZED;
5330
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005331#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5332
5333 size_t output_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005334 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
5335 output, output_size,
5336 &output_length);
5337 if (status != PSA_SUCCESS) {
5338 return status;
5339 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005340 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove49f99bc2022-12-04 16:44:21 +00005341 * for the external RNG interface. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005342 if (output_length != output_size) {
5343 return PSA_ERROR_INSUFFICIENT_ENTROPY;
5344 }
5345 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005346
5347#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5348
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005349 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005350 size_t request_size =
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005351 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5352 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5353 output_size);
5354 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
5355 output, request_size);
5356 if (ret != 0) {
5357 return mbedtls_to_psa_error(ret);
5358 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01005359 output_size -= request_size;
5360 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005361 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005362 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005363#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005364}
5365
Gilles Peskine8814fc42020-12-14 15:33:44 +01005366/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005367 *
5368 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5369 * `psa_generate_random(...)`. The state parameter is ignored since the
5370 * PSA API doesn't support passing an explicit state.
5371 *
5372 * In the non-external case, psa_generate_random() calls an
5373 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5374 * and semantics as mbedtls_psa_get_random(). As an optimization,
5375 * instead of doing this back-and-forth between the PSA API and the
5376 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5377 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005378 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005379#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5380int mbedtls_psa_get_random(void *p_rng,
5381 unsigned char *output,
5382 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01005383{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005384 /* This function takes a pointer to the RNG state because that's what
5385 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5386 * its own state internally and doesn't let the caller access that state.
5387 * So we just ignore the state parameter, and in practice we'll pass
5388 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005389 (void) p_rng;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005390 psa_status_t status = psa_generate_random(output, output_size);
5391 if (status == PSA_SUCCESS) {
5392 return 0;
5393 } else {
5394 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
5395 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01005396}
5397#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5398
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005399#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005400psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
5401 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005402{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005403 if (global_data.initialized) {
5404 return PSA_ERROR_NOT_PERMITTED;
5405 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005406
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005407 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
5408 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
5409 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
5410 return PSA_ERROR_INVALID_ARGUMENT;
5411 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005412
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005413 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005414}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005415#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005416
Ronald Cron3772afe2021-02-08 16:10:05 +01005417/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005418 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005419 * \param type The key type
5420 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005421 *
5422 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005423 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005424 * \retval #PSA_ERROR_INVALID_ARGUMENT
5425 * The size in bits of the key is not valid.
5426 * \retval #PSA_ERROR_NOT_SUPPORTED
5427 * The type and/or the size in bits of the key or the combination of
5428 * the two is not supported.
5429 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005430static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005431 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005432{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005433 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005434
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005435 if (key_type_is_raw_bytes(type)) {
5436 status = validate_unstructured_key_bit_size(type, bits);
5437 if (status != PSA_SUCCESS) {
5438 return status;
5439 }
5440 } else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005441#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005442 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
5443 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
5444 return PSA_ERROR_NOT_SUPPORTED;
5445 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005446
Ronald Cron01b2aba2020-10-05 09:42:02 +02005447 /* Accept only byte-aligned keys, for the same reasons as
5448 * in psa_import_rsa_key(). */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005449 if (bits % 8 != 0) {
5450 return PSA_ERROR_NOT_SUPPORTED;
5451 }
5452 } else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005453#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005454
Ronald Cron5c4d3862020-12-07 11:07:24 +01005455#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005456 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01005457 /* To avoid empty block, return successfully here. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005458 return PSA_SUCCESS;
5459 } else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005460#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005461 {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005462 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005463 }
5464
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005465 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005466}
5467
Ronald Cron55ed0592020-10-05 10:30:40 +02005468psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005469 const psa_key_attributes_t *attributes,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005470 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005471{
5472 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005473 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005474
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005475 if ((attributes->domain_parameters == NULL) &&
5476 (attributes->domain_parameters_size != 0)) {
5477 return PSA_ERROR_INVALID_ARGUMENT;
5478 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02005479
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005480 if (key_type_is_raw_bytes(type)) {
5481 status = psa_generate_random(key_buffer, key_buffer_size);
5482 if (status != PSA_SUCCESS) {
5483 return status;
5484 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005485
David Brown12ca5032021-02-11 11:02:00 -07005486#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005487 if (type == PSA_KEY_TYPE_DES) {
5488 psa_des_set_key_parity(key_buffer, key_buffer_size);
5489 }
David Brown8107e312021-02-12 08:08:46 -07005490#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005491 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01005492
Jaeden Ameroc17f2932021-05-14 08:34:32 +01005493#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5494 defined(MBEDTLS_GENPRIME)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005495 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
5496 return mbedtls_psa_rsa_generate_key(attributes,
5497 key_buffer,
5498 key_buffer_size,
5499 key_buffer_length);
5500 } else
Jaeden Ameroc17f2932021-05-14 08:34:32 +01005501#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5502 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005503
John Durkop9814fa22020-11-04 12:28:15 -08005504#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005505 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
5506 return mbedtls_psa_ecp_generate_key(attributes,
5507 key_buffer,
5508 key_buffer_size,
5509 key_buffer_length);
5510 } else
John Durkop9814fa22020-11-04 12:28:15 -08005511#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005512 {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005513 (void) key_buffer_length;
5514 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02005515 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005516
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005517 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005518}
Darryl Green0c6575a2018-11-07 16:05:30 +00005519
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005520psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
5521 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005522{
5523 psa_status_t status;
5524 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005525 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005526 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005527
Ronald Cron81709fc2020-11-14 12:10:32 +01005528 *key = MBEDTLS_SVC_KEY_ID_INIT;
5529
Gilles Peskine0f84d622019-09-12 19:03:13 +02005530 /* Reject any attempt to create a zero-length key so that we don't
5531 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005532 if (psa_get_key_bits(attributes) == 0) {
5533 return PSA_ERROR_INVALID_ARGUMENT;
5534 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02005535
Przemyslaw Stekiel5b20a7e2021-10-07 11:08:56 +02005536 /* Reject any attempt to create a public key. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005537 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
5538 return PSA_ERROR_INVALID_ARGUMENT;
5539 }
Przemyslaw Stekiel5b20a7e2021-10-07 11:08:56 +02005540
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005541 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
5542 &slot, &driver);
5543 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02005544 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005545 }
Gilles Peskine11792082019-08-06 18:36:36 +02005546
Ronald Cron977c2472020-10-13 08:32:21 +02005547 /* In the case of a transparent key or an opaque key stored in local
5548 * storage (thus not in the case of generating a key in a secure element
5549 * or cryptoprocessor with storage), we have to allocate a buffer to
5550 * hold the generated key material. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005551 if (slot->key.data == NULL) {
5552 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
5553 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01005554 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005555 attributes->core.type, attributes->core.bits);
5556 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01005557 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005558 }
Ronald Cron3772afe2021-02-08 16:10:05 +01005559
5560 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005561 attributes->core.type,
5562 attributes->core.bits);
5563 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02005564 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005565 attributes, &key_buffer_size);
5566 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01005567 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005568 }
Ronald Cron977c2472020-10-13 08:32:21 +02005569 }
Ronald Cron977c2472020-10-13 08:32:21 +02005570
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005571 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
5572 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02005573 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005574 }
Ronald Cron977c2472020-10-13 08:32:21 +02005575 }
5576
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005577 status = psa_driver_wrapper_generate_key(attributes,
5578 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02005579
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005580 if (status != PSA_SUCCESS) {
5581 psa_remove_key_data_from_memory(slot);
5582 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02005583
Gilles Peskine11792082019-08-06 18:36:36 +02005584exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005585 if (status == PSA_SUCCESS) {
5586 status = psa_finish_key_creation(slot, driver, key);
5587 }
5588 if (status != PSA_SUCCESS) {
5589 psa_fail_key_creation(slot, driver);
5590 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005591
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005592 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005593}
5594
Gilles Peskinee59236f2018-01-27 23:32:46 +01005595/****************************************************************/
5596/* Module setup */
5597/****************************************************************/
5598
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005599#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005600psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005601 void (* entropy_init)(mbedtls_entropy_context *ctx),
5602 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01005603{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005604 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
5605 return PSA_ERROR_BAD_STATE;
5606 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01005607 global_data.rng.entropy_init = entropy_init;
5608 global_data.rng.entropy_free = entropy_free;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005609 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01005610}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005611#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005612
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005613void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005614{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005615 psa_wipe_all_key_slots();
5616 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
5617 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01005618 }
5619 /* Wipe all remaining data, including configuration.
5620 * In particular, this sets all state indicator to the value
5621 * indicating "uninitialized". */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005622 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron088d5d02021-04-10 16:57:30 +02005623
5624 /* Terminate drivers */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005625 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01005626}
5627
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005628#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5629/** Recover a transaction that was interrupted by a power failure.
5630 *
5631 * This function is called during initialization, before psa_crypto_init()
5632 * returns. If this function returns a failure status, the initialization
5633 * fails.
5634 */
5635static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005636 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005637{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005638 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005639 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5640 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005641 /* TODO - fall through to the failure case until this
5642 * is implemented.
5643 * https://github.com/ARMmbed/mbed-crypto/issues/218
5644 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005645 default:
5646 /* We found an unsupported transaction in the storage.
5647 * We don't know what state the storage is in. Give up. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005648 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005649 }
5650}
5651#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5652
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005653psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005654{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005655 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005656
Gilles Peskinec6b69072018-11-20 21:42:52 +01005657 /* Double initialization is explicitly allowed. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005658 if (global_data.initialized != 0) {
5659 return PSA_SUCCESS;
5660 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005661
Gilles Peskine30524eb2020-11-13 17:02:26 +01005662 /* Initialize and seed the random generator. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005663 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01005664 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005665 status = mbedtls_psa_random_seed(&global_data.rng);
5666 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01005667 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005668 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01005669 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005670
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005671 status = psa_initialize_key_slots();
5672 if (status != PSA_SUCCESS) {
Gilles Peskine66fb1262018-12-10 16:29:04 +01005673 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005674 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01005675
Ronald Cron088d5d02021-04-10 16:57:30 +02005676 /* Init drivers */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005677 status = psa_driver_wrapper_init();
5678 if (status != PSA_SUCCESS) {
Gilles Peskined9348f22019-10-01 15:22:29 +02005679 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005680 }
Gilles Peskined9348f22019-10-01 15:22:29 +02005681
Gilles Peskine4b734222019-07-24 15:56:31 +02005682#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005683 status = psa_crypto_load_transaction();
5684 if (status == PSA_SUCCESS) {
5685 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
5686 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005687 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005688 }
5689 status = psa_crypto_stop_transaction();
5690 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02005691 /* There's no transaction to complete. It's all good. */
5692 status = PSA_SUCCESS;
5693 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005694#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005695
Gilles Peskinec6b69072018-11-20 21:42:52 +01005696 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005697 global_data.initialized = 1;
5698
5699exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005700 if (status != PSA_SUCCESS) {
5701 mbedtls_psa_crypto_free();
5702 }
5703 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005704}
5705
David Horstmann114d8242023-12-07 18:39:17 +00005706/* Memory copying test hooks. These are called before input copy, after input
5707 * copy, before output copy and after output copy, respectively.
5708 * They are used by memory-poisoning tests to temporarily unpoison buffers
5709 * while they are copied. */
David Horstmann63f82f72023-11-28 15:21:56 +00005710#if defined(MBEDTLS_TEST_HOOKS)
5711void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
5712void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
5713void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
5714void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
5715#endif
5716
David Horstmanndf493552023-11-15 15:18:30 +00005717/** Copy from an input buffer to a local copy.
5718 *
5719 * \param[in] input Pointer to input buffer.
5720 * \param[in] input_len Length of the input buffer.
5721 * \param[out] input_copy Pointer to a local copy in which to store the input data.
5722 * \param[out] input_copy_len Length of the local copy buffer.
5723 * \return #PSA_SUCCESS, if the buffer was successfully
5724 * copied.
5725 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
5726 * copy is too small to hold contents of the
5727 * input buffer.
5728 */
5729MBEDTLS_STATIC_TESTABLE
David Horstmann957f9802023-10-30 20:29:43 +00005730psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
5731 uint8_t *input_copy, size_t input_copy_len)
5732{
5733 if (input_len > input_copy_len) {
David Horstmann8684ad52023-11-03 19:51:40 +00005734 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmann957f9802023-10-30 20:29:43 +00005735 }
5736
David Horstmann0760b152023-11-24 16:21:04 +00005737#if defined(MBEDTLS_TEST_HOOKS)
David Horstmann63f82f72023-11-28 15:21:56 +00005738 if (psa_input_pre_copy_hook != NULL) {
5739 psa_input_pre_copy_hook(input, input_len);
5740 }
David Horstmann0760b152023-11-24 16:21:04 +00005741#endif
5742
David Horstmann660027f2023-11-15 17:33:47 +00005743 if (input_len > 0) {
5744 memcpy(input_copy, input, input_len);
5745 }
David Horstmann957f9802023-10-30 20:29:43 +00005746
David Horstmann0760b152023-11-24 16:21:04 +00005747#if defined(MBEDTLS_TEST_HOOKS)
David Horstmann63f82f72023-11-28 15:21:56 +00005748 if (psa_input_post_copy_hook != NULL) {
5749 psa_input_post_copy_hook(input, input_len);
5750 }
David Horstmann0760b152023-11-24 16:21:04 +00005751#endif
5752
David Horstmann957f9802023-10-30 20:29:43 +00005753 return PSA_SUCCESS;
5754}
5755
David Horstmanndf493552023-11-15 15:18:30 +00005756/** Copy from a local output buffer into a user-supplied one.
5757 *
5758 * \param[in] output_copy Pointer to a local buffer containing the output.
5759 * \param[in] output_copy_len Length of the local buffer.
5760 * \param[out] output Pointer to user-supplied output buffer.
5761 * \param[out] output_len Length of the user-supplied output buffer.
5762 * \return #PSA_SUCCESS, if the buffer was successfully
5763 * copied.
David Horstmann232ab252023-11-20 12:39:38 +00005764 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmanndf493552023-11-15 15:18:30 +00005765 * user-supplied output buffer is too small to
5766 * hold the contents of the local buffer.
5767 */
5768MBEDTLS_STATIC_TESTABLE
David Horstmann2bd296e2023-10-30 20:37:12 +00005769psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
5770 uint8_t *output, size_t output_len)
5771{
5772 if (output_len < output_copy_len) {
David Horstmann232ab252023-11-20 12:39:38 +00005773 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann2bd296e2023-10-30 20:37:12 +00005774 }
David Horstmann660027f2023-11-15 17:33:47 +00005775
David Horstmann0760b152023-11-24 16:21:04 +00005776#if defined(MBEDTLS_TEST_HOOKS)
David Horstmann63f82f72023-11-28 15:21:56 +00005777 if (psa_output_pre_copy_hook != NULL) {
5778 psa_output_pre_copy_hook(output, output_len);
5779 }
David Horstmann0760b152023-11-24 16:21:04 +00005780#endif
5781
David Horstmann660027f2023-11-15 17:33:47 +00005782 if (output_copy_len > 0) {
5783 memcpy(output, output_copy, output_copy_len);
5784 }
5785
David Horstmann0760b152023-11-24 16:21:04 +00005786#if defined(MBEDTLS_TEST_HOOKS)
David Horstmann63f82f72023-11-28 15:21:56 +00005787 if (psa_output_post_copy_hook != NULL) {
5788 psa_output_post_copy_hook(output, output_len);
5789 }
David Horstmann0760b152023-11-24 16:21:04 +00005790#endif
5791
David Horstmann2bd296e2023-10-30 20:37:12 +00005792 return PSA_SUCCESS;
5793}
5794
David Horstmann81a0d572023-11-20 17:15:32 +00005795psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
5796 psa_crypto_local_input_t *local_input)
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005797{
5798 psa_status_t status;
5799
David Horstmann0d52c712023-11-23 15:50:37 +00005800 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005801
David Horstmann726bf052023-11-15 18:11:26 +00005802 if (input_len == 0) {
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005803 return PSA_SUCCESS;
5804 }
5805
David Horstmann81a0d572023-11-20 17:15:32 +00005806 local_input->buffer = mbedtls_calloc(input_len, 1);
5807 if (local_input->buffer == NULL) {
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005808 /* Since we dealt with the zero-length case above, we know that
5809 * a NULL return value means a failure of allocation. */
5810 return PSA_ERROR_INSUFFICIENT_MEMORY;
5811 }
David Horstmann81a0d572023-11-20 17:15:32 +00005812 /* From now on, we must free local_input->buffer on error. */
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005813
David Horstmann81a0d572023-11-20 17:15:32 +00005814 local_input->length = input_len;
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005815
5816 status = psa_crypto_copy_input(input, input_len,
David Horstmann81a0d572023-11-20 17:15:32 +00005817 local_input->buffer, local_input->length);
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005818 if (status != PSA_SUCCESS) {
5819 goto error;
5820 }
5821
5822 return PSA_SUCCESS;
5823
5824error:
David Horstmann81a0d572023-11-20 17:15:32 +00005825 mbedtls_free(local_input->buffer);
5826 local_input->buffer = NULL;
5827 local_input->length = 0;
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005828 return status;
5829}
5830
David Horstmann81a0d572023-11-20 17:15:32 +00005831void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmannfa2d75d2023-11-07 18:00:41 +00005832{
David Horstmann81a0d572023-11-20 17:15:32 +00005833 mbedtls_free(local_input->buffer);
5834 local_input->buffer = NULL;
5835 local_input->length = 0;
David Horstmannfa2d75d2023-11-07 18:00:41 +00005836}
5837
David Horstmann1a76ab12023-11-20 12:54:09 +00005838psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
5839 psa_crypto_local_output_t *local_output)
David Horstmann953cd5b2023-11-08 15:19:43 +00005840{
David Horstmann0d52c712023-11-23 15:50:37 +00005841 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmann953cd5b2023-11-08 15:19:43 +00005842
David Horstmann726bf052023-11-15 18:11:26 +00005843 if (output_len == 0) {
David Horstmann953cd5b2023-11-08 15:19:43 +00005844 return PSA_SUCCESS;
5845 }
David Horstmann1a76ab12023-11-20 12:54:09 +00005846 local_output->buffer = mbedtls_calloc(output_len, 1);
5847 if (local_output->buffer == NULL) {
David Horstmann953cd5b2023-11-08 15:19:43 +00005848 /* Since we dealt with the zero-length case above, we know that
5849 * a NULL return value means a failure of allocation. */
5850 return PSA_ERROR_INSUFFICIENT_MEMORY;
5851 }
David Horstmann1a76ab12023-11-20 12:54:09 +00005852 local_output->length = output_len;
5853 local_output->original = output;
David Horstmann953cd5b2023-11-08 15:19:43 +00005854
5855 return PSA_SUCCESS;
5856}
5857
Gabor Mezei3b0c3712024-01-24 13:07:17 +01005858psa_status_t psa_crypto_local_output_alloc_with_copy(uint8_t *output, size_t output_len,
5859 psa_crypto_local_output_t *local_output)
5860{
5861 psa_status_t status;
5862 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
5863
5864 if (output_len == 0) {
5865 return PSA_SUCCESS;
5866 }
5867 local_output->buffer = mbedtls_calloc(output_len, 1);
5868 if (local_output->buffer == NULL) {
5869 /* Since we dealt with the zero-length case above, we know that
5870 * a NULL return value means a failure of allocation. */
5871 return PSA_ERROR_INSUFFICIENT_MEMORY;
5872 }
5873 local_output->length = output_len;
5874 local_output->original = output;
5875
5876 status = psa_crypto_copy_input(output, output_len,
5877 local_output->buffer, local_output->length);
5878 if (status != PSA_SUCCESS) {
5879 goto error;
5880 }
5881
5882 return PSA_SUCCESS;
5883
5884error:
5885 mbedtls_free(local_output->buffer);
5886 local_output->buffer = NULL;
5887 local_output->length = 0;
5888 return status;
5889}
5890
David Horstmann1a76ab12023-11-20 12:54:09 +00005891psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmannaeeb2742023-11-08 17:44:18 +00005892{
David Horstmann761761f2023-11-15 15:57:32 +00005893 psa_status_t status;
5894
David Horstmann1a76ab12023-11-20 12:54:09 +00005895 if (local_output->buffer == NULL) {
5896 local_output->length = 0;
David Horstmannaeeb2742023-11-08 17:44:18 +00005897 return PSA_SUCCESS;
5898 }
David Horstmann1a76ab12023-11-20 12:54:09 +00005899 if (local_output->original == NULL) {
David Horstmannaeeb2742023-11-08 17:44:18 +00005900 /* We have an internal copy but nothing to copy back to. */
5901 return PSA_ERROR_CORRUPTION_DETECTED;
5902 }
5903
David Horstmann1a76ab12023-11-20 12:54:09 +00005904 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
5905 local_output->original, local_output->length);
David Horstmann761761f2023-11-15 15:57:32 +00005906 if (status != PSA_SUCCESS) {
5907 return status;
5908 }
David Horstmannaeeb2742023-11-08 17:44:18 +00005909
David Horstmann1a76ab12023-11-20 12:54:09 +00005910 mbedtls_free(local_output->buffer);
5911 local_output->buffer = NULL;
5912 local_output->length = 0;
David Horstmannaeeb2742023-11-08 17:44:18 +00005913
5914 return PSA_SUCCESS;
5915}
5916
Gilles Peskinee59236f2018-01-27 23:32:46 +01005917#endif /* MBEDTLS_PSA_CRYPTO_C */