blob: cff9ccaf2b213a5b1e917ae014933722a03f0d75 [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,
Ryan Everette3e760c2024-01-19 16:03:50 +00001486 uint8_t *data_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001487 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;
Ryan Everette3e760c2024-01-19 16:03:50 +00001493 LOCAL_OUTPUT_DECLARE(data_external, data);
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
Ryan Everette3e760c2024-01-19 16:03:50 +00001517 LOCAL_OUTPUT_ALLOC(data_external, data_size, data);
1518
Ronald Crond18b5f82020-11-25 16:46:05 +01001519 psa_key_attributes_t attributes = {
1520 .core = slot->attr
1521 };
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001522 status = psa_driver_wrapper_export_key(&attributes,
1523 slot->key.data, slot->key.bytes,
1524 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001525
Ryan Everett3a4153a2024-01-25 12:04:55 +00001526#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Ryan Everette3e760c2024-01-19 16:03:50 +00001527exit:
Ryan Everett3a4153a2024-01-25 12:04:55 +00001528#endif
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001529 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001530
Ryan Everette3e760c2024-01-19 16:03:50 +00001531 LOCAL_OUTPUT_FREE(data_external, data);
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001532 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001533}
1534
Ronald Cron7285cda2020-11-26 14:46:37 +01001535psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001536 const psa_key_attributes_t *attributes,
1537 const uint8_t *key_buffer,
1538 size_t key_buffer_size,
1539 uint8_t *data,
1540 size_t data_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001541 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001542{
Ronald Crond18b5f82020-11-25 16:46:05 +01001543 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001544
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001545 if (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type)) {
1546 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type)) {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001547 /* Exporting public -> public */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001548 return psa_export_key_buffer_internal(
1549 key_buffer, key_buffer_size,
1550 data, data_size, data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001551 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001552
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001553 if (PSA_KEY_TYPE_IS_RSA(type)) {
John Durkop0e005192020-10-31 22:06:54 -07001554#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001555 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1556 return mbedtls_psa_rsa_export_public_key(attributes,
1557 key_buffer,
1558 key_buffer_size,
1559 data,
1560 data_size,
1561 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001562#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001563 /* We don't know how to convert a private RSA key to public. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001564 return PSA_ERROR_NOT_SUPPORTED;
John Durkop9814fa22020-11-04 12:28:15 -08001565#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1566 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001567 } else {
John Durkop6ba40d12020-11-10 08:50:04 -08001568#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001569 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1570 return mbedtls_psa_ecp_export_public_key(attributes,
1571 key_buffer,
1572 key_buffer_size,
1573 data,
1574 data_size,
1575 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001576#else
1577 /* We don't know how to convert a private ECC key to public */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001578 return PSA_ERROR_NOT_SUPPORTED;
John Durkop9814fa22020-11-04 12:28:15 -08001579#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1580 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001581 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001582 } else {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001583 /* This shouldn't happen in the reference implementation, but
1584 it is valid for a special-purpose implementation to omit
1585 support for exporting certain key types. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001586 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001587 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001588}
Ronald Crond18b5f82020-11-25 16:46:05 +01001589
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001590psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
Ryan Everett30827912024-01-19 16:05:00 +00001591 uint8_t *data_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001592 size_t data_size,
1593 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001594{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001595 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001596 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01001597 psa_key_attributes_t attributes;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001598 psa_key_slot_t *slot;
Ryan Everett30827912024-01-19 16:05:00 +00001599 LOCAL_OUTPUT_DECLARE(data_external, data);
Darryl Greendd8fb772018-11-07 16:00:44 +00001600
Ronald Crone907e552021-01-18 13:22:38 +01001601 /* Reject a zero-length output buffer now, since this can never be a
1602 * valid key representation. This way we know that data must be a valid
1603 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001604 if (data_size == 0) {
1605 return PSA_ERROR_BUFFER_TOO_SMALL;
1606 }
Ronald Crone907e552021-01-18 13:22:38 +01001607
Darryl Greendd8fb772018-11-07 16:00:44 +00001608 /* Set the key to empty now, so that even when there are errors, we always
1609 * set data_length to a value between 0 and data_size. On error, setting
1610 * the key to empty is a good choice because an empty key representation is
1611 * unlikely to be accepted anywhere. */
1612 *data_length = 0;
1613
1614 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001615 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1616 if (status != PSA_SUCCESS) {
1617 return status;
1618 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001619
Ryan Everett30827912024-01-19 16:05:00 +00001620 LOCAL_OUTPUT_ALLOC(data_external, data_size, data);
1621
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001622 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1623 status = PSA_ERROR_INVALID_ARGUMENT;
1624 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001625 }
1626
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01001627 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001628 .core = slot->attr
1629 };
Ronald Cron67227982020-11-26 15:16:05 +01001630 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001631 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001632 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001633
1634exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001635 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001636
Ryan Everett30827912024-01-19 16:05:00 +00001637 LOCAL_OUTPUT_FREE(data_external, data);
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001638 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001639}
1640
Tom Cosgrovebdd01a72023-03-08 14:19:51 +00001641MBEDTLS_STATIC_ASSERT((MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1642 "One or more key attribute flag is listed as both external-only and dual-use")
1643MBEDTLS_STATIC_ASSERT((PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1644 "One or more key attribute flag is listed as both internal-only and dual-use")
1645MBEDTLS_STATIC_ASSERT((PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1646 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001647
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001648/** Validate that a key policy is internally well-formed.
1649 *
1650 * This function only rejects invalid policies. It does not validate the
1651 * consistency of the policy with respect to other attributes of the key
1652 * such as the key type.
1653 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001654static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001655{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001656 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1657 PSA_KEY_USAGE_COPY |
1658 PSA_KEY_USAGE_ENCRYPT |
1659 PSA_KEY_USAGE_DECRYPT |
1660 PSA_KEY_USAGE_SIGN_MESSAGE |
1661 PSA_KEY_USAGE_VERIFY_MESSAGE |
1662 PSA_KEY_USAGE_SIGN_HASH |
1663 PSA_KEY_USAGE_VERIFY_HASH |
1664 PSA_KEY_USAGE_DERIVE)) != 0) {
1665 return PSA_ERROR_INVALID_ARGUMENT;
1666 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001667
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001668 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001669}
1670
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001671/** Validate the internal consistency of key attributes.
1672 *
1673 * This function only rejects invalid attribute values. If does not
1674 * validate the consistency of the attributes with any key data that may
1675 * be involved in the creation of the key.
1676 *
1677 * Call this function early in the key creation process.
1678 *
1679 * \param[in] attributes Key attributes for the new key.
1680 * \param[out] p_drv On any return, the driver for the key, if any.
1681 * NULL for a transparent key.
1682 *
1683 */
1684static psa_status_t psa_validate_key_attributes(
1685 const psa_key_attributes_t *attributes,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001686 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001687{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001688 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001689 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1690 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001691
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001692 status = psa_validate_key_location(lifetime, p_drv);
1693 if (status != PSA_SUCCESS) {
1694 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001695 }
1696
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001697 status = psa_validate_key_persistence(lifetime);
1698 if (status != PSA_SUCCESS) {
1699 return status;
1700 }
1701
1702 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1703 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1704 return PSA_ERROR_INVALID_ARGUMENT;
1705 }
1706 } else {
1707 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1708 return PSA_ERROR_INVALID_ARGUMENT;
1709 }
1710 }
1711
1712 status = psa_validate_key_policy(&attributes->core.policy);
1713 if (status != PSA_SUCCESS) {
1714 return status;
1715 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001716
1717 /* Refuse to create overly large keys.
1718 * Note that this doesn't trigger on import if the attributes don't
1719 * explicitly specify a size (so psa_get_key_bits returns 0), so
1720 * psa_import_key() needs its own checks. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001721 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1722 return PSA_ERROR_NOT_SUPPORTED;
1723 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001724
Gilles Peskine91e8c332019-08-02 19:19:39 +02001725 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001726 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1727 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1728 return PSA_ERROR_INVALID_ARGUMENT;
1729 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001730
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001731 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001732}
1733
Gilles Peskine4747d192019-04-17 15:05:45 +02001734/** Prepare a key slot to receive key material.
1735 *
1736 * This function allocates a key slot and sets its metadata.
1737 *
1738 * If this function fails, call psa_fail_key_creation().
1739 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001740 * This function is intended to be used as follows:
1741 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001742 * it with the specified attributes, and in case of a volatile key assign it
1743 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001744 * -# Populate the slot with the key material.
1745 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1746 * In case of failure at any step, stop the sequence and call
1747 * psa_fail_key_creation().
1748 *
Ronald Cron5c522922020-11-14 16:35:34 +01001749 * On success, the key slot is locked. It is the responsibility of the caller
1750 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001751 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001752 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001753 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001754 * \param[out] p_slot On success, a pointer to the prepared slot.
1755 * \param[out] p_drv On any return, the driver for the key, if any.
1756 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001757 *
1758 * \retval #PSA_SUCCESS
1759 * The key slot is ready to receive key material.
1760 * \return If this function fails, the key slot is an invalid state.
1761 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001762 */
1763static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001764 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001765 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001766 psa_key_slot_t **p_slot,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001767 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001768{
1769 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001770 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001771 psa_key_slot_t *slot;
1772
Gilles Peskinedf179142019-07-15 22:02:14 +02001773 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001774 *p_drv = NULL;
1775
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001776 status = psa_validate_key_attributes(attributes, p_drv);
1777 if (status != PSA_SUCCESS) {
1778 return status;
1779 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001780
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001781 status = psa_get_empty_key_slot(&volatile_key_id, p_slot);
1782 if (status != PSA_SUCCESS) {
1783 return status;
1784 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001785 slot = *p_slot;
1786
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001787 /* We're storing the declared bit-size of the key. It's up to each
1788 * creation mechanism to verify that this information is correct.
1789 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001790 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001791 * is optional (import, copy). In case of a volatile key, assign it the
1792 * volatile key identifier associated to the slot returned to contain its
1793 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001794
1795 slot->attr = attributes->core;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001796 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001797#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1798 slot->attr.id = volatile_key_id;
1799#else
1800 slot->attr.id.key_id = volatile_key_id;
1801#endif
1802 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001803
Gilles Peskine91e8c332019-08-02 19:19:39 +02001804 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001805 * external-only flags, query `attributes`. Thanks to the check
1806 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001807 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001808 * may have set. */
1809 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001810
Gilles Peskinecbaff462019-07-12 23:46:04 +02001811#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001812 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001813 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001814 * create the key file in internal storage, create the
1815 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001816 * persistent data. This is done by starting a transaction that will
1817 * encompass these three actions.
1818 * For registering a volatile key, we just need to find an appropriate
1819 * slot number inside the SE. Since the key is designated volatile, creating
1820 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001821 /* The first thing to do is to find a slot number for the new key.
1822 * We save the slot number in persistent storage as part of the
1823 * transaction data. It will be needed to recover if the power
1824 * fails during the key creation process, to clean up on the secure
1825 * element side after restarting. Obtaining a slot number from the
1826 * secure element driver updates its persistent state, but we do not yet
1827 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001828 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001829 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001830 psa_key_slot_number_t slot_number;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001831 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1832 &slot_number);
1833 if (status != PSA_SUCCESS) {
1834 return status;
1835 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001836
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001837 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1838 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001839 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001840 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001841 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001842 status = psa_crypto_save_transaction();
1843 if (status != PSA_SUCCESS) {
1844 (void) psa_crypto_stop_transaction();
1845 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001846 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001847 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001848
1849 status = psa_copy_key_material_into_slot(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001850 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001851 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001852
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001853 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001854 /* Key registration only makes sense with a secure element. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001855 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001856 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001857#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1858
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001859 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001860}
Gilles Peskine4747d192019-04-17 15:05:45 +02001861
1862/** Finalize the creation of a key once its key material has been set.
1863 *
1864 * This entails writing the key to persistent storage.
1865 *
1866 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001867 * See the documentation of psa_start_key_creation() for the intended use
1868 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001869 *
Ronald Cron5c522922020-11-14 16:35:34 +01001870 * If the finalization succeeds, the function unlocks the key slot (it was
1871 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1872 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001873 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001874 * \param[in,out] slot Pointer to the slot with key material.
1875 * \param[in] driver The secure element driver for the key,
1876 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001877 * \param[out] key On success, identifier of the key. Note that the
1878 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001879 *
1880 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001881 * The key was successfully created.
Gilles Peskineec1eff32023-02-14 19:21:09 +01001882 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1883 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1884 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1885 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1886 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1887 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001888 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001889 * \return If this function fails, the key slot is an invalid state.
1890 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001891 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001892static psa_status_t psa_finish_key_creation(
1893 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001894 psa_se_drv_table_entry_t *driver,
1895 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001896{
1897 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001898 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001899 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001900
1901#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001902 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001903#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001904 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001905 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001906 psa_key_slot_number_t slot_number =
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001907 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001908
Tom Cosgrovebdd01a72023-03-08 14:19:51 +00001909 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1910 sizeof(data.slot_number),
1911 "Slot number size does not match psa_se_key_data_storage_t");
1912
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001913 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1914 status = psa_save_persistent_key(&slot->attr,
1915 (uint8_t *) &data,
1916 sizeof(data));
1917 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001918#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1919 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001920 /* Key material is saved in export representation in the slot, so
1921 * just pass the slot buffer for storage. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001922 status = psa_save_persistent_key(&slot->attr,
1923 slot->key.data,
1924 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001925 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001926 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001927#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1928
Gilles Peskinecbaff462019-07-12 23:46:04 +02001929#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001930 /* Finish the transaction for a key creation. This does not
1931 * happen when registering an existing key. Detect this case
1932 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001933 * creation of a persistent key in a secure element requires a transaction,
1934 * but registration or volatile key creation doesn't use one). */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001935 if (driver != NULL &&
1936 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1937 status = psa_save_se_persistent_data(driver);
1938 if (status != PSA_SUCCESS) {
1939 psa_destroy_persistent_key(slot->attr.id);
1940 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001941 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001942 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001943 }
1944#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1945
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001946 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001947 *key = slot->attr.id;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001948 status = psa_unlock_key_slot(slot);
1949 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001950 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001951 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001952 }
Ronald Cron50972942020-11-14 11:28:25 +01001953
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001954 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001955}
1956
1957/** Abort the creation of a key.
1958 *
1959 * You may call this function after calling psa_start_key_creation(),
1960 * or after psa_finish_key_creation() fails. In other circumstances, this
1961 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001962 * See the documentation of psa_start_key_creation() for the intended use
1963 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001964 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001965 * \param[in,out] slot Pointer to the slot with key material.
1966 * \param[in] driver The secure element driver for the key,
1967 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001968 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001969static void psa_fail_key_creation(psa_key_slot_t *slot,
1970 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001971{
Gilles Peskine011e4282019-06-26 18:34:38 +02001972 (void) driver;
1973
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001974 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001975 return;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001976 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001977
1978#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001979 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001980 * element, and the failure happened later (when saving metadata
1981 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001982 * element.
1983 * https://github.com/ARMmbed/mbed-crypto/issues/217
1984 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001985
Gilles Peskined7729582019-08-05 15:55:54 +02001986 /* Abort the ongoing transaction if any (there may not be one if
1987 * the creation process failed before starting one, or if the
1988 * key creation is a registration of a key in a secure element).
1989 * Earlier functions must already have done what it takes to undo any
1990 * partial creation. All that's left is to update the transaction data
1991 * itself. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001992 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001993#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1994
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001995 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02001996}
1997
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001998/** Validate optional attributes during key creation.
1999 *
2000 * Some key attributes are optional during key creation. If they are
2001 * specified in the attributes structure, check that they are consistent
2002 * with the data in the slot.
2003 *
2004 * This function should be called near the end of key creation, after
2005 * the slot in memory is fully populated but before saving persistent data.
2006 */
2007static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002008 const psa_key_slot_t *slot,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002009 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002010{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002011 if (attributes->core.type != 0) {
2012 if (attributes->core.type != slot->attr.type) {
2013 return PSA_ERROR_INVALID_ARGUMENT;
2014 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002015 }
2016
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002017 if (attributes->domain_parameters_size != 0) {
John Durkop0e005192020-10-31 22:06:54 -07002018#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002019 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
2020 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02002021 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002022 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002023 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002024
Ronald Cron90857082020-11-25 14:58:33 +01002025 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002026 slot->attr.type,
2027 slot->key.data,
2028 slot->key.bytes,
2029 &rsa);
2030 if (status != PSA_SUCCESS) {
2031 return status;
2032 }
Steven Cooreman75b74362020-07-28 14:30:13 +02002033
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002034 mbedtls_mpi_init(&actual);
2035 mbedtls_mpi_init(&required);
2036 ret = mbedtls_rsa_export(rsa,
2037 NULL, NULL, NULL, NULL, &actual);
2038 mbedtls_rsa_free(rsa);
2039 mbedtls_free(rsa);
2040 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002041 goto rsa_exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002042 }
2043 ret = mbedtls_mpi_read_binary(&required,
2044 attributes->domain_parameters,
2045 attributes->domain_parameters_size);
2046 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002047 goto rsa_exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002048 }
2049 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002050 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002051 }
2052rsa_exit:
2053 mbedtls_mpi_free(&actual);
2054 mbedtls_mpi_free(&required);
2055 if (ret != 0) {
2056 return mbedtls_to_psa_error(ret);
2057 }
2058 } else
John Durkop9814fa22020-11-04 12:28:15 -08002059#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
2060 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002061 {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002062 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002063 }
2064 }
2065
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002066 if (attributes->core.bits != 0) {
2067 if (attributes->core.bits != slot->attr.bits) {
2068 return PSA_ERROR_INVALID_ARGUMENT;
2069 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002070 }
2071
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002072 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002073}
2074
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002075psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
Ryan Everett6b970252024-01-19 16:02:59 +00002076 const uint8_t *data_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002077 size_t data_length,
2078 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002079{
2080 psa_status_t status;
Ryan Everett6b970252024-01-19 16:02:59 +00002081 LOCAL_INPUT_DECLARE(data_external, data);
Gilles Peskine4747d192019-04-17 15:05:45 +02002082 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002083 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002084 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002085
Ronald Cron81709fc2020-11-14 12:10:32 +01002086 *key = MBEDTLS_SVC_KEY_ID_INIT;
2087
Gilles Peskine0f84d622019-09-12 19:03:13 +02002088 /* Reject zero-length symmetric keys (including raw data key objects).
2089 * This also rejects any key which might be encoded as an empty string,
2090 * which is never valid. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002091 if (data_length == 0) {
2092 return PSA_ERROR_INVALID_ARGUMENT;
2093 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002094
Ryan Everett6b970252024-01-19 16:02:59 +00002095 LOCAL_INPUT_ALLOC(data_external, data_length, data);
2096
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002097 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2098 &slot, &driver);
2099 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002100 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002101 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002102
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002103 /* In the case of a transparent key or an opaque key stored in local
2104 * storage (thus not in the case of generating a key in a secure element
2105 * or cryptoprocessor with storage), we have to allocate a buffer to
2106 * hold the generated key material. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002107 if (slot->key.data == NULL) {
2108 status = psa_allocate_buffer_to_slot(slot, data_length);
2109 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002110 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002111 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002112 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002113
2114 bits = slot->attr.bits;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002115 status = psa_driver_wrapper_import_key(attributes,
2116 data, data_length,
2117 slot->key.data,
2118 slot->key.bytes,
2119 &slot->key.bytes, &bits);
2120 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002121 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002122 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002123
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002124 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002125 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002126 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002127 status = PSA_ERROR_INVALID_ARGUMENT;
2128 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002129 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002130
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002131 status = psa_validate_optional_attributes(slot, attributes);
2132 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002133 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002134 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002135
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002136 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002137exit:
Ryan Everett6b970252024-01-19 16:02:59 +00002138 LOCAL_INPUT_FREE(data_external, data);
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002139 if (status != PSA_SUCCESS) {
2140 psa_fail_key_creation(slot, driver);
2141 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002142
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002143 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002144}
2145
Gilles Peskined7729582019-08-05 15:55:54 +02002146#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2147psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002148 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002149{
2150 psa_status_t status;
2151 psa_key_slot_t *slot = NULL;
2152 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002153 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002154
2155 /* Leaving attributes unspecified is not currently supported.
2156 * It could make sense to query the key type and size from the
2157 * secure element, but not all secure elements support this
2158 * and the driver HAL doesn't currently support it. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002159 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2160 return PSA_ERROR_NOT_SUPPORTED;
2161 }
2162 if (psa_get_key_bits(attributes) == 0) {
2163 return PSA_ERROR_NOT_SUPPORTED;
2164 }
Gilles Peskined7729582019-08-05 15:55:54 +02002165
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002166 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2167 &slot, &driver);
2168 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002169 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002170 }
Gilles Peskined7729582019-08-05 15:55:54 +02002171
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002172 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002173
2174exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002175 if (status != PSA_SUCCESS) {
2176 psa_fail_key_creation(slot, driver);
2177 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002178
Gilles Peskined7729582019-08-05 15:55:54 +02002179 /* Registration doesn't keep the key in RAM. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002180 psa_close_key(key);
2181 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002182}
2183#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2184
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002185static psa_status_t psa_copy_key_material(const psa_key_slot_t *source,
2186 psa_key_slot_t *target)
Gilles Peskinef603c712019-01-19 13:40:11 +01002187{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002188 psa_status_t status = psa_copy_key_material_into_slot(target,
2189 source->key.data,
2190 source->key.bytes);
2191 if (status != PSA_SUCCESS) {
2192 return status;
2193 }
Gilles Peskinef603c712019-01-19 13:40:11 +01002194
Steven Cooreman398aee52020-10-13 14:35:45 +02002195 target->attr.type = source->attr.type;
2196 target->attr.bits = source->attr.bits;
2197
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002198 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +01002199}
2200
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002201psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2202 const psa_key_attributes_t *specified_attributes,
2203 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002204{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002205 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002206 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002207 psa_key_slot_t *source_slot = NULL;
2208 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002209 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002210 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002211
Ronald Cron81709fc2020-11-14 12:10:32 +01002212 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2213
Ronald Cron5c522922020-11-14 16:35:34 +01002214 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002215 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2216 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002217 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002218 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002219
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002220 status = psa_validate_optional_attributes(source_slot,
2221 specified_attributes);
2222 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002223 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002224 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002225
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002226 status = psa_restrict_key_policy(source_slot->attr.type,
2227 &actual_attributes.core.policy,
2228 &source_slot->attr.policy);
2229 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002230 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002231 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002232
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002233 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2234 &target_slot, &driver);
2235 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002236 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002237 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002238
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002239#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002240 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002241 /* Copying to a secure element is not implemented yet. */
2242 status = PSA_ERROR_NOT_SUPPORTED;
2243 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002244 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002245#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002246
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002247 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
Ronald Cron6cc66312021-04-02 12:27:47 +02002248 /*
2249 * Copying through an opaque driver is not implemented yet, consider
2250 * a lifetime with an external location as an invalid parameter for
2251 * now.
2252 */
2253 status = PSA_ERROR_INVALID_ARGUMENT;
2254 goto exit;
2255 }
2256
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002257 status = psa_copy_key_material(source_slot, target_slot);
2258 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002259 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002260 }
Gilles Peskinef603c712019-01-19 13:40:11 +01002261
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002262 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002263exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002264 if (status != PSA_SUCCESS) {
2265 psa_fail_key_creation(target_slot, driver);
2266 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002267
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002268 unlock_status = psa_unlock_key_slot(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002269
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002270 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002271}
2272
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002273
2274
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002275/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002276/* Message digests */
2277/****************************************************************/
2278
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002279psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002280{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002281 /* Aborting a non-active operation is allowed */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002282 if (operation->id == 0) {
2283 return PSA_SUCCESS;
2284 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002285
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002286 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002287 operation->id = 0;
2288
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002289 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002290}
2291
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002292psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2293 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002294{
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002295 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002296
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002297 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002298 if (operation->id != 0) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002299 status = PSA_ERROR_BAD_STATE;
2300 goto exit;
2301 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002302
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002303 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002304 status = PSA_ERROR_INVALID_ARGUMENT;
2305 goto exit;
2306 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002307
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002308 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2309 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002310 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002311
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002312 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002313
2314exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002315 if (status != PSA_SUCCESS) {
2316 psa_hash_abort(operation);
2317 }
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002318
2319 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002320}
2321
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002322psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2323 const uint8_t *input,
2324 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002325{
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002326 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2327
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002328 if (operation->id == 0) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002329 status = PSA_ERROR_BAD_STATE;
2330 goto exit;
2331 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002332
Steven Cooremanc8288352021-03-04 14:02:19 +01002333 /* Don't require hash implementations to behave correctly on a
2334 * zero-length input, which may have an invalid pointer. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002335 if (input_length == 0) {
2336 return PSA_SUCCESS;
2337 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002338
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002339 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002340
2341exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002342 if (status != PSA_SUCCESS) {
2343 psa_hash_abort(operation);
2344 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002345
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002346 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002347}
2348
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002349psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2350 uint8_t *hash,
2351 size_t hash_size,
2352 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002353{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002354 *hash_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002355 if (operation->id == 0) {
2356 return PSA_ERROR_BAD_STATE;
2357 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002358
Steven Cooreman1e582352021-02-18 17:24:37 +01002359 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002360 operation, hash, hash_size, hash_length);
2361 psa_hash_abort(operation);
2362 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002363}
2364
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002365psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2366 const uint8_t *hash,
2367 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002368{
Ronald Cron3a95d2b2021-10-18 09:47:58 +02002369 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002370 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002371 psa_status_t status = psa_hash_finish(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002372 operation,
2373 actual_hash, sizeof(actual_hash),
2374 &actual_hash_length);
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002375
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002376 if (status != PSA_SUCCESS) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002377 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002378 }
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002379
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002380 if (actual_hash_length != hash_length) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002381 status = PSA_ERROR_INVALID_SIGNATURE;
2382 goto exit;
2383 }
2384
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002385 if (mbedtls_psa_safer_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002386 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002387 }
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002388
2389exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002390 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2391 if (status != PSA_SUCCESS) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002392 psa_hash_abort(operation);
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002393 }
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002394
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002395 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002396}
2397
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002398psa_status_t psa_hash_compute(psa_algorithm_t alg,
2399 const uint8_t *input, size_t input_length,
2400 uint8_t *hash, size_t hash_size,
2401 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002402{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002403 *hash_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002404 if (!PSA_ALG_IS_HASH(alg)) {
2405 return PSA_ERROR_INVALID_ARGUMENT;
2406 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002407
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002408 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2409 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002410}
2411
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002412psa_status_t psa_hash_compare(psa_algorithm_t alg,
2413 const uint8_t *input, size_t input_length,
2414 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002415{
Ronald Cron3a95d2b2021-10-18 09:47:58 +02002416 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002417 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002418
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002419 if (!PSA_ALG_IS_HASH(alg)) {
2420 return PSA_ERROR_INVALID_ARGUMENT;
2421 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002422
Steven Cooreman1e582352021-02-18 17:24:37 +01002423 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002424 alg, input, input_length,
2425 actual_hash, sizeof(actual_hash),
2426 &actual_hash_length);
2427 if (status != PSA_SUCCESS) {
Gilles Peskineb3f4e5b2021-12-13 12:33:18 +01002428 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002429 }
2430 if (actual_hash_length != hash_length) {
Gilles Peskineb3f4e5b2021-12-13 12:33:18 +01002431 status = PSA_ERROR_INVALID_SIGNATURE;
2432 goto exit;
2433 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002434 if (mbedtls_psa_safer_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskineb3f4e5b2021-12-13 12:33:18 +01002435 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002436 }
Gilles Peskineb3f4e5b2021-12-13 12:33:18 +01002437
2438exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002439 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2440 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002441}
2442
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002443psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2444 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002445{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002446 if (source_operation->id == 0 ||
2447 target_operation->id != 0) {
2448 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002449 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002450
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002451 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2452 target_operation);
2453 if (status != PSA_SUCCESS) {
2454 psa_hash_abort(target_operation);
2455 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002456
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002457 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002458}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002459
2460
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002461/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002462/* MAC */
2463/****************************************************************/
2464
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002465psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002466{
Steven Cooreman07897832021-03-19 18:28:56 +01002467 /* Aborting a non-active operation is allowed */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002468 if (operation->id == 0) {
2469 return PSA_SUCCESS;
2470 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002471
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002472 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman15f0d922021-05-07 14:14:37 +02002473 operation->mac_size = 0;
2474 operation->is_sign = 0;
Steven Cooreman07897832021-03-19 18:28:56 +01002475 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002476
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002477 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002478}
2479
Ronald Cron1c650a12021-06-17 16:33:22 +02002480static psa_status_t psa_mac_finalize_alg_and_key_validation(
2481 psa_algorithm_t alg,
Ronald Crondef68e72021-06-17 16:46:44 +02002482 const psa_key_attributes_t *attributes,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002483 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002484{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002485 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002486 psa_key_type_t key_type = psa_get_key_type(attributes);
2487 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002488
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002489 if (!PSA_ALG_IS_MAC(alg)) {
2490 return PSA_ERROR_INVALID_ARGUMENT;
2491 }
Steven Cooreman07897832021-03-19 18:28:56 +01002492
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002493 /* Validate the combination of key type and algorithm */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002494 status = psa_mac_key_can_do(alg, key_type);
2495 if (status != PSA_SUCCESS) {
2496 return status;
2497 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002498
Steven Cooremana6474de2021-05-10 11:13:41 +02002499 /* Get the output length for the algorithm and key combination */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002500 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002501
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002502 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002503 /* A very short MAC is too short for security since it can be
2504 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2505 * so we make this our minimum, even though 32 bits is still
2506 * too small for security. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002507 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002508 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002509
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002510 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2511 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002512 /* It's impossible to "truncate" to a larger length than the full length
2513 * of the algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002514 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002515 }
2516
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002517 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinebc795822022-03-16 13:54:49 +01002518 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2519 * that is disabled in the compile-time configuration. The result can
2520 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2521 * configuration into account. In this case, force a return of
2522 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2523 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2524 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2525 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2526 * systematically generated tests. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002527 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinebc795822022-03-16 13:54:49 +01002528 }
2529
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002530 return PSA_SUCCESS;
Ronald Cron1c650a12021-06-17 16:33:22 +02002531}
2532
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002533static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2534 mbedtls_svc_key_id_t key,
2535 psa_algorithm_t alg,
2536 int is_sign)
Ronald Cron1c650a12021-06-17 16:33:22 +02002537{
2538 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2539 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002540 psa_key_attributes_t attributes;
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002541 psa_key_slot_t *slot = NULL;
Ronald Cron1c650a12021-06-17 16:33:22 +02002542
2543 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002544 if (operation->id != 0) {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002545 status = PSA_ERROR_BAD_STATE;
2546 goto exit;
2547 }
Ronald Cron1c650a12021-06-17 16:33:22 +02002548
2549 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002550 key,
2551 &slot,
2552 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2553 alg);
2554 if (status != PSA_SUCCESS) {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002555 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002556 }
Ronald Cron1c650a12021-06-17 16:33:22 +02002557
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002558 attributes = (psa_key_attributes_t) {
Ronald Cron1c650a12021-06-17 16:33:22 +02002559 .core = slot->attr
2560 };
2561
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002562 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2563 &operation->mac_size);
2564 if (status != PSA_SUCCESS) {
Ronald Cron1c650a12021-06-17 16:33:22 +02002565 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002566 }
Ronald Cron1c650a12021-06-17 16:33:22 +02002567
2568 operation->is_sign = is_sign;
Steven Cooreman07897832021-03-19 18:28:56 +01002569 /* Dispatch the MAC setup call with validated input */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002570 if (is_sign) {
2571 status = psa_driver_wrapper_mac_sign_setup(operation,
2572 &attributes,
2573 slot->key.data,
2574 slot->key.bytes,
2575 alg);
2576 } else {
2577 status = psa_driver_wrapper_mac_verify_setup(operation,
2578 &attributes,
2579 slot->key.data,
2580 slot->key.bytes,
2581 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002582 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002583
Gilles Peskinefbfac682018-07-08 20:51:54 +02002584exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002585 if (status != PSA_SUCCESS) {
2586 psa_mac_abort(operation);
2587 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002588
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002589 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002590
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002591 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002592}
2593
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002594psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2595 mbedtls_svc_key_id_t key,
2596 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002597{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002598 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002599}
2600
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002601psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2602 mbedtls_svc_key_id_t key,
2603 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002604{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002605 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002606}
2607
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002608psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2609 const uint8_t *input,
2610 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002611{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002612 if (operation->id == 0) {
2613 return PSA_ERROR_BAD_STATE;
2614 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002615
Steven Cooreman11743f92021-03-19 18:38:46 +01002616 /* Don't require hash implementations to behave correctly on a
2617 * zero-length input, which may have an invalid pointer. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002618 if (input_length == 0) {
2619 return PSA_SUCCESS;
2620 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002621
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002622 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2623 input, input_length);
2624 if (status != PSA_SUCCESS) {
2625 psa_mac_abort(operation);
2626 }
Steven Cooreman11743f92021-03-19 18:38:46 +01002627
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002628 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002629}
2630
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002631psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2632 uint8_t *mac,
2633 size_t mac_size,
2634 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002635{
Steven Cooreman87885df2021-03-19 19:04:39 +01002636 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2637 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002638
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002639 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002640 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002641 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002642 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002643
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002644 if (!operation->is_sign) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002645 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002646 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002647 }
Steven Cooreman15f0d922021-05-07 14:14:37 +02002648
Steven Cooremanf8ad2122021-05-11 11:09:13 +02002649 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2650 * once all the error checks are done. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002651 if (operation->mac_size == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002652 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002653 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002654 }
Steven Cooremanf8ad2122021-05-11 11:09:13 +02002655
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002656 if (mac_size < operation->mac_size) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002657 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman478ab542021-06-25 09:09:02 +01002658 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002659 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002660
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002661 status = psa_driver_wrapper_mac_sign_finish(operation,
2662 mac, operation->mac_size,
2663 mac_length);
Steven Cooreman15f0d922021-05-07 14:14:37 +02002664
Dave Rodgman478ab542021-06-25 09:09:02 +01002665exit:
Ronald Cron882eb782021-06-18 13:05:48 +02002666 /* In case of success, set the potential excess room in the output buffer
2667 * to an invalid value, to avoid potentially leaking a longer MAC.
2668 * In case of error, set the output length and content to a safe default,
2669 * such that in case the caller misses an error check, the output would be
2670 * an unachievable MAC.
2671 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002672 if (status != PSA_SUCCESS) {
Steven Cooreman15f0d922021-05-07 14:14:37 +02002673 *mac_length = mac_size;
Ronald Cron882eb782021-06-18 13:05:48 +02002674 operation->mac_size = 0;
Steven Cooreman15f0d922021-05-07 14:14:37 +02002675 }
mohammad16036df908f2018-04-02 08:34:15 -07002676
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002677 if (mac_size > operation->mac_size) {
2678 memset(&mac[operation->mac_size], '!',
2679 mac_size - operation->mac_size);
2680 }
Ronald Cron882eb782021-06-18 13:05:48 +02002681
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002682 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002683
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002684 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002685}
2686
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002687psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2688 const uint8_t *mac,
2689 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002690{
Steven Cooreman87885df2021-03-19 19:04:39 +01002691 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2692 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002693
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002694 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002695 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002696 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002697 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002698
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002699 if (operation->is_sign) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002700 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002701 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002702 }
Steven Cooreman15f0d922021-05-07 14:14:37 +02002703
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002704 if (operation->mac_size != mac_length) {
Steven Cooreman15f0d922021-05-07 14:14:37 +02002705 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002706 goto exit;
Steven Cooreman15f0d922021-05-07 14:14:37 +02002707 }
2708
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002709 status = psa_driver_wrapper_mac_verify_finish(operation,
2710 mac, mac_length);
Steven Cooreman15f0d922021-05-07 14:14:37 +02002711
Dave Rodgman478ab542021-06-25 09:09:02 +01002712exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002713 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002714
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002715 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002716}
2717
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002718static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2719 psa_algorithm_t alg,
2720 const uint8_t *input,
2721 size_t input_length,
2722 uint8_t *mac,
2723 size_t mac_size,
2724 size_t *mac_length,
2725 int is_sign)
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002726{
2727 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crondbb86462021-06-17 17:17:20 +02002728 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002729 psa_key_attributes_t attributes;
Ronald Crondbb86462021-06-17 17:17:20 +02002730 psa_key_slot_t *slot;
2731 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002732
Ronald Crondbb86462021-06-17 17:17:20 +02002733 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002734 key,
2735 &slot,
2736 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2737 alg);
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
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002742 attributes = (psa_key_attributes_t) {
Ronald Crondbb86462021-06-17 17:17:20 +02002743 .core = slot->attr
2744 };
2745
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002746 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2747 &operation_mac_size);
2748 if (status != PSA_SUCCESS) {
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002749 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002750 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002751
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002752 if (mac_size < operation_mac_size) {
Ronald Crondbb86462021-06-17 17:17:20 +02002753 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002754 goto exit;
Ronald Crondbb86462021-06-17 17:17:20 +02002755 }
2756
2757 status = psa_driver_wrapper_mac_compute(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002758 &attributes,
2759 slot->key.data, slot->key.bytes,
2760 alg,
2761 input, input_length,
2762 mac, operation_mac_size, mac_length);
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002763
2764exit:
Ronald Cron882eb782021-06-18 13:05:48 +02002765 /* In case of success, set the potential excess room in the output buffer
2766 * to an invalid value, to avoid potentially leaking a longer MAC.
2767 * In case of error, set the output length and content to a safe default,
2768 * such that in case the caller misses an error check, the output would be
2769 * an unachievable MAC.
2770 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002771 if (status != PSA_SUCCESS) {
Ronald Crondbb86462021-06-17 17:17:20 +02002772 *mac_length = mac_size;
Ronald Cron882eb782021-06-18 13:05:48 +02002773 operation_mac_size = 0;
Ronald Crondbb86462021-06-17 17:17:20 +02002774 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002775 if (mac_size > operation_mac_size) {
2776 memset(&mac[operation_mac_size], '!', mac_size - operation_mac_size);
2777 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002778
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002779 unlock_status = psa_unlock_key_slot(slot);
Ronald Crondbb86462021-06-17 17:17:20 +02002780
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002781 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002782}
2783
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002784psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002785 psa_algorithm_t alg,
2786 const uint8_t *input,
2787 size_t input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002788 uint8_t *mac,
2789 size_t mac_size,
2790 size_t *mac_length)
2791{
2792 return psa_mac_compute_internal(key, alg,
2793 input, input_length,
2794 mac, mac_size, mac_length, 1);
2795}
2796
2797psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2798 psa_algorithm_t alg,
2799 const uint8_t *input,
2800 size_t input_length,
2801 const uint8_t *mac,
2802 size_t mac_length)
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002803{
2804 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron4ed83682021-06-18 14:51:29 +02002805 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2806 size_t actual_mac_length;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002807
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002808 status = psa_mac_compute_internal(key, alg,
2809 input, input_length,
2810 actual_mac, sizeof(actual_mac),
2811 &actual_mac_length, 0);
2812 if (status != PSA_SUCCESS) {
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002813 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002814 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002815
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002816 if (mac_length != actual_mac_length) {
Ronald Cron4ed83682021-06-18 14:51:29 +02002817 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002818 goto exit;
Ronald Cron4ed83682021-06-18 14:51:29 +02002819 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002820 if (mbedtls_psa_safer_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Cron4ed83682021-06-18 14:51:29 +02002821 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002822 goto exit;
Ronald Cron4ed83682021-06-18 14:51:29 +02002823 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002824
2825exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002826 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002827
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002828 return status;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002829}
Gilles Peskine20035e32018-02-03 22:44:14 +01002830
Gilles Peskine20035e32018-02-03 22:44:14 +01002831/****************************************************************/
2832/* Asymmetric cryptography */
2833/****************************************************************/
2834
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002835static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2836 psa_algorithm_t alg)
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002837{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002838 if (input_is_message) {
2839 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2840 return PSA_ERROR_INVALID_ARGUMENT;
2841 }
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002842
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002843 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2844 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2845 return PSA_ERROR_INVALID_ARGUMENT;
2846 }
2847 }
2848 } else {
2849 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2850 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm56980482021-05-05 13:56:27 +02002851 }
2852 }
gabor-mezei-arm56980482021-05-05 13:56:27 +02002853
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002854 return PSA_SUCCESS;
gabor-mezei-arm56980482021-05-05 13:56:27 +02002855}
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002856
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002857static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2858 int input_is_message,
2859 psa_algorithm_t alg,
2860 const uint8_t *input,
2861 size_t input_length,
2862 uint8_t *signature,
2863 size_t signature_size,
2864 size_t *signature_length)
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002865{
2866 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2867 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002868 psa_key_attributes_t attributes;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002869 psa_key_slot_t *slot;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002870
2871 *signature_length = 0;
2872
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002873 status = psa_sign_verify_check_alg(input_is_message, alg);
2874 if (status != PSA_SUCCESS) {
gabor-mezei-arm56980482021-05-05 13:56:27 +02002875 return status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002876 }
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002877
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002878 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12ff4d52021-05-05 13:54:55 +02002879 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002880 * buffer can in principle be empty since it doesn't actually have
2881 * to be a hash.) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002882 if (signature_size == 0) {
2883 return PSA_ERROR_BUFFER_TOO_SMALL;
2884 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002885
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002886 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002887 key, &slot,
2888 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2889 PSA_KEY_USAGE_SIGN_HASH,
2890 alg);
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002891
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002892 if (status != PSA_SUCCESS) {
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002893 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002894 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002895
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002896 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002897 status = PSA_ERROR_INVALID_ARGUMENT;
2898 goto exit;
2899 }
2900
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002901 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002902 .core = slot->attr
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002903 };
2904
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002905 if (input_is_message) {
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002906 status = psa_driver_wrapper_sign_message(
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002907 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002908 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002909 signature, signature_size, signature_length);
2910 } else {
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002911
2912 status = psa_driver_wrapper_sign_hash(
2913 &attributes, slot->key.data, slot->key.bytes,
2914 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002915 signature, signature_size, signature_length);
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002916 }
2917
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002918
2919exit:
2920 /* Fill the unused part of the output buffer (the whole buffer on error,
2921 * the trailing part on success) with something that isn't a valid signature
2922 * (barring an attack on the signature and deliberately-crafted input),
2923 * in case the caller doesn't check the return status properly. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002924 if (status == PSA_SUCCESS) {
2925 memset(signature + *signature_length, '!',
2926 signature_size - *signature_length);
2927 } else {
2928 memset(signature, '!', signature_size);
2929 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002930 /* If signature_size is 0 then we have nothing to do. We must not call
2931 * memset because signature may be NULL in this case. */
2932
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002933 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002934
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002935 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002936}
2937
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002938static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2939 int input_is_message,
2940 psa_algorithm_t alg,
2941 const uint8_t *input,
2942 size_t input_length,
2943 const uint8_t *signature,
2944 size_t signature_length)
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002945{
2946 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2947 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2948 psa_key_slot_t *slot;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002949
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002950 status = psa_sign_verify_check_alg(input_is_message, alg);
2951 if (status != PSA_SUCCESS) {
gabor-mezei-arm56980482021-05-05 13:56:27 +02002952 return status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002953 }
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002954
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002955 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002956 key, &slot,
2957 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2958 PSA_KEY_USAGE_VERIFY_HASH,
2959 alg);
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002960
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002961 if (status != PSA_SUCCESS) {
2962 return status;
2963 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002964
2965 psa_key_attributes_t attributes = {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002966 .core = slot->attr
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002967 };
2968
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002969 if (input_is_message) {
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002970 status = psa_driver_wrapper_verify_message(
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002971 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002972 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002973 signature, signature_length);
2974 } else {
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002975 status = psa_driver_wrapper_verify_hash(
2976 &attributes, slot->key.data, slot->key.bytes,
2977 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002978 signature, signature_length);
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002979 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002980
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002981 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002982
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002983 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002984
2985}
2986
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002987psa_status_t psa_sign_message_builtin(
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002988 const psa_key_attributes_t *attributes,
2989 const uint8_t *key_buffer,
2990 size_t key_buffer_size,
2991 psa_algorithm_t alg,
2992 const uint8_t *input,
2993 size_t input_length,
2994 uint8_t *signature,
2995 size_t signature_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002996 size_t *signature_length)
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002997{
2998 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002999
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003000 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-arm9719a842021-05-03 16:26:20 +02003001 size_t hash_length;
3002 uint8_t hash[PSA_HASH_MAX_SIZE];
3003
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02003004 status = psa_driver_wrapper_hash_compute(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003005 PSA_ALG_SIGN_GET_HASH(alg),
3006 input, input_length,
3007 hash, sizeof(hash), &hash_length);
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003008
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003009 if (status != PSA_SUCCESS) {
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02003010 return status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003011 }
gabor-mezei-arm9719a842021-05-03 16:26:20 +02003012
3013 return psa_driver_wrapper_sign_hash(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003014 attributes, key_buffer, key_buffer_size,
3015 alg, hash, hash_length,
3016 signature, signature_size, signature_length);
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02003017 }
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003018
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003019 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003020}
3021
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003022psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3023 psa_algorithm_t alg,
Thomas Daubney290aac42024-01-18 17:23:02 +00003024 const uint8_t *input_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003025 size_t input_length,
Thomas Daubney290aac42024-01-18 17:23:02 +00003026 uint8_t *signature_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003027 size_t signature_size,
3028 size_t *signature_length)
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003029{
Thomas Daubney290aac42024-01-18 17:23:02 +00003030 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3031 LOCAL_INPUT_DECLARE(input_external, input);
3032 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3033
3034 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3035 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3036 status = psa_sign_internal(key, 1, alg, input, input_length, signature,
3037 signature_size, signature_length);
3038
Thomas Daubneyf446b892024-01-30 13:36:01 +00003039#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney290aac42024-01-18 17:23:02 +00003040exit:
Thomas Daubneyf446b892024-01-30 13:36:01 +00003041#endif
Thomas Daubney290aac42024-01-18 17:23:02 +00003042 LOCAL_INPUT_FREE(input_external, input);
3043 LOCAL_OUTPUT_FREE(signature_external, signature);
3044 return status;
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003045}
3046
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02003047psa_status_t psa_verify_message_builtin(
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003048 const psa_key_attributes_t *attributes,
3049 const uint8_t *key_buffer,
3050 size_t key_buffer_size,
3051 psa_algorithm_t alg,
3052 const uint8_t *input,
3053 size_t input_length,
3054 const uint8_t *signature,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003055 size_t signature_length)
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003056{
3057 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003058
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003059 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-arm9719a842021-05-03 16:26:20 +02003060 size_t hash_length;
3061 uint8_t hash[PSA_HASH_MAX_SIZE];
3062
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02003063 status = psa_driver_wrapper_hash_compute(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003064 PSA_ALG_SIGN_GET_HASH(alg),
3065 input, input_length,
3066 hash, sizeof(hash), &hash_length);
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003067
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003068 if (status != PSA_SUCCESS) {
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02003069 return status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003070 }
gabor-mezei-arm9719a842021-05-03 16:26:20 +02003071
3072 return psa_driver_wrapper_verify_hash(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003073 attributes, key_buffer, key_buffer_size,
3074 alg, hash, hash_length,
3075 signature, signature_length);
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02003076 }
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003077
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003078 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003079}
3080
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003081psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3082 psa_algorithm_t alg,
Thomas Daubney290aac42024-01-18 17:23:02 +00003083 const uint8_t *input_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003084 size_t input_length,
Thomas Daubney290aac42024-01-18 17:23:02 +00003085 const uint8_t *signature_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003086 size_t signature_length)
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003087{
Thomas Daubney290aac42024-01-18 17:23:02 +00003088 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3089 LOCAL_INPUT_DECLARE(input_external, input);
3090 LOCAL_INPUT_DECLARE(signature_external, signature);
3091
3092 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3093 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3094 status = psa_verify_internal(key, 1, alg, input, input_length, signature,
3095 signature_length);
3096
Thomas Daubneyf446b892024-01-30 13:36:01 +00003097#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney290aac42024-01-18 17:23:02 +00003098exit:
Thomas Daubneyf446b892024-01-30 13:36:01 +00003099#endif
Thomas Daubney290aac42024-01-18 17:23:02 +00003100 LOCAL_INPUT_FREE(input_external, input);
3101 LOCAL_INPUT_FREE(signature_external, signature);
3102
3103 return status;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02003104}
3105
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02003106psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003107 const psa_key_attributes_t *attributes,
3108 const uint8_t *key_buffer, size_t key_buffer_size,
3109 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003110 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskine20035e32018-02-03 22:44:14 +01003111{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003112 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3113 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3114 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003115#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003116 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3117 return mbedtls_psa_rsa_sign_hash(
3118 attributes,
3119 key_buffer, key_buffer_size,
3120 alg, hash, hash_length,
3121 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003122#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3123 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003124 } else {
3125 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003126 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003127 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3128 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003129#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003130 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3131 return mbedtls_psa_ecdsa_sign_hash(
3132 attributes,
3133 key_buffer, key_buffer_size,
3134 alg, hash, hash_length,
3135 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003136#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3137 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003138 } else {
3139 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003140 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003141 }
Ronald Cron4501c982021-03-19 20:09:32 +01003142
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003143 (void) key_buffer;
3144 (void) key_buffer_size;
3145 (void) hash;
3146 (void) hash_length;
3147 (void) signature;
3148 (void) signature_size;
3149 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003150
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003151 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003152}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003153
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003154psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3155 psa_algorithm_t alg,
Thomas Daubney290aac42024-01-18 17:23:02 +00003156 const uint8_t *hash_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003157 size_t hash_length,
Thomas Daubney290aac42024-01-18 17:23:02 +00003158 uint8_t *signature_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003159 size_t signature_size,
3160 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003161{
Thomas Daubney290aac42024-01-18 17:23:02 +00003162 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3163 LOCAL_INPUT_DECLARE(hash_external, hash);
3164 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3165
3166 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3167 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3168 status = psa_sign_internal(key, 0, alg, hash, hash_length, signature,
3169 signature_size, signature_length);
3170
Thomas Daubneyf446b892024-01-30 13:36:01 +00003171#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney290aac42024-01-18 17:23:02 +00003172exit:
Thomas Daubneyf446b892024-01-30 13:36:01 +00003173#endif
Thomas Daubney290aac42024-01-18 17:23:02 +00003174 LOCAL_INPUT_FREE(hash_external, hash);
3175 LOCAL_OUTPUT_FREE(signature_external, signature);
3176
3177 return status;
itayzafrir5c753392018-05-08 11:18:38 +03003178}
3179
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02003180psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003181 const psa_key_attributes_t *attributes,
3182 const uint8_t *key_buffer, size_t key_buffer_size,
3183 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003184 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003185{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003186 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3187 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3188 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003189#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003190 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3191 return mbedtls_psa_rsa_verify_hash(
3192 attributes,
3193 key_buffer, key_buffer_size,
3194 alg, hash, hash_length,
3195 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003196#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3197 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003198 } else {
3199 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003200 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003201 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3202 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003203#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003204 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3205 return mbedtls_psa_ecdsa_verify_hash(
3206 attributes,
3207 key_buffer, key_buffer_size,
3208 alg, hash, hash_length,
3209 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003210#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3211 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003212 } else {
3213 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003214 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003215 }
Ronald Cron4501c982021-03-19 20:09:32 +01003216
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003217 (void) key_buffer;
3218 (void) key_buffer_size;
3219 (void) hash;
3220 (void) hash_length;
3221 (void) signature;
3222 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003223
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003224 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003225}
3226
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003227psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3228 psa_algorithm_t alg,
Thomas Daubney290aac42024-01-18 17:23:02 +00003229 const uint8_t *hash_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003230 size_t hash_length,
Thomas Daubney290aac42024-01-18 17:23:02 +00003231 const uint8_t *signature_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003232 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003233{
Thomas Daubney290aac42024-01-18 17:23:02 +00003234 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3235 LOCAL_INPUT_DECLARE(hash_external, hash);
3236 LOCAL_INPUT_DECLARE(signature_external, signature);
3237
3238 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3239 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3240 status = psa_verify_internal(key, 0, alg, hash, hash_length, signature,
3241 signature_length);
3242
Thomas Daubneyf446b892024-01-30 13:36:01 +00003243#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney290aac42024-01-18 17:23:02 +00003244exit:
Thomas Daubneyf446b892024-01-30 13:36:01 +00003245#endif
Thomas Daubney290aac42024-01-18 17:23:02 +00003246 LOCAL_INPUT_FREE(hash_external, hash);
3247 LOCAL_INPUT_FREE(signature_external, signature);
3248
3249 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01003250}
3251
John Durkop0e005192020-10-31 22:06:54 -07003252#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003253static void psa_rsa_oaep_set_padding_mode(psa_algorithm_t alg,
3254 mbedtls_rsa_context *rsa)
Gilles Peskine072ac562018-06-30 00:21:29 +02003255{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003256 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH(alg);
3257 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa(hash_alg);
3258 mbedtls_md_type_t md_alg = mbedtls_md_get_type(md_info);
3259 mbedtls_rsa_set_padding(rsa, MBEDTLS_RSA_PKCS_V21, md_alg);
Gilles Peskine072ac562018-06-30 00:21:29 +02003260}
John Durkop0e005192020-10-31 22:06:54 -07003261#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003262
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003263psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3264 psa_algorithm_t alg,
3265 const uint8_t *input,
3266 size_t input_length,
3267 const uint8_t *salt,
3268 size_t salt_length,
3269 uint8_t *output,
3270 size_t output_size,
3271 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003272{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003273 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003274 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003275 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003276
Darryl Green5cc689a2018-07-24 15:34:10 +01003277 (void) input;
3278 (void) input_length;
3279 (void) salt;
3280 (void) output;
3281 (void) output_size;
3282
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003283 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003284
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003285 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3286 return PSA_ERROR_INVALID_ARGUMENT;
3287 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003288
Ronald Cron5c522922020-11-14 16:35:34 +01003289 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003290 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3291 if (status != PSA_SUCCESS) {
3292 return status;
3293 }
3294 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3295 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003296 status = PSA_ERROR_INVALID_ARGUMENT;
3297 goto exit;
3298 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003299
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003300 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Ronald Cron7207d572021-09-08 14:28:35 +02003301#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003302 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooremana2371e52020-07-28 14:30:39 +02003303 mbedtls_rsa_context *rsa = NULL;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003304 status = mbedtls_psa_rsa_load_representation(slot->attr.type,
3305 slot->key.data,
3306 slot->key.bytes,
3307 &rsa);
3308 if (status != PSA_SUCCESS) {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003309 goto rsa_exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003310 }
Steven Cooremana2371e52020-07-28 14:30:39 +02003311
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003312 if (output_size < mbedtls_rsa_get_len(rsa)) {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003313 status = PSA_ERROR_BUFFER_TOO_SMALL;
3314 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003315 }
Ronald Cron7207d572021-09-08 14:28:35 +02003316#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3317 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003318 if (alg == PSA_ALG_RSA_PKCS1V15_CRYPT) {
Ronald Cron7207d572021-09-08 14:28:35 +02003319#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003320 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003321 mbedtls_rsa_pkcs1_encrypt(rsa,
3322 mbedtls_psa_get_random,
3323 MBEDTLS_PSA_RANDOM_STATE,
3324 MBEDTLS_RSA_PUBLIC,
3325 input_length,
3326 input,
3327 output));
Ronald Cron7207d572021-09-08 14:28:35 +02003328#else
3329 status = PSA_ERROR_NOT_SUPPORTED;
3330#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003331 } else
3332 if (PSA_ALG_IS_RSA_OAEP(alg)) {
Ronald Cron7207d572021-09-08 14:28:35 +02003333#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003334 psa_rsa_oaep_set_padding_mode(alg, rsa);
Steven Cooreman4fed4552020-08-03 14:46:03 +02003335 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003336 mbedtls_rsa_rsaes_oaep_encrypt(rsa,
3337 mbedtls_psa_get_random,
3338 MBEDTLS_PSA_RANDOM_STATE,
3339 MBEDTLS_RSA_PUBLIC,
3340 salt, salt_length,
3341 input_length,
3342 input,
3343 output));
Ronald Cron7207d572021-09-08 14:28:35 +02003344#else
3345 status = PSA_ERROR_NOT_SUPPORTED;
3346#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003347 } else {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003348 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003349 }
Ronald Cron7207d572021-09-08 14:28:35 +02003350#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003351 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003352rsa_exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003353 if (status == PSA_SUCCESS) {
3354 *output_length = mbedtls_rsa_get_len(rsa);
3355 }
Steven Cooremana01795d2020-07-24 22:48:15 +02003356
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003357 mbedtls_rsa_free(rsa);
3358 mbedtls_free(rsa);
John Durkop9814fa22020-11-04 12:28:15 -08003359#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003360 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003361 } else {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003362 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003363 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003364
3365exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003366 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003367
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003368 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003369}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003370
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003371psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3372 psa_algorithm_t alg,
3373 const uint8_t *input,
3374 size_t input_length,
3375 const uint8_t *salt,
3376 size_t salt_length,
3377 uint8_t *output,
3378 size_t output_size,
3379 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003380{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003381 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003382 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003383 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003384
Darryl Green5cc689a2018-07-24 15:34:10 +01003385 (void) input;
3386 (void) input_length;
3387 (void) salt;
3388 (void) output;
3389 (void) output_size;
3390
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003391 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003392
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003393 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3394 return PSA_ERROR_INVALID_ARGUMENT;
3395 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003396
Ronald Cron5c522922020-11-14 16:35:34 +01003397 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003398 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3399 if (status != PSA_SUCCESS) {
3400 return status;
3401 }
3402 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003403 status = PSA_ERROR_INVALID_ARGUMENT;
3404 goto exit;
3405 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003406
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003407 if (slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
Ronald Cron7207d572021-09-08 14:28:35 +02003408#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003409 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003410 mbedtls_rsa_context *rsa = NULL;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003411 status = mbedtls_psa_rsa_load_representation(slot->attr.type,
3412 slot->key.data,
3413 slot->key.bytes,
3414 &rsa);
3415 if (status != PSA_SUCCESS) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003416 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003417 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003418
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003419 if (input_length != mbedtls_rsa_get_len(rsa)) {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003420 status = PSA_ERROR_INVALID_ARGUMENT;
3421 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003422 }
Ronald Cron7207d572021-09-08 14:28:35 +02003423#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3424 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003425
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003426 if (alg == PSA_ALG_RSA_PKCS1V15_CRYPT) {
Ronald Cron7207d572021-09-08 14:28:35 +02003427#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003428 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003429 mbedtls_rsa_pkcs1_decrypt(rsa,
3430 mbedtls_psa_get_random,
3431 MBEDTLS_PSA_RANDOM_STATE,
3432 MBEDTLS_RSA_PRIVATE,
3433 output_length,
3434 input,
3435 output,
3436 output_size));
Ronald Cron7207d572021-09-08 14:28:35 +02003437#else
3438 status = PSA_ERROR_NOT_SUPPORTED;
3439#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003440 } else
3441 if (PSA_ALG_IS_RSA_OAEP(alg)) {
Ronald Cron7207d572021-09-08 14:28:35 +02003442#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003443 psa_rsa_oaep_set_padding_mode(alg, rsa);
Steven Cooreman4fed4552020-08-03 14:46:03 +02003444 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003445 mbedtls_rsa_rsaes_oaep_decrypt(rsa,
3446 mbedtls_psa_get_random,
3447 MBEDTLS_PSA_RANDOM_STATE,
3448 MBEDTLS_RSA_PRIVATE,
3449 salt, salt_length,
3450 output_length,
3451 input,
3452 output,
3453 output_size));
Ronald Cron7207d572021-09-08 14:28:35 +02003454#else
3455 status = PSA_ERROR_NOT_SUPPORTED;
3456#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003457 } else {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003458 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003459 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003460
Ronald Cron7207d572021-09-08 14:28:35 +02003461#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003462 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003463rsa_exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003464 mbedtls_rsa_free(rsa);
3465 mbedtls_free(rsa);
John Durkop6ba40d12020-11-10 08:50:04 -08003466#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3467 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003468 } else {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003469 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003470 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003471
3472exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003473 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003474
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003475 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003476}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003477
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003478
3479
mohammad1603503973b2018-03-12 15:59:30 +02003480/****************************************************************/
3481/* Symmetric cryptography */
3482/****************************************************************/
3483
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003484static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
3485 mbedtls_svc_key_id_t key,
3486 psa_algorithm_t alg,
3487 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02003488{
3489 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3490 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003491 psa_key_attributes_t attributes;
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003492 psa_key_slot_t *slot = NULL;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003493 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
3494 PSA_KEY_USAGE_ENCRYPT :
3495 PSA_KEY_USAGE_DECRYPT);
Ronald Cronab99ac22020-10-01 16:38:28 +02003496
3497 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003498 if (operation->id != 0) {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003499 status = PSA_ERROR_BAD_STATE;
3500 goto exit;
3501 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003502
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003503 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003504 status = PSA_ERROR_INVALID_ARGUMENT;
3505 goto exit;
3506 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003507
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003508 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
3509 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003510 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003511 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003512
Ronald Cron49fafa92021-03-10 08:34:23 +01003513 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003514 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003515 * so we only set it (in the driver wrapper) after resources have been
3516 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003517 operation->iv_set = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003518 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003519 operation->iv_required = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003520 } else if (slot->attr.type == PSA_KEY_TYPE_ARC4) {
Gilles Peskine4a83c102022-04-20 17:00:22 +02003521 operation->iv_required = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003522 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02003523 operation->iv_required = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003524 }
3525 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02003526
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003527 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003528 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01003529 };
3530
Ronald Cronab99ac22020-10-01 16:38:28 +02003531 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003532 if (cipher_operation == MBEDTLS_ENCRYPT) {
3533 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
3534 &attributes,
3535 slot->key.data,
3536 slot->key.bytes,
3537 alg);
3538 } else {
3539 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
3540 &attributes,
3541 slot->key.data,
3542 slot->key.bytes,
3543 alg);
3544 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003545
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003546exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003547 if (status != PSA_SUCCESS) {
3548 psa_cipher_abort(operation);
3549 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003550
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003551 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003552
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003553 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02003554}
3555
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003556psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
3557 mbedtls_svc_key_id_t key,
3558 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003559{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003560 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003561}
3562
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003563psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
3564 mbedtls_svc_key_id_t key,
3565 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003566{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003567 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003568}
3569
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003570psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
3571 uint8_t *iv,
3572 size_t iv_size,
3573 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02003574{
Ronald Cron6d051732020-10-01 14:10:20 +02003575 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc423acb2021-07-05 12:31:44 +02003576 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergey04eb7c02023-03-06 15:37:23 -07003577 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01003578
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003579 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003580 status = PSA_ERROR_BAD_STATE;
3581 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003582 }
3583
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003584 if (operation->iv_set || !operation->iv_required) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003585 status = PSA_ERROR_BAD_STATE;
3586 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003587 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003588
Ronald Cronc423acb2021-07-05 12:31:44 +02003589 default_iv_length = operation->default_iv_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003590 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01003591 status = PSA_ERROR_BUFFER_TOO_SMALL;
3592 goto exit;
3593 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003594
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003595 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc423acb2021-07-05 12:31:44 +02003596 status = PSA_ERROR_GENERIC_ERROR;
3597 goto exit;
3598 }
3599
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003600 status = psa_generate_random(local_iv, default_iv_length);
3601 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01003602 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003603 }
Ronald Cron5618a392021-03-26 09:52:26 +01003604
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003605 status = psa_driver_wrapper_cipher_set_iv(operation,
3606 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01003607
3608exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003609 if (status == PSA_SUCCESS) {
3610 memcpy(iv, local_iv, default_iv_length);
Ronald Cronc423acb2021-07-05 12:31:44 +02003611 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02003612 operation->iv_set = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003613 } else {
Ronald Cronc423acb2021-07-05 12:31:44 +02003614 *iv_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003615 psa_cipher_abort(operation);
Ronald Cronc423acb2021-07-05 12:31:44 +02003616 }
Ronald Cron6d051732020-10-01 14:10:20 +02003617
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003618 return status;
mohammad1603503973b2018-03-12 15:59:30 +02003619}
3620
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003621psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
3622 const uint8_t *iv,
3623 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02003624{
Ronald Cron6d051732020-10-01 14:10:20 +02003625 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003626
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003627 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003628 status = PSA_ERROR_BAD_STATE;
3629 goto exit;
3630 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003631
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003632 if (operation->iv_set || !operation->iv_required) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003633 status = PSA_ERROR_BAD_STATE;
3634 goto exit;
3635 }
Ronald Crona0d68172021-03-26 10:15:08 +01003636
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003637 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003638 status = PSA_ERROR_INVALID_ARGUMENT;
3639 goto exit;
3640 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003641
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003642 status = psa_driver_wrapper_cipher_set_iv(operation,
3643 iv,
3644 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02003645
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003646exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003647 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03003648 operation->iv_set = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003649 } else {
3650 psa_cipher_abort(operation);
3651 }
3652 return status;
mohammad1603503973b2018-03-12 15:59:30 +02003653}
3654
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003655psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
3656 const uint8_t *input,
3657 size_t input_length,
3658 uint8_t *output,
3659 size_t output_size,
3660 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02003661{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003662 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003663
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003664 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003665 status = PSA_ERROR_BAD_STATE;
3666 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003667 }
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003668
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003669 if (operation->iv_required && !operation->iv_set) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003670 status = PSA_ERROR_BAD_STATE;
3671 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003672 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003673
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003674 status = psa_driver_wrapper_cipher_update(operation,
3675 input,
3676 input_length,
3677 output,
3678 output_size,
3679 output_length);
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003680
3681exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003682 if (status != PSA_SUCCESS) {
3683 psa_cipher_abort(operation);
3684 }
Ronald Cron6d051732020-10-01 14:10:20 +02003685
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003686 return status;
mohammad1603503973b2018-03-12 15:59:30 +02003687}
3688
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003689psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
3690 uint8_t *output,
3691 size_t output_size,
3692 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02003693{
David Saadab4ecc272019-02-14 13:48:10 +02003694 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003695
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003696 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003697 status = PSA_ERROR_BAD_STATE;
3698 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003699 }
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003700
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003701 if (operation->iv_required && !operation->iv_set) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003702 status = PSA_ERROR_BAD_STATE;
3703 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003704 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003705
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003706 status = psa_driver_wrapper_cipher_finish(operation,
3707 output,
3708 output_size,
3709 output_length);
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003710
3711exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003712 if (status == PSA_SUCCESS) {
3713 return psa_cipher_abort(operation);
3714 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02003715 *output_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003716 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01003717
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003718 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003719 }
mohammad1603503973b2018-03-12 15:59:30 +02003720}
3721
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003722psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02003723{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003724 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02003725 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003726 * in use. It's ok to call abort on such an object, and there's
3727 * nothing to do. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003728 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02003729 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003730
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003731 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02003732
Ronald Cron49fafa92021-03-10 08:34:23 +01003733 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003734 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003735 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003736
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003737 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02003738}
3739
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003740psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
3741 psa_algorithm_t alg,
David Horstmann926193a2023-12-13 15:55:25 +00003742 const uint8_t *input_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003743 size_t input_length,
David Horstmann926193a2023-12-13 15:55:25 +00003744 uint8_t *output_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003745 size_t output_size,
3746 size_t *output_length)
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003747{
3748 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003749 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003750 psa_key_attributes_t attributes;
Ronald Cron16377072021-07-08 19:00:07 +02003751 psa_key_slot_t *slot = NULL;
Ronald Cron4c224fe2021-07-09 18:44:58 +02003752 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
3753 size_t default_iv_length = 0;
gabor-mezei-arm52ae8712021-06-25 15:21:11 +02003754
David Horstmannb80e35a2023-12-14 18:12:47 +00003755 LOCAL_INPUT_DECLARE(input_external, input);
3756 LOCAL_OUTPUT_DECLARE(output_external, output);
3757
David Horstmann926193a2023-12-13 15:55:25 +00003758 LOCAL_INPUT_ALLOC(input_external, input_length, input);
David Horstmann926193a2023-12-13 15:55:25 +00003759 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmannd2ad8862023-11-27 17:43:05 +00003760
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003761 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron16377072021-07-08 19:00:07 +02003762 status = PSA_ERROR_INVALID_ARGUMENT;
3763 goto exit;
3764 }
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003765
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003766 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3767 PSA_KEY_USAGE_ENCRYPT,
3768 alg);
3769 if (status != PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003770 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003771 }
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003772
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003773 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003774 .core = slot->attr
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003775 };
3776
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003777 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
3778 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron4c224fe2021-07-09 18:44:58 +02003779 status = PSA_ERROR_GENERIC_ERROR;
3780 goto exit;
3781 }
3782
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003783 if (default_iv_length > 0) {
3784 if (output_size < default_iv_length) {
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003785 status = PSA_ERROR_BUFFER_TOO_SMALL;
3786 goto exit;
3787 }
3788
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003789 status = psa_generate_random(local_iv, default_iv_length);
3790 if (status != PSA_SUCCESS) {
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003791 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003792 }
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003793 }
3794
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003795 status = psa_driver_wrapper_cipher_encrypt(
3796 &attributes, slot->key.data, slot->key.bytes,
Ronald Cron4c224fe2021-07-09 18:44:58 +02003797 alg, local_iv, default_iv_length, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003798 mbedtls_buffer_offset(output, default_iv_length),
3799 output_size - default_iv_length, output_length);
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003800
3801exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003802 unlock_status = psa_unlock_key_slot(slot);
3803 if (status == PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003804 status = unlock_status;
Ronald Cron4c224fe2021-07-09 18:44:58 +02003805 }
Ronald Cron16377072021-07-08 19:00:07 +02003806
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003807 if (status == PSA_SUCCESS) {
3808 if (default_iv_length > 0) {
3809 memcpy(output, local_iv, default_iv_length);
3810 }
3811 *output_length += default_iv_length;
3812 } else {
3813 *output_length = 0;
3814 }
3815
David Horstmannb80e35a2023-12-14 18:12:47 +00003816 LOCAL_INPUT_FREE(input_external, input);
3817 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannd2ad8862023-11-27 17:43:05 +00003818
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003819 return status;
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003820}
3821
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003822psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
3823 psa_algorithm_t alg,
3824 const uint8_t *input,
3825 size_t input_length,
3826 uint8_t *output,
3827 size_t output_size,
3828 size_t *output_length)
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003829{
3830 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003831 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003832 psa_key_attributes_t attributes;
Ronald Cron16377072021-07-08 19:00:07 +02003833 psa_key_slot_t *slot = NULL;
gabor-mezei-arm52ae8712021-06-25 15:21:11 +02003834
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003835 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron16377072021-07-08 19:00:07 +02003836 status = PSA_ERROR_INVALID_ARGUMENT;
3837 goto exit;
3838 }
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003839
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003840 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3841 PSA_KEY_USAGE_DECRYPT,
3842 alg);
3843 if (status != PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003844 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003845 }
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003846
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003847 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003848 .core = slot->attr
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003849 };
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003850
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003851 if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm3fd792d2021-06-25 15:25:38 +02003852 status = PSA_ERROR_INVALID_ARGUMENT;
3853 goto exit;
3854 }
3855
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003856 status = psa_driver_wrapper_cipher_decrypt(
3857 &attributes, slot->key.data, slot->key.bytes,
3858 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003859 output, output_size, output_length);
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003860
gabor-mezei-arm3fd792d2021-06-25 15:25:38 +02003861exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003862 unlock_status = psa_unlock_key_slot(slot);
3863 if (status == PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003864 status = unlock_status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003865 }
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003866
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003867 if (status != PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003868 *output_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003869 }
Ronald Cron16377072021-07-08 19:00:07 +02003870
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003871 return status;
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003872}
3873
3874
mohammad16035955c982018-04-26 00:53:03 +03003875/****************************************************************/
3876/* AEAD */
3877/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003878
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003879psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
3880 psa_algorithm_t alg,
3881 const uint8_t *nonce,
3882 size_t nonce_length,
3883 const uint8_t *additional_data,
3884 size_t additional_data_length,
3885 const uint8_t *plaintext,
3886 size_t plaintext_length,
3887 uint8_t *ciphertext,
3888 size_t ciphertext_size,
3889 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03003890{
Ronald Cron215633c2021-03-16 17:15:37 +01003891 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3892 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003893
mohammad1603f08a5502018-06-03 15:05:47 +03003894 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003895
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003896 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
3897 return PSA_ERROR_NOT_SUPPORTED;
3898 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01003899
Ronald Cron9a986162021-03-26 12:40:07 +01003900 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003901 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3902 if (status != PSA_SUCCESS) {
3903 return status;
3904 }
mohammad16035955c982018-04-26 00:53:03 +03003905
Ronald Cron215633c2021-03-16 17:15:37 +01003906 psa_key_attributes_t attributes = {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003907 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01003908 };
mohammad16035955c982018-04-26 00:53:03 +03003909
Ronald Cronde822812021-03-17 16:08:20 +01003910 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003911 &attributes, slot->key.data, slot->key.bytes,
3912 alg,
3913 nonce, nonce_length,
3914 additional_data, additional_data_length,
3915 plaintext, plaintext_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003916 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02003917
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003918 if (status != PSA_SUCCESS && ciphertext_size != 0) {
3919 memset(ciphertext, 0, ciphertext_size);
3920 }
Gilles Peskine2d277862018-06-18 15:41:12 +02003921
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003922 psa_unlock_key_slot(slot);
mohammad16035955c982018-04-26 00:53:03 +03003923
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003924 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02003925}
3926
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003927psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
3928 psa_algorithm_t alg,
3929 const uint8_t *nonce,
3930 size_t nonce_length,
3931 const uint8_t *additional_data,
3932 size_t additional_data_length,
3933 const uint8_t *ciphertext,
3934 size_t ciphertext_length,
3935 uint8_t *plaintext,
3936 size_t plaintext_size,
3937 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03003938{
Ronald Cron215633c2021-03-16 17:15:37 +01003939 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3940 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003941
Gilles Peskineee652a32018-06-01 19:23:52 +02003942 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003943
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003944 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
3945 return PSA_ERROR_NOT_SUPPORTED;
3946 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01003947
Ronald Cron9a986162021-03-26 12:40:07 +01003948 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003949 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3950 if (status != PSA_SUCCESS) {
3951 return status;
3952 }
mohammad16035955c982018-04-26 00:53:03 +03003953
Ronald Cron215633c2021-03-16 17:15:37 +01003954 psa_key_attributes_t attributes = {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003955 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01003956 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003957
Ronald Cronde822812021-03-17 16:08:20 +01003958 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003959 &attributes, slot->key.data, slot->key.bytes,
3960 alg,
3961 nonce, nonce_length,
3962 additional_data, additional_data_length,
3963 ciphertext, ciphertext_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003964 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02003965
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003966 if (status != PSA_SUCCESS && plaintext_size != 0) {
3967 memset(plaintext, 0, plaintext_size);
3968 }
mohammad160360a64d02018-06-03 17:20:42 +03003969
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003970 psa_unlock_key_slot(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01003971
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003972 return status;
mohammad16035955c982018-04-26 00:53:03 +03003973}
3974
Gilles Peskinee59236f2018-01-27 23:32:46 +01003975/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003976/* Generators */
3977/****************************************************************/
3978
John Durkop07cc04a2020-11-16 22:08:34 -08003979#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3980 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3981 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3982#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman9878a162021-05-06 17:58:36 +02003983#endif /* At least one builtin KDF */
3984
3985#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3986 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3987 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3988static psa_status_t psa_key_derivation_start_hmac(
3989 psa_mac_operation_t *operation,
3990 psa_algorithm_t hash_alg,
3991 const uint8_t *hmac_key,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003992 size_t hmac_key_length)
Steven Cooreman9878a162021-05-06 17:58:36 +02003993{
3994 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3995 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003996 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
3997 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
3998 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman9878a162021-05-06 17:58:36 +02003999
Steven Cooreman15f0d922021-05-07 14:14:37 +02004000 operation->is_sign = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004001 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman15f0d922021-05-07 14:14:37 +02004002
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004003 status = psa_driver_wrapper_mac_sign_setup(operation,
4004 &attributes,
4005 hmac_key, hmac_key_length,
4006 PSA_ALG_HMAC(hash_alg));
Steven Cooreman9878a162021-05-06 17:58:36 +02004007
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004008 psa_reset_key_attributes(&attributes);
4009 return status;
Steven Cooreman9878a162021-05-06 17:58:36 +02004010}
4011#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08004012
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004013#define HKDF_STATE_INIT 0 /* no input yet */
4014#define HKDF_STATE_STARTED 1 /* got salt */
4015#define HKDF_STATE_KEYED 2 /* got key */
4016#define HKDF_STATE_OUTPUT 3 /* output started */
4017
Gilles Peskinecbe66502019-05-16 16:59:18 +02004018static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004019 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004020{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004021 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
4022 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
4023 } else {
4024 return operation->alg;
4025 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004026}
4027
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004028psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02004029{
4030 psa_status_t status = PSA_SUCCESS;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004031 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
4032 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02004033 /* The object has (apparently) been initialized but it is not
4034 * in use. It's ok to call abort on such an object, and there's
4035 * nothing to do. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004036 } else
John Durkopd0321952020-10-29 21:37:36 -07004037#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004038 if (PSA_ALG_IS_HKDF(kdf_alg)) {
4039 mbedtls_free(operation->ctx.hkdf.info);
4040 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
4041 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004042#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4043#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4044 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004045 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
4046 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
4047 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
4048 if (operation->ctx.tls12_prf.secret != NULL) {
4049 mbedtls_platform_zeroize(operation->ctx.tls12_prf.secret,
4050 operation->ctx.tls12_prf.secret_length);
4051 mbedtls_free(operation->ctx.tls12_prf.secret);
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004052 }
4053
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004054 if (operation->ctx.tls12_prf.seed != NULL) {
4055 mbedtls_platform_zeroize(operation->ctx.tls12_prf.seed,
4056 operation->ctx.tls12_prf.seed_length);
4057 mbedtls_free(operation->ctx.tls12_prf.seed);
Janos Follath6a1d2622019-06-11 10:37:28 +01004058 }
4059
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004060 if (operation->ctx.tls12_prf.label != NULL) {
4061 mbedtls_platform_zeroize(operation->ctx.tls12_prf.label,
4062 operation->ctx.tls12_prf.label_length);
4063 mbedtls_free(operation->ctx.tls12_prf.label);
Janos Follath6a1d2622019-06-11 10:37:28 +01004064 }
4065
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004066 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01004067
4068 /* We leave the fields Ai and output_block to be erased safely by the
4069 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004070 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004071#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4072 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004073 {
4074 status = PSA_ERROR_BAD_STATE;
4075 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004076 mbedtls_platform_zeroize(operation, sizeof(*operation));
4077 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004078}
4079
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004080psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004081 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02004082{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004083 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004084 /* This is a blank key derivation operation. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004085 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004086 }
4087
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004088 *capacity = operation->capacity;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004089 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004090}
4091
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004092psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
4093 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004094{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004095 if (operation->alg == 0) {
4096 return PSA_ERROR_BAD_STATE;
4097 }
4098 if (capacity > operation->capacity) {
4099 return PSA_ERROR_INVALID_ARGUMENT;
4100 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004101 operation->capacity = capacity;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004102 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004103}
4104
John Durkopd0321952020-10-29 21:37:36 -07004105#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004106/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004107 * of the expand phase of the HKDF algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004108static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
4109 psa_algorithm_t hash_alg,
4110 uint8_t *output,
4111 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02004112{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004113 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremanb27e3502021-04-29 19:11:25 +02004114 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004115 psa_status_t status;
4116
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004117 if (hkdf->state < HKDF_STATE_KEYED || !hkdf->info_set) {
4118 return PSA_ERROR_BAD_STATE;
4119 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004120 hkdf->state = HKDF_STATE_OUTPUT;
4121
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004122 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02004123 /* Copy what remains of the current block */
4124 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004125 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02004126 n = (uint8_t) output_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004127 }
4128 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02004129 output += n;
4130 output_length -= n;
4131 hkdf->offset_in_block += n;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004132 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02004133 break;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004134 }
Gilles Peskined54931c2018-07-17 21:06:59 +02004135 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004136 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004137 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004138 * object was corrupted or if this function is called directly
4139 * inside the library. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004140 if (hkdf->block_number == 0xff) {
4141 return PSA_ERROR_BAD_STATE;
4142 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004143
4144 /* We need a new block */
4145 ++hkdf->block_number;
4146 hkdf->offset_in_block = 0;
Steven Cooremanb27e3502021-04-29 19:11:25 +02004147
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004148 status = psa_key_derivation_start_hmac(&hkdf->hmac,
4149 hash_alg,
4150 hkdf->prk,
4151 hash_length);
4152 if (status != PSA_SUCCESS) {
4153 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004154 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004155
4156 if (hkdf->block_number != 1) {
4157 status = psa_mac_update(&hkdf->hmac,
4158 hkdf->output_block,
4159 hash_length);
4160 if (status != PSA_SUCCESS) {
4161 return status;
4162 }
4163 }
4164 status = psa_mac_update(&hkdf->hmac,
4165 hkdf->info,
4166 hkdf->info_length);
4167 if (status != PSA_SUCCESS) {
4168 return status;
4169 }
4170 status = psa_mac_update(&hkdf->hmac,
4171 &hkdf->block_number, 1);
4172 if (status != PSA_SUCCESS) {
4173 return status;
4174 }
4175 status = psa_mac_sign_finish(&hkdf->hmac,
4176 hkdf->output_block,
4177 sizeof(hkdf->output_block),
4178 &hmac_output_length);
4179 if (status != PSA_SUCCESS) {
4180 return status;
4181 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004182 }
4183
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004184 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004185}
John Durkop07cc04a2020-11-16 22:08:34 -08004186#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004187
John Durkop07cc04a2020-11-16 22:08:34 -08004188#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4189 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01004190static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4191 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004192 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01004193{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004194 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
4195 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004196 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
4197 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01004198 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004199
Janos Follath7742fee2019-06-17 12:58:10 +01004200 /* We can't be wanting more output after block 0xff, otherwise
4201 * the capacity check in psa_key_derivation_output_bytes() would have
4202 * prevented this call. It could happen only if the operation
4203 * object was corrupted or if this function is called directly
4204 * inside the library. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004205 if (tls12_prf->block_number == 0xff) {
4206 return PSA_ERROR_CORRUPTION_DETECTED;
4207 }
Janos Follath7742fee2019-06-17 12:58:10 +01004208
4209 /* We need a new block */
4210 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004211 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004212
4213 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4214 *
4215 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4216 *
4217 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4218 * HMAC_hash(secret, A(2) + seed) +
4219 * HMAC_hash(secret, A(3) + seed) + ...
4220 *
4221 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004222 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004223 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004224 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004225 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004226 * is currently extracted as `output_block` and where i is
4227 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004228 */
4229
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004230 status = psa_key_derivation_start_hmac(&hmac,
4231 hash_alg,
4232 tls12_prf->secret,
4233 tls12_prf->secret_length);
4234 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004235 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004236 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004237
4238 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004239 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004240 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4241 * the variable seed and in this instance means it in the context of the
4242 * P_hash function, where seed = label + seed.) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004243 status = psa_mac_update(&hmac,
4244 tls12_prf->label,
4245 tls12_prf->label_length);
4246 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004247 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004248 }
4249 status = psa_mac_update(&hmac,
4250 tls12_prf->seed,
4251 tls12_prf->seed_length);
4252 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004253 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004254 }
4255 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01004256 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004257 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
4258 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004259 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004260 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004261 }
4262
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004263 status = psa_mac_sign_finish(&hmac,
4264 tls12_prf->Ai, hash_length,
4265 &hmac_output_length);
4266 if (hmac_output_length != hash_length) {
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004267 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004268 }
4269 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004270 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004271 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004272
4273 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004274 status = psa_key_derivation_start_hmac(&hmac,
4275 hash_alg,
4276 tls12_prf->secret,
4277 tls12_prf->secret_length);
4278 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004279 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004280 }
4281 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
4282 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004283 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004284 }
4285 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
4286 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004287 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004288 }
4289 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
4290 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004291 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004292 }
4293 status = psa_mac_sign_finish(&hmac,
4294 tls12_prf->output_block, hash_length,
4295 &hmac_output_length);
4296 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004297 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004298 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004299
Janos Follath7742fee2019-06-17 12:58:10 +01004300
4301cleanup:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004302 cleanup_status = psa_mac_abort(&hmac);
4303 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004304 status = cleanup_status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004305 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004306
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004307 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01004308}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004309
Janos Follath844eb0e2019-06-19 12:10:49 +01004310static psa_status_t psa_key_derivation_tls12_prf_read(
4311 psa_tls12_prf_key_derivation_t *tls12_prf,
4312 psa_algorithm_t alg,
4313 uint8_t *output,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004314 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01004315{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004316 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
4317 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01004318 psa_status_t status;
4319 uint8_t offset, length;
4320
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004321 switch (tls12_prf->state) {
Gilles Peskinef216f0d2021-06-11 22:41:46 +02004322 case PSA_TLS12_PRF_STATE_LABEL_SET:
4323 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4324 break;
4325 case PSA_TLS12_PRF_STATE_OUTPUT:
4326 break;
4327 default:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004328 return PSA_ERROR_BAD_STATE;
Gilles Peskinef216f0d2021-06-11 22:41:46 +02004329 }
4330
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004331 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01004332 /* Check if we have fully processed the current block. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004333 if (tls12_prf->left_in_block == 0) {
4334 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
4335 alg);
4336 if (status != PSA_SUCCESS) {
4337 return status;
4338 }
Janos Follath844eb0e2019-06-19 12:10:49 +01004339
4340 continue;
4341 }
4342
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004343 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01004344 length = (uint8_t) output_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004345 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01004346 length = tls12_prf->left_in_block;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004347 }
Janos Follath844eb0e2019-06-19 12:10:49 +01004348
4349 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004350 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01004351 output += length;
4352 output_length -= length;
4353 tls12_prf->left_in_block -= length;
4354 }
4355
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004356 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01004357}
John Durkop07cc04a2020-11-16 22:08:34 -08004358#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4359 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004360
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004361psa_status_t psa_key_derivation_output_bytes(
4362 psa_key_derivation_operation_t *operation,
4363 uint8_t *output,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004364 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02004365{
4366 psa_status_t status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004367 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02004368
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004369 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004370 /* This is a blank operation. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004371 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004372 }
4373
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004374 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004375 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004376 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004377 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004378 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004379 goto exit;
4380 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004381 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004382 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004383 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004384 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4385 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004386 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004387 * output_length > 0. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004388 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004389 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004390 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004391
John Durkopd0321952020-10-29 21:37:36 -07004392#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004393 if (PSA_ALG_IS_HKDF(kdf_alg)) {
4394 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
4395 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, hash_alg,
4396 output, output_length);
4397 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004398#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4399#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4400 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004401 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
4402 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
4403 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
4404 kdf_alg, output,
4405 output_length);
4406 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004407#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4408 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004409 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004410 (void) kdf_alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004411 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004412 }
4413
4414exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004415 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004416 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004417 * This allows us to differentiate between exhausted operations and
4418 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4419 * operations. */
4420 psa_algorithm_t alg = operation->alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004421 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004422 operation->alg = alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004423 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02004424 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004425 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004426}
4427
David Brown7807bf72021-02-09 16:28:23 -07004428#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004429static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02004430{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004431 if (data_size >= 8) {
4432 mbedtls_des_key_set_parity(data);
4433 }
4434 if (data_size >= 16) {
4435 mbedtls_des_key_set_parity(data + 8);
4436 }
4437 if (data_size >= 24) {
4438 mbedtls_des_key_set_parity(data + 16);
4439 }
Gilles Peskine08542d82018-07-19 17:05:42 +02004440}
David Brown7807bf72021-02-09 16:28:23 -07004441#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004442
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004443static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004444 psa_key_slot_t *slot,
4445 size_t bits,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004446 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02004447{
4448 uint8_t *data = NULL;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004449 size_t bytes = PSA_BITS_TO_BYTES(bits);
Gilles Peskineeab56e42018-07-12 17:12:33 +02004450 psa_status_t status;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01004451 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004452
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004453 if (!key_type_is_raw_bytes(slot->attr.type)) {
4454 return PSA_ERROR_INVALID_ARGUMENT;
4455 }
4456 if (bits % 8 != 0) {
4457 return PSA_ERROR_INVALID_ARGUMENT;
4458 }
4459 data = mbedtls_calloc(1, bytes);
4460 if (data == NULL) {
4461 return PSA_ERROR_INSUFFICIENT_MEMORY;
4462 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02004463
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004464 status = psa_key_derivation_output_bytes(operation, data, bytes);
4465 if (status != PSA_SUCCESS) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02004466 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004467 }
David Brown12ca5032021-02-11 11:02:00 -07004468#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004469 if (slot->attr.type == PSA_KEY_TYPE_DES) {
4470 psa_des_set_key_parity(data, bytes);
4471 }
David Brown8107e312021-02-12 08:08:46 -07004472#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004473
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004474 status = psa_allocate_buffer_to_slot(slot, bytes);
4475 if (status != PSA_SUCCESS) {
Paul Elliottda3e7db2021-02-09 18:58:20 +00004476 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004477 }
Ronald Crondd04d422020-11-28 15:14:42 +01004478
Ronald Cronbf33c932020-11-28 18:06:53 +01004479 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01004480 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004481 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004482 };
4483
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004484 status = psa_driver_wrapper_import_key(&attributes,
4485 data, bytes,
4486 slot->key.data,
4487 slot->key.bytes,
4488 &slot->key.bytes, &bits);
4489 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01004490 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004491 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02004492
4493exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004494 mbedtls_free(data);
4495 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004496}
4497
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004498psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
4499 psa_key_derivation_operation_t *operation,
4500 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004501{
4502 psa_status_t status;
4503 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004504 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004505
Ronald Cron81709fc2020-11-14 12:10:32 +01004506 *key = MBEDTLS_SVC_KEY_ID_INIT;
4507
Gilles Peskine0f84d622019-09-12 19:03:13 +02004508 /* Reject any attempt to create a zero-length key so that we don't
4509 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004510 if (psa_get_key_bits(attributes) == 0) {
4511 return PSA_ERROR_INVALID_ARGUMENT;
4512 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02004513
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004514 if (operation->alg == PSA_ALG_NONE) {
4515 return PSA_ERROR_BAD_STATE;
4516 }
Dave Rodgman021e7242021-11-16 10:32:48 +00004517
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004518 if (!operation->can_output_key) {
4519 return PSA_ERROR_NOT_PERMITTED;
4520 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004521
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004522 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
4523 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004524#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004525 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004526 /* Deriving a key in a secure element is not implemented yet. */
4527 status = PSA_ERROR_NOT_SUPPORTED;
4528 }
4529#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004530 if (status == PSA_SUCCESS) {
4531 status = psa_generate_derived_key_internal(slot,
4532 attributes->core.bits,
4533 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004534 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004535 if (status == PSA_SUCCESS) {
4536 status = psa_finish_key_creation(slot, driver, key);
4537 }
4538 if (status != PSA_SUCCESS) {
4539 psa_fail_key_creation(slot, driver);
4540 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004541
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004542 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004543}
4544
Gilles Peskineeab56e42018-07-12 17:12:33 +02004545
4546
4547/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004548/* Key derivation */
4549/****************************************************************/
4550
Steven Cooreman932ffb72021-02-15 12:14:32 +01004551#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004552static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskinecdacf042021-04-29 21:10:00 +02004553{
4554#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004555 if (PSA_ALG_IS_HKDF(kdf_alg)) {
4556 return 1;
4557 }
Gilles Peskinecdacf042021-04-29 21:10:00 +02004558#endif
4559#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004560 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
4561 return 1;
4562 }
Gilles Peskinecdacf042021-04-29 21:10:00 +02004563#endif
4564#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004565 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
4566 return 1;
4567 }
Gilles Peskinecdacf042021-04-29 21:10:00 +02004568#endif
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004569 return 0;
Gilles Peskinecdacf042021-04-29 21:10:00 +02004570}
4571
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004572static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004573{
4574 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004575 psa_status_t status = psa_hash_setup(&operation, alg);
4576 psa_hash_abort(&operation);
4577 return status;
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004578}
4579
Gilles Peskine969c5d62019-01-16 15:53:06 +01004580static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004581 psa_key_derivation_operation_t *operation,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004582 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004583{
Janos Follath5fe19732019-06-20 15:09:30 +01004584 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4585 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004586 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01004587
Gilles Peskine969c5d62019-01-16 15:53:06 +01004588 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004589 if (!is_kdf_alg_supported(kdf_alg)) {
4590 return PSA_ERROR_NOT_SUPPORTED;
4591 }
John Durkop07cc04a2020-11-16 22:08:34 -08004592
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004593 /* All currently supported key derivation algorithms are based on a
4594 * hash algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004595 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
4596 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
4597 if (hash_size == 0) {
4598 return PSA_ERROR_NOT_SUPPORTED;
4599 }
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004600
4601 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
4602 * we might fail later, which is somewhat unfriendly and potentially
4603 * risk-prone. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004604 psa_status_t status = psa_hash_try_support(hash_alg);
4605 if (status != PSA_SUCCESS) {
4606 return status;
4607 }
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004608
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004609 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
4610 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
4611 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
4612 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004613 }
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004614
Gilles Peskinecdacf042021-04-29 21:10:00 +02004615 operation->capacity = 255 * hash_size;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004616 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004617}
Gilles Peskine739c98c2021-04-29 21:34:33 +02004618
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004619static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine739c98c2021-04-29 21:34:33 +02004620{
4621#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004622 if (alg == PSA_ALG_ECDH) {
4623 return PSA_SUCCESS;
4624 }
Gilles Peskine739c98c2021-04-29 21:34:33 +02004625#endif
4626 (void) alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004627 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine739c98c2021-04-29 21:34:33 +02004628}
John Durkop07cc04a2020-11-16 22:08:34 -08004629#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004630
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004631psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
4632 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004633{
4634 psa_status_t status;
4635
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004636 if (operation->alg != 0) {
4637 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004638 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004639
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004640 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
4641 return PSA_ERROR_INVALID_ARGUMENT;
4642 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
4643#if defined(AT_LEAST_ONE_BUILTIN_KDF)
4644 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
4645 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
4646 status = psa_key_agreement_try_support(ka_alg);
4647 if (status != PSA_SUCCESS) {
4648 return status;
4649 }
4650 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
4651#else
4652 return PSA_ERROR_NOT_SUPPORTED;
4653#endif /* AT_LEAST_ONE_BUILTIN_KDF */
4654 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
4655#if defined(AT_LEAST_ONE_BUILTIN_KDF)
4656 status = psa_key_derivation_setup_kdf(operation, alg);
4657#else
4658 return PSA_ERROR_NOT_SUPPORTED;
4659#endif /* AT_LEAST_ONE_BUILTIN_KDF */
4660 } else {
4661 return PSA_ERROR_INVALID_ARGUMENT;
4662 }
4663
4664 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004665 operation->alg = alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004666 }
4667 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004668}
4669
John Durkopd0321952020-10-29 21:37:36 -07004670#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004671static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
4672 psa_algorithm_t hash_alg,
4673 psa_key_derivation_step_t step,
4674 const uint8_t *data,
4675 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004676{
4677 psa_status_t status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004678 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02004679 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004680 if (hkdf->state != HKDF_STATE_INIT) {
4681 return PSA_ERROR_BAD_STATE;
4682 } else {
4683 status = psa_key_derivation_start_hmac(&hkdf->hmac,
4684 hash_alg,
4685 data, data_length);
4686 if (status != PSA_SUCCESS) {
4687 return status;
4688 }
Steven Cooremanb27e3502021-04-29 19:11:25 +02004689 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004690 return PSA_SUCCESS;
Steven Cooremanb27e3502021-04-29 19:11:25 +02004691 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004692 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004693 /* If no salt was provided, use an empty salt. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004694 if (hkdf->state == HKDF_STATE_INIT) {
4695 status = psa_key_derivation_start_hmac(&hkdf->hmac,
4696 hash_alg,
4697 NULL, 0);
4698 if (status != PSA_SUCCESS) {
4699 return status;
4700 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004701 hkdf->state = HKDF_STATE_STARTED;
4702 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004703 if (hkdf->state != HKDF_STATE_STARTED) {
4704 return PSA_ERROR_BAD_STATE;
4705 }
4706 status = psa_mac_update(&hkdf->hmac,
4707 data, data_length);
4708 if (status != PSA_SUCCESS) {
4709 return status;
4710 }
4711 status = psa_mac_sign_finish(&hkdf->hmac,
4712 hkdf->prk,
4713 sizeof(hkdf->prk),
4714 &data_length);
4715 if (status != PSA_SUCCESS) {
4716 return status;
4717 }
4718 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Gilles Peskine2b522db2019-04-12 15:11:49 +02004719 hkdf->block_number = 0;
4720 hkdf->state = HKDF_STATE_KEYED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004721 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02004722 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004723 if (hkdf->state == HKDF_STATE_OUTPUT) {
4724 return PSA_ERROR_BAD_STATE;
4725 }
4726 if (hkdf->info_set) {
4727 return PSA_ERROR_BAD_STATE;
4728 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004729 hkdf->info_length = data_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004730 if (data_length != 0) {
4731 hkdf->info = mbedtls_calloc(1, data_length);
4732 if (hkdf->info == NULL) {
4733 return PSA_ERROR_INSUFFICIENT_MEMORY;
4734 }
4735 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004736 }
4737 hkdf->info_set = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004738 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004739 default:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004740 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004741 }
4742}
John Durkop07cc04a2020-11-16 22:08:34 -08004743#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004744
John Durkop07cc04a2020-11-16 22:08:34 -08004745#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4746 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004747static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
4748 const uint8_t *data,
4749 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01004750{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004751 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
4752 return PSA_ERROR_BAD_STATE;
4753 }
Janos Follathf08e2652019-06-13 09:05:41 +01004754
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004755 if (data_length != 0) {
4756 prf->seed = mbedtls_calloc(1, data_length);
4757 if (prf->seed == NULL) {
4758 return PSA_ERROR_INSUFFICIENT_MEMORY;
4759 }
Janos Follathf08e2652019-06-13 09:05:41 +01004760
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004761 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01004762 prf->seed_length = data_length;
4763 }
Janos Follathf08e2652019-06-13 09:05:41 +01004764
Gilles Peskine43f958b2020-12-13 14:55:14 +01004765 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004766
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004767 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01004768}
4769
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004770static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
4771 const uint8_t *data,
4772 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01004773{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004774 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
4775 return PSA_ERROR_BAD_STATE;
4776 }
Janos Follath81550542019-06-13 14:26:34 +01004777
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004778 if (data_length != 0) {
4779 prf->secret = mbedtls_calloc(1, data_length);
4780 if (prf->secret == NULL) {
4781 return PSA_ERROR_INSUFFICIENT_MEMORY;
4782 }
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004783
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004784 memcpy(prf->secret, data, data_length);
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004785 prf->secret_length = data_length;
4786 }
Janos Follath81550542019-06-13 14:26:34 +01004787
Gilles Peskine43f958b2020-12-13 14:55:14 +01004788 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004789
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004790 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01004791}
4792
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004793static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
4794 const uint8_t *data,
4795 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01004796{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004797 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
4798 return PSA_ERROR_BAD_STATE;
4799 }
Janos Follath63028dd2019-06-13 09:15:47 +01004800
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004801 if (data_length != 0) {
4802 prf->label = mbedtls_calloc(1, data_length);
4803 if (prf->label == NULL) {
4804 return PSA_ERROR_INSUFFICIENT_MEMORY;
4805 }
Janos Follath63028dd2019-06-13 09:15:47 +01004806
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004807 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01004808 prf->label_length = data_length;
4809 }
Janos Follath63028dd2019-06-13 09:15:47 +01004810
Gilles Peskine43f958b2020-12-13 14:55:14 +01004811 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004812
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004813 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01004814}
4815
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004816static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
4817 psa_key_derivation_step_t step,
4818 const uint8_t *data,
4819 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01004820{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004821 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01004822 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004823 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01004824 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004825 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01004826 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004827 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01004828 default:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004829 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01004830 }
4831}
John Durkop07cc04a2020-11-16 22:08:34 -08004832#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4833 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4834
4835#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4836static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4837 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004838 const uint8_t *data,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004839 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08004840{
4841 psa_status_t status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004842 uint8_t pms[4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE];
John Durkop07cc04a2020-11-16 22:08:34 -08004843 uint8_t *cur = pms;
4844
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004845 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
4846 return PSA_ERROR_INVALID_ARGUMENT;
4847 }
John Durkop07cc04a2020-11-16 22:08:34 -08004848
4849 /* Quoting RFC 4279, Section 2:
4850 *
4851 * The premaster secret is formed as follows: if the PSK is N octets
4852 * long, concatenate a uint16 with the value N, N zero octets, a second
4853 * uint16 with the value N, and the PSK itself.
4854 */
4855
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004856 *cur++ = MBEDTLS_BYTE_1(data_length);
4857 *cur++ = MBEDTLS_BYTE_0(data_length);
4858 memset(cur, 0, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08004859 cur += data_length;
4860 *cur++ = pms[0];
4861 *cur++ = pms[1];
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004862 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08004863 cur += data_length;
4864
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004865 status = psa_tls12_prf_set_key(prf, pms, cur - pms);
John Durkop07cc04a2020-11-16 22:08:34 -08004866
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004867 mbedtls_platform_zeroize(pms, sizeof(pms));
4868 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08004869}
Janos Follath6660f0e2019-06-17 08:44:03 +01004870
4871static psa_status_t psa_tls12_prf_psk_to_ms_input(
4872 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004873 psa_key_derivation_step_t step,
4874 const uint8_t *data,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004875 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01004876{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004877 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
4878 return psa_tls12_prf_psk_to_ms_set_key(prf,
4879 data, data_length);
Janos Follath0c1ed842019-06-28 13:35:36 +01004880 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004881
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004882 return psa_tls12_prf_input(prf, step, data, data_length);
Janos Follath6660f0e2019-06-17 08:44:03 +01004883}
John Durkop07cc04a2020-11-16 22:08:34 -08004884#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004885
Gilles Peskineb8965192019-09-24 16:21:10 +02004886/** Check whether the given key type is acceptable for the given
4887 * input step of a key derivation.
4888 *
4889 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4890 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4891 * Both secret and non-secret inputs can alternatively have the type
4892 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4893 * that the input was passed as a buffer rather than via a key object.
4894 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004895static int psa_key_derivation_check_input_type(
4896 psa_key_derivation_step_t step,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004897 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02004898{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004899 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02004900 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004901 if (key_type == PSA_KEY_TYPE_DERIVE) {
4902 return PSA_SUCCESS;
4903 }
4904 if (key_type == PSA_KEY_TYPE_NONE) {
4905 return PSA_SUCCESS;
4906 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02004907 break;
4908 case PSA_KEY_DERIVATION_INPUT_LABEL:
4909 case PSA_KEY_DERIVATION_INPUT_SALT:
4910 case PSA_KEY_DERIVATION_INPUT_INFO:
4911 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004912 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
4913 return PSA_SUCCESS;
4914 }
4915 if (key_type == PSA_KEY_TYPE_NONE) {
4916 return PSA_SUCCESS;
4917 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02004918 break;
4919 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004920 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02004921}
4922
Janos Follathb80a94e2019-06-12 15:54:46 +01004923static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004924 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004925 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004926 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004927 const uint8_t *data,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004928 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004929{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004930 psa_status_t status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004931 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004932
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004933 status = psa_key_derivation_check_input_type(step, key_type);
4934 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02004935 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004936 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02004937
John Durkopd0321952020-10-29 21:37:36 -07004938#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004939 if (PSA_ALG_IS_HKDF(kdf_alg)) {
4940 status = psa_hkdf_input(&operation->ctx.hkdf,
4941 PSA_ALG_HKDF_GET_HASH(kdf_alg),
4942 step, data, data_length);
4943 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004944#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4945#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004946 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
4947 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
4948 step, data, data_length);
4949 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004950#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4951#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004952 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
4953 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
4954 step, data, data_length);
4955 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004956#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004957 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004958 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004959 (void) data;
4960 (void) data_length;
4961 (void) kdf_alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004962 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004963 }
4964
Gilles Peskine224b0d62019-09-23 18:13:17 +02004965exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004966 if (status != PSA_SUCCESS) {
4967 psa_key_derivation_abort(operation);
4968 }
4969 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004970}
4971
Janos Follath51f4a0f2019-06-14 11:35:55 +01004972psa_status_t psa_key_derivation_input_bytes(
4973 psa_key_derivation_operation_t *operation,
4974 psa_key_derivation_step_t step,
4975 const uint8_t *data,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004976 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004977{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004978 return psa_key_derivation_input_internal(operation, step,
4979 PSA_KEY_TYPE_NONE,
4980 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004981}
4982
Janos Follath51f4a0f2019-06-14 11:35:55 +01004983psa_status_t psa_key_derivation_input_key(
4984 psa_key_derivation_operation_t *operation,
4985 psa_key_derivation_step_t step,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004986 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004987{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004988 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004989 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004990 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004991
Ronald Cron5c522922020-11-14 16:35:34 +01004992 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004993 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
4994 if (status != PSA_SUCCESS) {
4995 psa_key_derivation_abort(operation);
4996 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02004997 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004998
4999 /* Passing a key object as a SECRET input unlocks the permission
5000 * to output to a key object. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005001 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005002 operation->can_output_key = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005003 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005004
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005005 status = psa_key_derivation_input_internal(operation,
5006 step, slot->attr.type,
5007 slot->key.data,
5008 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02005009
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005010 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02005011
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005012 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005013}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005014
5015
5016
5017/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005018/* Key agreement */
5019/****************************************************************/
5020
John Durkop6ba40d12020-11-10 08:50:04 -08005021#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005022static psa_status_t psa_key_agreement_ecdh(const uint8_t *peer_key,
5023 size_t peer_key_length,
5024 const mbedtls_ecp_keypair *our_key,
5025 uint8_t *shared_secret,
5026 size_t shared_secret_size,
5027 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005028{
Steven Cooremand4867872020-08-05 16:31:39 +02005029 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005030 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005031 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005032 size_t bits = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005033 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa(our_key->grp.id, &bits);
5034 mbedtls_ecdh_init(&ecdh);
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005035
Ronald Cron90857082020-11-25 14:58:33 +01005036 status = mbedtls_psa_ecp_load_representation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005037 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5038 bits,
5039 peer_key,
5040 peer_key_length,
5041 &their_key);
5042 if (status != PSA_SUCCESS) {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005043 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005044 }
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005045
Jaeden Amero97271b32019-01-10 19:38:51 +00005046 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005047 mbedtls_ecdh_get_params(&ecdh, their_key, MBEDTLS_ECDH_THEIRS));
5048 if (status != PSA_SUCCESS) {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005049 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005050 }
Jaeden Amero97271b32019-01-10 19:38:51 +00005051 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005052 mbedtls_ecdh_get_params(&ecdh, our_key, MBEDTLS_ECDH_OURS));
5053 if (status != PSA_SUCCESS) {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005054 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005055 }
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005056
Jaeden Amero97271b32019-01-10 19:38:51 +00005057 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005058 mbedtls_ecdh_calc_secret(&ecdh,
5059 shared_secret_length,
5060 shared_secret, shared_secret_size,
5061 mbedtls_psa_get_random,
5062 MBEDTLS_PSA_RANDOM_STATE));
5063 if (status != PSA_SUCCESS) {
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005064 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005065 }
5066 if (PSA_BITS_TO_BYTES(bits) != *shared_secret_length) {
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005067 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005068 }
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005069
5070exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005071 if (status != PSA_SUCCESS) {
5072 mbedtls_platform_zeroize(shared_secret, shared_secret_size);
5073 }
5074 mbedtls_ecdh_free(&ecdh);
5075 mbedtls_ecp_keypair_free(their_key);
5076 mbedtls_free(their_key);
Steven Cooremana2371e52020-07-28 14:30:39 +02005077
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005078 return status;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005079}
John Durkop6ba40d12020-11-10 08:50:04 -08005080#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005081
Gilles Peskine01d718c2018-09-18 12:01:02 +02005082#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5083
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005084static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
5085 psa_key_slot_t *private_key,
5086 const uint8_t *peer_key,
5087 size_t peer_key_length,
5088 uint8_t *shared_secret,
5089 size_t shared_secret_size,
5090 size_t *shared_secret_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02005091{
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01005092 mbedtls_ecp_keypair *ecp = NULL;
5093 psa_status_t status;
Agathiyan Bragadeeshe7eb8052023-07-31 16:16:38 +01005094
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005095 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08005096#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005097 case PSA_ALG_ECDH:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005098 if (!PSA_KEY_TYPE_IS_ECC_KEY_PAIR(private_key->attr.type)) {
5099 return PSA_ERROR_INVALID_ARGUMENT;
5100 }
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01005101 status = mbedtls_psa_ecp_load_representation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005102 private_key->attr.type,
5103 private_key->attr.bits,
5104 private_key->key.data,
5105 private_key->key.bytes,
5106 &ecp);
5107 if (status != PSA_SUCCESS) {
5108 return status;
5109 }
5110 status = psa_key_agreement_ecdh(peer_key, peer_key_length,
5111 ecp,
5112 shared_secret, shared_secret_size,
5113 shared_secret_length);
5114 mbedtls_ecp_keypair_free(ecp);
5115 mbedtls_free(ecp);
5116 return status;
John Durkop6ba40d12020-11-10 08:50:04 -08005117#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005118 default:
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01005119 (void) ecp;
5120 (void) status;
Gilles Peskine93f85002018-11-16 16:43:31 +01005121 (void) private_key;
5122 (void) peer_key;
5123 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005124 (void) shared_secret;
5125 (void) shared_secret_size;
5126 (void) shared_secret_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005127 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005128 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005129}
5130
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005131/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005132 * to potentially free embedded data structures and wipe confidential data.
5133 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005134static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
5135 psa_key_derivation_step_t step,
5136 psa_key_slot_t *private_key,
5137 const uint8_t *peer_key,
5138 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02005139{
5140 psa_status_t status;
5141 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5142 size_t shared_secret_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005143 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02005144
5145 /* Step 1: run the secret agreement algorithm to generate the shared
5146 * secret. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005147 status = psa_key_agreement_raw_internal(ka_alg,
5148 private_key,
5149 peer_key, peer_key_length,
5150 shared_secret,
5151 sizeof(shared_secret),
5152 &shared_secret_length);
5153 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02005154 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005155 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02005156
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005157 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005158 * the shared secret. A shared secret is permitted wherever a key
5159 * of type DERIVE is permitted. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005160 status = psa_key_derivation_input_internal(operation, step,
5161 PSA_KEY_TYPE_DERIVE,
5162 shared_secret,
5163 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02005164exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005165 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
5166 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02005167}
5168
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005169psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
5170 psa_key_derivation_step_t step,
5171 mbedtls_svc_key_id_t private_key,
5172 const uint8_t *peer_key,
5173 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02005174{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005175 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005176 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005177 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005178
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005179 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5180 return PSA_ERROR_INVALID_ARGUMENT;
5181 }
Ronald Cron5c522922020-11-14 16:35:34 +01005182 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005183 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
5184 if (status != PSA_SUCCESS) {
5185 return status;
5186 }
5187 status = psa_key_agreement_internal(operation, step,
5188 slot,
5189 peer_key, peer_key_length);
5190 if (status != PSA_SUCCESS) {
5191 psa_key_derivation_abort(operation);
5192 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005193 /* If a private key has been added as SECRET, we allow the derived
5194 * key material to be used as a key in PSA Crypto. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005195 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005196 operation->can_output_key = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005197 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005198 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005199
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005200 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02005201
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005202 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005203}
5204
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005205psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
5206 mbedtls_svc_key_id_t private_key,
5207 const uint8_t *peer_key,
5208 size_t peer_key_length,
5209 uint8_t *output,
5210 size_t output_size,
5211 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005212{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005213 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005214 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005215 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01005216 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005217
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005218 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02005219 status = PSA_ERROR_INVALID_ARGUMENT;
5220 goto exit;
5221 }
Ronald Cron5c522922020-11-14 16:35:34 +01005222 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005223 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
5224 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02005225 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005226 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005227
Gilles Peskine42313fb2022-04-14 00:17:15 +02005228 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
5229 * for the output size. The PSA specification only guarantees that this
5230 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
5231 * but it might be nice to allow smaller buffers if the output fits.
5232 * At the time of writing this comment, with only ECDH implemented,
5233 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
5234 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
5235 * be exact for it as well. */
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01005236 expected_length =
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005237 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
5238 if (output_size < expected_length) {
Gilles Peskine42313fb2022-04-14 00:17:15 +02005239 status = PSA_ERROR_BUFFER_TOO_SMALL;
5240 goto exit;
5241 }
5242
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005243 status = psa_key_agreement_raw_internal(alg, slot,
5244 peer_key, peer_key_length,
5245 output, output_size,
5246 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02005247
5248exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005249 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02005250 /* If an error happens and is not handled properly, the output
5251 * may be used as a key to protect sensitive data. Arrange for such
5252 * a key to be random, which is likely to result in decryption or
5253 * verification errors. This is better than filling the buffer with
5254 * some constant data such as zeros, which would result in the data
5255 * being protected with a reproducible, easily knowable key.
5256 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005257 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02005258 *output_length = output_size;
5259 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005260
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005261 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02005262
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005263 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005264}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005265
5266
Gilles Peskine30524eb2020-11-13 17:02:26 +01005267
Gilles Peskine86a440b2018-11-12 18:39:40 +01005268/****************************************************************/
5269/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005270/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005271
Gilles Peskine9a9d5ee2023-04-28 21:00:28 +02005272#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5273#include "mbedtls/entropy_poll.h"
5274#endif
5275
Gilles Peskine30524eb2020-11-13 17:02:26 +01005276/** Initialize the PSA random generator.
5277 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005278static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01005279{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005280#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005281 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005282#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5283
Gilles Peskine30524eb2020-11-13 17:02:26 +01005284 /* Set default configuration if
5285 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005286 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005287 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005288 }
5289 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005290 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005291 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01005292
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005293 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01005294#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5295 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5296 /* The PSA entropy injection feature depends on using NV seed as an entropy
5297 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005298 mbedtls_entropy_add_source(&rng->entropy,
5299 mbedtls_nv_seed_poll, NULL,
5300 MBEDTLS_ENTROPY_BLOCK_SIZE,
5301 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01005302#endif
5303
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005304 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005305#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005306}
5307
5308/** Deinitialize the PSA random generator.
5309 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005310static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01005311{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005312#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005313 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005314#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005315 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
5316 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005317#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005318}
5319
5320/** Seed the PSA random generator.
5321 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005322static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01005323{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005324#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5325 /* Do nothing: the external RNG seeds itself. */
5326 (void) rng;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005327 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005328#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005329 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005330 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
5331 drbg_seed, sizeof(drbg_seed) - 1);
5332 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005333#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005334}
5335
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005336psa_status_t psa_generate_random(uint8_t *output,
5337 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005338{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005339 GUARD_MODULE_INITIALIZED;
5340
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005341#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5342
5343 size_t output_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005344 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
5345 output, output_size,
5346 &output_length);
5347 if (status != PSA_SUCCESS) {
5348 return status;
5349 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005350 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove49f99bc2022-12-04 16:44:21 +00005351 * for the external RNG interface. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005352 if (output_length != output_size) {
5353 return PSA_ERROR_INSUFFICIENT_ENTROPY;
5354 }
5355 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005356
5357#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5358
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005359 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005360 size_t request_size =
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005361 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5362 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5363 output_size);
5364 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
5365 output, request_size);
5366 if (ret != 0) {
5367 return mbedtls_to_psa_error(ret);
5368 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01005369 output_size -= request_size;
5370 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005371 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005372 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005373#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005374}
5375
Gilles Peskine8814fc42020-12-14 15:33:44 +01005376/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005377 *
5378 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5379 * `psa_generate_random(...)`. The state parameter is ignored since the
5380 * PSA API doesn't support passing an explicit state.
5381 *
5382 * In the non-external case, psa_generate_random() calls an
5383 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5384 * and semantics as mbedtls_psa_get_random(). As an optimization,
5385 * instead of doing this back-and-forth between the PSA API and the
5386 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5387 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005388 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005389#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5390int mbedtls_psa_get_random(void *p_rng,
5391 unsigned char *output,
5392 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01005393{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005394 /* This function takes a pointer to the RNG state because that's what
5395 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5396 * its own state internally and doesn't let the caller access that state.
5397 * So we just ignore the state parameter, and in practice we'll pass
5398 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005399 (void) p_rng;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005400 psa_status_t status = psa_generate_random(output, output_size);
5401 if (status == PSA_SUCCESS) {
5402 return 0;
5403 } else {
5404 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
5405 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01005406}
5407#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5408
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005409#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005410psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
5411 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005412{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005413 if (global_data.initialized) {
5414 return PSA_ERROR_NOT_PERMITTED;
5415 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005416
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005417 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
5418 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
5419 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
5420 return PSA_ERROR_INVALID_ARGUMENT;
5421 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005422
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005423 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005424}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005425#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005426
Ronald Cron3772afe2021-02-08 16:10:05 +01005427/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005428 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005429 * \param type The key type
5430 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005431 *
5432 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005433 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005434 * \retval #PSA_ERROR_INVALID_ARGUMENT
5435 * The size in bits of the key is not valid.
5436 * \retval #PSA_ERROR_NOT_SUPPORTED
5437 * The type and/or the size in bits of the key or the combination of
5438 * the two is not supported.
5439 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005440static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005441 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005442{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005443 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005444
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005445 if (key_type_is_raw_bytes(type)) {
5446 status = validate_unstructured_key_bit_size(type, bits);
5447 if (status != PSA_SUCCESS) {
5448 return status;
5449 }
5450 } else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005451#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005452 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
5453 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
5454 return PSA_ERROR_NOT_SUPPORTED;
5455 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005456
Ronald Cron01b2aba2020-10-05 09:42:02 +02005457 /* Accept only byte-aligned keys, for the same reasons as
5458 * in psa_import_rsa_key(). */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005459 if (bits % 8 != 0) {
5460 return PSA_ERROR_NOT_SUPPORTED;
5461 }
5462 } else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005463#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005464
Ronald Cron5c4d3862020-12-07 11:07:24 +01005465#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005466 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01005467 /* To avoid empty block, return successfully here. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005468 return PSA_SUCCESS;
5469 } else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005470#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005471 {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005472 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005473 }
5474
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005475 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005476}
5477
Ronald Cron55ed0592020-10-05 10:30:40 +02005478psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005479 const psa_key_attributes_t *attributes,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005480 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005481{
5482 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005483 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005484
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005485 if ((attributes->domain_parameters == NULL) &&
5486 (attributes->domain_parameters_size != 0)) {
5487 return PSA_ERROR_INVALID_ARGUMENT;
5488 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02005489
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005490 if (key_type_is_raw_bytes(type)) {
5491 status = psa_generate_random(key_buffer, key_buffer_size);
5492 if (status != PSA_SUCCESS) {
5493 return status;
5494 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005495
David Brown12ca5032021-02-11 11:02:00 -07005496#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005497 if (type == PSA_KEY_TYPE_DES) {
5498 psa_des_set_key_parity(key_buffer, key_buffer_size);
5499 }
David Brown8107e312021-02-12 08:08:46 -07005500#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005501 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01005502
Jaeden Ameroc17f2932021-05-14 08:34:32 +01005503#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5504 defined(MBEDTLS_GENPRIME)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005505 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
5506 return mbedtls_psa_rsa_generate_key(attributes,
5507 key_buffer,
5508 key_buffer_size,
5509 key_buffer_length);
5510 } else
Jaeden Ameroc17f2932021-05-14 08:34:32 +01005511#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5512 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005513
John Durkop9814fa22020-11-04 12:28:15 -08005514#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005515 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
5516 return mbedtls_psa_ecp_generate_key(attributes,
5517 key_buffer,
5518 key_buffer_size,
5519 key_buffer_length);
5520 } else
John Durkop9814fa22020-11-04 12:28:15 -08005521#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005522 {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005523 (void) key_buffer_length;
5524 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02005525 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005526
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005527 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005528}
Darryl Green0c6575a2018-11-07 16:05:30 +00005529
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005530psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
5531 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005532{
5533 psa_status_t status;
5534 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005535 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005536 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005537
Ronald Cron81709fc2020-11-14 12:10:32 +01005538 *key = MBEDTLS_SVC_KEY_ID_INIT;
5539
Gilles Peskine0f84d622019-09-12 19:03:13 +02005540 /* Reject any attempt to create a zero-length key so that we don't
5541 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005542 if (psa_get_key_bits(attributes) == 0) {
5543 return PSA_ERROR_INVALID_ARGUMENT;
5544 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02005545
Przemyslaw Stekiel5b20a7e2021-10-07 11:08:56 +02005546 /* Reject any attempt to create a public key. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005547 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
5548 return PSA_ERROR_INVALID_ARGUMENT;
5549 }
Przemyslaw Stekiel5b20a7e2021-10-07 11:08:56 +02005550
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005551 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
5552 &slot, &driver);
5553 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02005554 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005555 }
Gilles Peskine11792082019-08-06 18:36:36 +02005556
Ronald Cron977c2472020-10-13 08:32:21 +02005557 /* In the case of a transparent key or an opaque key stored in local
5558 * storage (thus not in the case of generating a key in a secure element
5559 * or cryptoprocessor with storage), we have to allocate a buffer to
5560 * hold the generated key material. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005561 if (slot->key.data == NULL) {
5562 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
5563 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01005564 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005565 attributes->core.type, attributes->core.bits);
5566 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01005567 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005568 }
Ronald Cron3772afe2021-02-08 16:10:05 +01005569
5570 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005571 attributes->core.type,
5572 attributes->core.bits);
5573 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02005574 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005575 attributes, &key_buffer_size);
5576 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01005577 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005578 }
Ronald Cron977c2472020-10-13 08:32:21 +02005579 }
Ronald Cron977c2472020-10-13 08:32:21 +02005580
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005581 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
5582 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02005583 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005584 }
Ronald Cron977c2472020-10-13 08:32:21 +02005585 }
5586
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005587 status = psa_driver_wrapper_generate_key(attributes,
5588 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02005589
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005590 if (status != PSA_SUCCESS) {
5591 psa_remove_key_data_from_memory(slot);
5592 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02005593
Gilles Peskine11792082019-08-06 18:36:36 +02005594exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005595 if (status == PSA_SUCCESS) {
5596 status = psa_finish_key_creation(slot, driver, key);
5597 }
5598 if (status != PSA_SUCCESS) {
5599 psa_fail_key_creation(slot, driver);
5600 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005601
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005602 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005603}
5604
Gilles Peskinee59236f2018-01-27 23:32:46 +01005605/****************************************************************/
5606/* Module setup */
5607/****************************************************************/
5608
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005609#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005610psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005611 void (* entropy_init)(mbedtls_entropy_context *ctx),
5612 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01005613{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005614 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
5615 return PSA_ERROR_BAD_STATE;
5616 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01005617 global_data.rng.entropy_init = entropy_init;
5618 global_data.rng.entropy_free = entropy_free;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005619 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01005620}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005621#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005622
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005623void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005624{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005625 psa_wipe_all_key_slots();
5626 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
5627 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01005628 }
5629 /* Wipe all remaining data, including configuration.
5630 * In particular, this sets all state indicator to the value
5631 * indicating "uninitialized". */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005632 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron088d5d02021-04-10 16:57:30 +02005633
5634 /* Terminate drivers */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005635 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01005636}
5637
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005638#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5639/** Recover a transaction that was interrupted by a power failure.
5640 *
5641 * This function is called during initialization, before psa_crypto_init()
5642 * returns. If this function returns a failure status, the initialization
5643 * fails.
5644 */
5645static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005646 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005647{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005648 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005649 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5650 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005651 /* TODO - fall through to the failure case until this
5652 * is implemented.
5653 * https://github.com/ARMmbed/mbed-crypto/issues/218
5654 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005655 default:
5656 /* We found an unsupported transaction in the storage.
5657 * We don't know what state the storage is in. Give up. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005658 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005659 }
5660}
5661#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5662
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005663psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005664{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005665 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005666
Gilles Peskinec6b69072018-11-20 21:42:52 +01005667 /* Double initialization is explicitly allowed. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005668 if (global_data.initialized != 0) {
5669 return PSA_SUCCESS;
5670 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005671
Gilles Peskine30524eb2020-11-13 17:02:26 +01005672 /* Initialize and seed the random generator. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005673 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01005674 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005675 status = mbedtls_psa_random_seed(&global_data.rng);
5676 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01005677 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005678 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01005679 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005680
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005681 status = psa_initialize_key_slots();
5682 if (status != PSA_SUCCESS) {
Gilles Peskine66fb1262018-12-10 16:29:04 +01005683 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005684 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01005685
Ronald Cron088d5d02021-04-10 16:57:30 +02005686 /* Init drivers */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005687 status = psa_driver_wrapper_init();
5688 if (status != PSA_SUCCESS) {
Gilles Peskined9348f22019-10-01 15:22:29 +02005689 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005690 }
Gilles Peskined9348f22019-10-01 15:22:29 +02005691
Gilles Peskine4b734222019-07-24 15:56:31 +02005692#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005693 status = psa_crypto_load_transaction();
5694 if (status == PSA_SUCCESS) {
5695 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
5696 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005697 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005698 }
5699 status = psa_crypto_stop_transaction();
5700 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02005701 /* There's no transaction to complete. It's all good. */
5702 status = PSA_SUCCESS;
5703 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005704#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005705
Gilles Peskinec6b69072018-11-20 21:42:52 +01005706 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005707 global_data.initialized = 1;
5708
5709exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005710 if (status != PSA_SUCCESS) {
5711 mbedtls_psa_crypto_free();
5712 }
5713 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005714}
5715
David Horstmann114d8242023-12-07 18:39:17 +00005716/* Memory copying test hooks. These are called before input copy, after input
5717 * copy, before output copy and after output copy, respectively.
5718 * They are used by memory-poisoning tests to temporarily unpoison buffers
5719 * while they are copied. */
David Horstmann63f82f72023-11-28 15:21:56 +00005720#if defined(MBEDTLS_TEST_HOOKS)
5721void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
5722void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
5723void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
5724void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
5725#endif
5726
David Horstmanndf493552023-11-15 15:18:30 +00005727/** Copy from an input buffer to a local copy.
5728 *
5729 * \param[in] input Pointer to input buffer.
5730 * \param[in] input_len Length of the input buffer.
5731 * \param[out] input_copy Pointer to a local copy in which to store the input data.
5732 * \param[out] input_copy_len Length of the local copy buffer.
5733 * \return #PSA_SUCCESS, if the buffer was successfully
5734 * copied.
5735 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
5736 * copy is too small to hold contents of the
5737 * input buffer.
5738 */
5739MBEDTLS_STATIC_TESTABLE
David Horstmann957f9802023-10-30 20:29:43 +00005740psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
5741 uint8_t *input_copy, size_t input_copy_len)
5742{
5743 if (input_len > input_copy_len) {
David Horstmann8684ad52023-11-03 19:51:40 +00005744 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmann957f9802023-10-30 20:29:43 +00005745 }
5746
David Horstmann0760b152023-11-24 16:21:04 +00005747#if defined(MBEDTLS_TEST_HOOKS)
David Horstmann63f82f72023-11-28 15:21:56 +00005748 if (psa_input_pre_copy_hook != NULL) {
5749 psa_input_pre_copy_hook(input, input_len);
5750 }
David Horstmann0760b152023-11-24 16:21:04 +00005751#endif
5752
David Horstmann660027f2023-11-15 17:33:47 +00005753 if (input_len > 0) {
5754 memcpy(input_copy, input, input_len);
5755 }
David Horstmann957f9802023-10-30 20:29:43 +00005756
David Horstmann0760b152023-11-24 16:21:04 +00005757#if defined(MBEDTLS_TEST_HOOKS)
David Horstmann63f82f72023-11-28 15:21:56 +00005758 if (psa_input_post_copy_hook != NULL) {
5759 psa_input_post_copy_hook(input, input_len);
5760 }
David Horstmann0760b152023-11-24 16:21:04 +00005761#endif
5762
David Horstmann957f9802023-10-30 20:29:43 +00005763 return PSA_SUCCESS;
5764}
5765
David Horstmanndf493552023-11-15 15:18:30 +00005766/** Copy from a local output buffer into a user-supplied one.
5767 *
5768 * \param[in] output_copy Pointer to a local buffer containing the output.
5769 * \param[in] output_copy_len Length of the local buffer.
5770 * \param[out] output Pointer to user-supplied output buffer.
5771 * \param[out] output_len Length of the user-supplied output buffer.
5772 * \return #PSA_SUCCESS, if the buffer was successfully
5773 * copied.
David Horstmann232ab252023-11-20 12:39:38 +00005774 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmanndf493552023-11-15 15:18:30 +00005775 * user-supplied output buffer is too small to
5776 * hold the contents of the local buffer.
5777 */
5778MBEDTLS_STATIC_TESTABLE
David Horstmann2bd296e2023-10-30 20:37:12 +00005779psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
5780 uint8_t *output, size_t output_len)
5781{
5782 if (output_len < output_copy_len) {
David Horstmann232ab252023-11-20 12:39:38 +00005783 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann2bd296e2023-10-30 20:37:12 +00005784 }
David Horstmann660027f2023-11-15 17:33:47 +00005785
David Horstmann0760b152023-11-24 16:21:04 +00005786#if defined(MBEDTLS_TEST_HOOKS)
David Horstmann63f82f72023-11-28 15:21:56 +00005787 if (psa_output_pre_copy_hook != NULL) {
5788 psa_output_pre_copy_hook(output, output_len);
5789 }
David Horstmann0760b152023-11-24 16:21:04 +00005790#endif
5791
David Horstmann660027f2023-11-15 17:33:47 +00005792 if (output_copy_len > 0) {
5793 memcpy(output, output_copy, output_copy_len);
5794 }
5795
David Horstmann0760b152023-11-24 16:21:04 +00005796#if defined(MBEDTLS_TEST_HOOKS)
David Horstmann63f82f72023-11-28 15:21:56 +00005797 if (psa_output_post_copy_hook != NULL) {
5798 psa_output_post_copy_hook(output, output_len);
5799 }
David Horstmann0760b152023-11-24 16:21:04 +00005800#endif
5801
David Horstmann2bd296e2023-10-30 20:37:12 +00005802 return PSA_SUCCESS;
5803}
5804
David Horstmann81a0d572023-11-20 17:15:32 +00005805psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
5806 psa_crypto_local_input_t *local_input)
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005807{
5808 psa_status_t status;
5809
David Horstmann0d52c712023-11-23 15:50:37 +00005810 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005811
David Horstmann726bf052023-11-15 18:11:26 +00005812 if (input_len == 0) {
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005813 return PSA_SUCCESS;
5814 }
5815
David Horstmann81a0d572023-11-20 17:15:32 +00005816 local_input->buffer = mbedtls_calloc(input_len, 1);
5817 if (local_input->buffer == NULL) {
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005818 /* Since we dealt with the zero-length case above, we know that
5819 * a NULL return value means a failure of allocation. */
5820 return PSA_ERROR_INSUFFICIENT_MEMORY;
5821 }
David Horstmann81a0d572023-11-20 17:15:32 +00005822 /* From now on, we must free local_input->buffer on error. */
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005823
David Horstmann81a0d572023-11-20 17:15:32 +00005824 local_input->length = input_len;
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005825
5826 status = psa_crypto_copy_input(input, input_len,
David Horstmann81a0d572023-11-20 17:15:32 +00005827 local_input->buffer, local_input->length);
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005828 if (status != PSA_SUCCESS) {
5829 goto error;
5830 }
5831
5832 return PSA_SUCCESS;
5833
5834error:
David Horstmann81a0d572023-11-20 17:15:32 +00005835 mbedtls_free(local_input->buffer);
5836 local_input->buffer = NULL;
5837 local_input->length = 0;
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005838 return status;
5839}
5840
David Horstmann81a0d572023-11-20 17:15:32 +00005841void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmannfa2d75d2023-11-07 18:00:41 +00005842{
David Horstmann81a0d572023-11-20 17:15:32 +00005843 mbedtls_free(local_input->buffer);
5844 local_input->buffer = NULL;
5845 local_input->length = 0;
David Horstmannfa2d75d2023-11-07 18:00:41 +00005846}
5847
David Horstmann1a76ab12023-11-20 12:54:09 +00005848psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
5849 psa_crypto_local_output_t *local_output)
David Horstmann953cd5b2023-11-08 15:19:43 +00005850{
David Horstmann0d52c712023-11-23 15:50:37 +00005851 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmann953cd5b2023-11-08 15:19:43 +00005852
David Horstmann726bf052023-11-15 18:11:26 +00005853 if (output_len == 0) {
David Horstmann953cd5b2023-11-08 15:19:43 +00005854 return PSA_SUCCESS;
5855 }
David Horstmann1a76ab12023-11-20 12:54:09 +00005856 local_output->buffer = mbedtls_calloc(output_len, 1);
5857 if (local_output->buffer == NULL) {
David Horstmann953cd5b2023-11-08 15:19:43 +00005858 /* Since we dealt with the zero-length case above, we know that
5859 * a NULL return value means a failure of allocation. */
5860 return PSA_ERROR_INSUFFICIENT_MEMORY;
5861 }
David Horstmann1a76ab12023-11-20 12:54:09 +00005862 local_output->length = output_len;
5863 local_output->original = output;
David Horstmann953cd5b2023-11-08 15:19:43 +00005864
5865 return PSA_SUCCESS;
5866}
5867
Gabor Mezei3b0c3712024-01-24 13:07:17 +01005868psa_status_t psa_crypto_local_output_alloc_with_copy(uint8_t *output, size_t output_len,
5869 psa_crypto_local_output_t *local_output)
5870{
5871 psa_status_t status;
5872 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
5873
5874 if (output_len == 0) {
5875 return PSA_SUCCESS;
5876 }
5877 local_output->buffer = mbedtls_calloc(output_len, 1);
5878 if (local_output->buffer == NULL) {
5879 /* Since we dealt with the zero-length case above, we know that
5880 * a NULL return value means a failure of allocation. */
5881 return PSA_ERROR_INSUFFICIENT_MEMORY;
5882 }
5883 local_output->length = output_len;
5884 local_output->original = output;
5885
5886 status = psa_crypto_copy_input(output, output_len,
5887 local_output->buffer, local_output->length);
5888 if (status != PSA_SUCCESS) {
5889 goto error;
5890 }
5891
5892 return PSA_SUCCESS;
5893
5894error:
5895 mbedtls_free(local_output->buffer);
5896 local_output->buffer = NULL;
5897 local_output->length = 0;
5898 return status;
5899}
5900
David Horstmann1a76ab12023-11-20 12:54:09 +00005901psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmannaeeb2742023-11-08 17:44:18 +00005902{
David Horstmann761761f2023-11-15 15:57:32 +00005903 psa_status_t status;
5904
David Horstmann1a76ab12023-11-20 12:54:09 +00005905 if (local_output->buffer == NULL) {
5906 local_output->length = 0;
David Horstmannaeeb2742023-11-08 17:44:18 +00005907 return PSA_SUCCESS;
5908 }
David Horstmann1a76ab12023-11-20 12:54:09 +00005909 if (local_output->original == NULL) {
David Horstmannaeeb2742023-11-08 17:44:18 +00005910 /* We have an internal copy but nothing to copy back to. */
5911 return PSA_ERROR_CORRUPTION_DETECTED;
5912 }
5913
David Horstmann1a76ab12023-11-20 12:54:09 +00005914 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
5915 local_output->original, local_output->length);
David Horstmann761761f2023-11-15 15:57:32 +00005916 if (status != PSA_SUCCESS) {
5917 return status;
5918 }
David Horstmannaeeb2742023-11-08 17:44:18 +00005919
David Horstmann1a76ab12023-11-20 12:54:09 +00005920 mbedtls_free(local_output->buffer);
5921 local_output->buffer = NULL;
5922 local_output->length = 0;
David Horstmannaeeb2742023-11-08 17:44:18 +00005923
5924 return PSA_SUCCESS;
5925}
5926
Gilles Peskinee59236f2018-01-27 23:32:46 +01005927#endif /* MBEDTLS_PSA_CRYPTO_C */