blob: 78737fd818a378be5870887f832e69a0d9727645 [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,
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002323 const uint8_t *input_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002324 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;
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002327 LOCAL_INPUT_DECLARE(input_external, input);
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002328
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002329 if (operation->id == 0) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002330 status = PSA_ERROR_BAD_STATE;
2331 goto exit;
2332 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002333
Steven Cooremanc8288352021-03-04 14:02:19 +01002334 /* Don't require hash implementations to behave correctly on a
2335 * zero-length input, which may have an invalid pointer. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002336 if (input_length == 0) {
2337 return PSA_SUCCESS;
2338 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002339
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002340 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002341 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002342
2343exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002344 if (status != PSA_SUCCESS) {
2345 psa_hash_abort(operation);
2346 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002347
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002348 LOCAL_INPUT_FREE(input_external, input);
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002349 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002350}
2351
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002352static psa_status_t psa_hash_finish_internal(psa_hash_operation_t *operation,
Thomas Daubneycbf09212024-01-25 17:14:29 +00002353 uint8_t *hash,
2354 size_t hash_size,
2355 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002356{
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002357 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2358
Steven Cooremanfbe09282021-03-08 18:41:12 +01002359 *hash_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002360 if (operation->id == 0) {
2361 return PSA_ERROR_BAD_STATE;
2362 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002363
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002364 status = psa_driver_wrapper_hash_finish(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002365 operation, hash, hash_size, hash_length);
2366 psa_hash_abort(operation);
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002367
2368 return status;
2369}
2370
2371psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2372 uint8_t *hash_external,
2373 size_t hash_size,
2374 size_t *hash_length)
2375{
2376 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2377 LOCAL_OUTPUT_DECLARE(hash_external, hash);
2378
2379 LOCAL_OUTPUT_ALLOC(hash_external, hash_size, hash);
2380 status = psa_hash_finish_internal(operation, hash, hash_size, hash_length);
2381
Thomas Daubney5e6b84a2024-01-25 17:10:42 +00002382#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002383exit:
Thomas Daubney5e6b84a2024-01-25 17:10:42 +00002384#endif
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002385 LOCAL_OUTPUT_FREE(hash_external, hash);
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002386 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002387}
2388
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002389psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002390 const uint8_t *hash_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002391 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002392{
Ronald Cron3a95d2b2021-10-18 09:47:58 +02002393 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002394 size_t actual_hash_length;
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002395 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2396 LOCAL_INPUT_DECLARE(hash_external, hash);
2397
2398 status = psa_hash_finish_internal(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002399 operation,
2400 actual_hash, sizeof(actual_hash),
2401 &actual_hash_length);
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002402
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002403 if (status != PSA_SUCCESS) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002404 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002405 }
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002406
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002407 if (actual_hash_length != hash_length) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002408 status = PSA_ERROR_INVALID_SIGNATURE;
2409 goto exit;
2410 }
2411
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002412 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002413 if (mbedtls_psa_safer_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002414 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002415 }
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002416
2417exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002418 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2419 if (status != PSA_SUCCESS) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002420 psa_hash_abort(operation);
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002421 }
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002422 LOCAL_INPUT_FREE(hash_external, hash);
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002423 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002424}
2425
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002426psa_status_t psa_hash_compute(psa_algorithm_t alg,
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002427 const uint8_t *input_external, size_t input_length,
2428 uint8_t *hash_external, size_t hash_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002429 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002430{
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002431 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2432 LOCAL_INPUT_DECLARE(input_external, input);
2433 LOCAL_OUTPUT_DECLARE(hash_external, hash);
2434
Steven Cooremanfbe09282021-03-08 18:41:12 +01002435 *hash_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002436 if (!PSA_ALG_IS_HASH(alg)) {
2437 return PSA_ERROR_INVALID_ARGUMENT;
2438 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002439
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002440 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2441 LOCAL_OUTPUT_ALLOC(hash_external, hash_size, hash);
2442 status = psa_driver_wrapper_hash_compute(alg, input, input_length,
Thomas Daubneycbf09212024-01-25 17:14:29 +00002443 hash, hash_size, hash_length);
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002444
Thomas Daubney5e6b84a2024-01-25 17:10:42 +00002445#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002446exit:
Thomas Daubney5e6b84a2024-01-25 17:10:42 +00002447#endif
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002448 LOCAL_INPUT_FREE(input_external, input);
2449 LOCAL_OUTPUT_FREE(hash_external, hash);
2450 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002451}
2452
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002453psa_status_t psa_hash_compare(psa_algorithm_t alg,
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002454 const uint8_t *input_external, size_t input_length,
2455 const uint8_t *hash_external, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002456{
Ronald Cron3a95d2b2021-10-18 09:47:58 +02002457 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002458 size_t actual_hash_length;
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002459 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2460
2461 LOCAL_INPUT_DECLARE(input_external, input);
2462 LOCAL_INPUT_DECLARE(hash_external, hash);
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002463
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002464 if (!PSA_ALG_IS_HASH(alg)) {
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002465 status = PSA_ERROR_INVALID_ARGUMENT;
2466 return status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002467 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002468
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002469 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2470 status = psa_driver_wrapper_hash_compute(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002471 alg, input, input_length,
2472 actual_hash, sizeof(actual_hash),
2473 &actual_hash_length);
2474 if (status != PSA_SUCCESS) {
Gilles Peskineb3f4e5b2021-12-13 12:33:18 +01002475 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002476 }
2477 if (actual_hash_length != hash_length) {
Gilles Peskineb3f4e5b2021-12-13 12:33:18 +01002478 status = PSA_ERROR_INVALID_SIGNATURE;
2479 goto exit;
2480 }
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002481
2482 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002483 if (mbedtls_psa_safer_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskineb3f4e5b2021-12-13 12:33:18 +01002484 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002485 }
Gilles Peskineb3f4e5b2021-12-13 12:33:18 +01002486
2487exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002488 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
Thomas Daubney62cb36a2024-01-12 16:50:26 +00002489
2490 LOCAL_INPUT_FREE(input_external, input);
2491 LOCAL_INPUT_FREE(hash_external, hash);
2492
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002493 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002494}
2495
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002496psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2497 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002498{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002499 if (source_operation->id == 0 ||
2500 target_operation->id != 0) {
2501 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002502 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002503
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002504 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2505 target_operation);
2506 if (status != PSA_SUCCESS) {
2507 psa_hash_abort(target_operation);
2508 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002509
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002510 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002511}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002512
2513
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002514/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002515/* MAC */
2516/****************************************************************/
2517
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002518psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002519{
Steven Cooreman07897832021-03-19 18:28:56 +01002520 /* Aborting a non-active operation is allowed */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002521 if (operation->id == 0) {
2522 return PSA_SUCCESS;
2523 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002524
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002525 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman15f0d922021-05-07 14:14:37 +02002526 operation->mac_size = 0;
2527 operation->is_sign = 0;
Steven Cooreman07897832021-03-19 18:28:56 +01002528 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002529
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002530 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002531}
2532
Ronald Cron1c650a12021-06-17 16:33:22 +02002533static psa_status_t psa_mac_finalize_alg_and_key_validation(
2534 psa_algorithm_t alg,
Ronald Crondef68e72021-06-17 16:46:44 +02002535 const psa_key_attributes_t *attributes,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002536 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002537{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002538 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002539 psa_key_type_t key_type = psa_get_key_type(attributes);
2540 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002541
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002542 if (!PSA_ALG_IS_MAC(alg)) {
2543 return PSA_ERROR_INVALID_ARGUMENT;
2544 }
Steven Cooreman07897832021-03-19 18:28:56 +01002545
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002546 /* Validate the combination of key type and algorithm */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002547 status = psa_mac_key_can_do(alg, key_type);
2548 if (status != PSA_SUCCESS) {
2549 return status;
2550 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002551
Steven Cooremana6474de2021-05-10 11:13:41 +02002552 /* Get the output length for the algorithm and key combination */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002553 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002554
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002555 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002556 /* A very short MAC is too short for security since it can be
2557 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2558 * so we make this our minimum, even though 32 bits is still
2559 * too small for security. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002560 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002561 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002562
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002563 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2564 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002565 /* It's impossible to "truncate" to a larger length than the full length
2566 * of the algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002567 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002568 }
2569
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002570 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinebc795822022-03-16 13:54:49 +01002571 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2572 * that is disabled in the compile-time configuration. The result can
2573 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2574 * configuration into account. In this case, force a return of
2575 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2576 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2577 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2578 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2579 * systematically generated tests. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002580 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinebc795822022-03-16 13:54:49 +01002581 }
2582
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002583 return PSA_SUCCESS;
Ronald Cron1c650a12021-06-17 16:33:22 +02002584}
2585
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002586static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2587 mbedtls_svc_key_id_t key,
2588 psa_algorithm_t alg,
2589 int is_sign)
Ronald Cron1c650a12021-06-17 16:33:22 +02002590{
2591 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2592 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002593 psa_key_attributes_t attributes;
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002594 psa_key_slot_t *slot = NULL;
Ronald Cron1c650a12021-06-17 16:33:22 +02002595
2596 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002597 if (operation->id != 0) {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002598 status = PSA_ERROR_BAD_STATE;
2599 goto exit;
2600 }
Ronald Cron1c650a12021-06-17 16:33:22 +02002601
2602 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002603 key,
2604 &slot,
2605 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2606 alg);
2607 if (status != PSA_SUCCESS) {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002608 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002609 }
Ronald Cron1c650a12021-06-17 16:33:22 +02002610
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002611 attributes = (psa_key_attributes_t) {
Ronald Cron1c650a12021-06-17 16:33:22 +02002612 .core = slot->attr
2613 };
2614
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002615 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2616 &operation->mac_size);
2617 if (status != PSA_SUCCESS) {
Ronald Cron1c650a12021-06-17 16:33:22 +02002618 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002619 }
Ronald Cron1c650a12021-06-17 16:33:22 +02002620
2621 operation->is_sign = is_sign;
Steven Cooreman07897832021-03-19 18:28:56 +01002622 /* Dispatch the MAC setup call with validated input */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002623 if (is_sign) {
2624 status = psa_driver_wrapper_mac_sign_setup(operation,
2625 &attributes,
2626 slot->key.data,
2627 slot->key.bytes,
2628 alg);
2629 } else {
2630 status = psa_driver_wrapper_mac_verify_setup(operation,
2631 &attributes,
2632 slot->key.data,
2633 slot->key.bytes,
2634 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002635 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002636
Gilles Peskinefbfac682018-07-08 20:51:54 +02002637exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002638 if (status != PSA_SUCCESS) {
2639 psa_mac_abort(operation);
2640 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002641
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002642 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002643
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002644 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002645}
2646
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002647psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2648 mbedtls_svc_key_id_t key,
2649 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002650{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002651 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002652}
2653
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002654psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2655 mbedtls_svc_key_id_t key,
2656 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002657{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002658 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002659}
2660
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002661psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2662 const uint8_t *input,
2663 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002664{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002665 if (operation->id == 0) {
2666 return PSA_ERROR_BAD_STATE;
2667 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002668
Steven Cooreman11743f92021-03-19 18:38:46 +01002669 /* Don't require hash implementations to behave correctly on a
2670 * zero-length input, which may have an invalid pointer. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002671 if (input_length == 0) {
2672 return PSA_SUCCESS;
2673 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002674
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002675 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2676 input, input_length);
2677 if (status != PSA_SUCCESS) {
2678 psa_mac_abort(operation);
2679 }
Steven Cooreman11743f92021-03-19 18:38:46 +01002680
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002681 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002682}
2683
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002684psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2685 uint8_t *mac,
2686 size_t mac_size,
2687 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002688{
Steven Cooreman87885df2021-03-19 19:04:39 +01002689 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2690 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002691
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002692 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002693 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002694 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002695 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002696
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002697 if (!operation->is_sign) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002698 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002699 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002700 }
Steven Cooreman15f0d922021-05-07 14:14:37 +02002701
Steven Cooremanf8ad2122021-05-11 11:09:13 +02002702 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2703 * once all the error checks are done. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002704 if (operation->mac_size == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002705 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002706 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002707 }
Steven Cooremanf8ad2122021-05-11 11:09:13 +02002708
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002709 if (mac_size < operation->mac_size) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002710 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman478ab542021-06-25 09:09:02 +01002711 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002712 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002713
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002714 status = psa_driver_wrapper_mac_sign_finish(operation,
2715 mac, operation->mac_size,
2716 mac_length);
Steven Cooreman15f0d922021-05-07 14:14:37 +02002717
Dave Rodgman478ab542021-06-25 09:09:02 +01002718exit:
Ronald Cron882eb782021-06-18 13:05:48 +02002719 /* In case of success, set the potential excess room in the output buffer
2720 * to an invalid value, to avoid potentially leaking a longer MAC.
2721 * In case of error, set the output length and content to a safe default,
2722 * such that in case the caller misses an error check, the output would be
2723 * an unachievable MAC.
2724 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002725 if (status != PSA_SUCCESS) {
Steven Cooreman15f0d922021-05-07 14:14:37 +02002726 *mac_length = mac_size;
Ronald Cron882eb782021-06-18 13:05:48 +02002727 operation->mac_size = 0;
Steven Cooreman15f0d922021-05-07 14:14:37 +02002728 }
mohammad16036df908f2018-04-02 08:34:15 -07002729
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002730 if (mac_size > operation->mac_size) {
2731 memset(&mac[operation->mac_size], '!',
2732 mac_size - operation->mac_size);
2733 }
Ronald Cron882eb782021-06-18 13:05:48 +02002734
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002735 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002736
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002737 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002738}
2739
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002740psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2741 const uint8_t *mac,
2742 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002743{
Steven Cooreman87885df2021-03-19 19:04:39 +01002744 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2745 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002746
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002747 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002748 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002749 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002750 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002751
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002752 if (operation->is_sign) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002753 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002754 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002755 }
Steven Cooreman15f0d922021-05-07 14:14:37 +02002756
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002757 if (operation->mac_size != mac_length) {
Steven Cooreman15f0d922021-05-07 14:14:37 +02002758 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002759 goto exit;
Steven Cooreman15f0d922021-05-07 14:14:37 +02002760 }
2761
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002762 status = psa_driver_wrapper_mac_verify_finish(operation,
2763 mac, mac_length);
Steven Cooreman15f0d922021-05-07 14:14:37 +02002764
Dave Rodgman478ab542021-06-25 09:09:02 +01002765exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002766 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002767
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002768 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002769}
2770
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002771static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2772 psa_algorithm_t alg,
2773 const uint8_t *input,
2774 size_t input_length,
2775 uint8_t *mac,
2776 size_t mac_size,
2777 size_t *mac_length,
2778 int is_sign)
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002779{
2780 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crondbb86462021-06-17 17:17:20 +02002781 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002782 psa_key_attributes_t attributes;
Ronald Crondbb86462021-06-17 17:17:20 +02002783 psa_key_slot_t *slot;
2784 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002785
Ronald Crondbb86462021-06-17 17:17:20 +02002786 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002787 key,
2788 &slot,
2789 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2790 alg);
2791 if (status != PSA_SUCCESS) {
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002792 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002793 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002794
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002795 attributes = (psa_key_attributes_t) {
Ronald Crondbb86462021-06-17 17:17:20 +02002796 .core = slot->attr
2797 };
2798
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002799 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2800 &operation_mac_size);
2801 if (status != PSA_SUCCESS) {
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002802 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002803 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002804
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002805 if (mac_size < operation_mac_size) {
Ronald Crondbb86462021-06-17 17:17:20 +02002806 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002807 goto exit;
Ronald Crondbb86462021-06-17 17:17:20 +02002808 }
2809
2810 status = psa_driver_wrapper_mac_compute(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002811 &attributes,
2812 slot->key.data, slot->key.bytes,
2813 alg,
2814 input, input_length,
2815 mac, operation_mac_size, mac_length);
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002816
2817exit:
Ronald Cron882eb782021-06-18 13:05:48 +02002818 /* In case of success, set the potential excess room in the output buffer
2819 * to an invalid value, to avoid potentially leaking a longer MAC.
2820 * In case of error, set the output length and content to a safe default,
2821 * such that in case the caller misses an error check, the output would be
2822 * an unachievable MAC.
2823 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002824 if (status != PSA_SUCCESS) {
Ronald Crondbb86462021-06-17 17:17:20 +02002825 *mac_length = mac_size;
Ronald Cron882eb782021-06-18 13:05:48 +02002826 operation_mac_size = 0;
Ronald Crondbb86462021-06-17 17:17:20 +02002827 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002828 if (mac_size > operation_mac_size) {
2829 memset(&mac[operation_mac_size], '!', mac_size - operation_mac_size);
2830 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002831
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002832 unlock_status = psa_unlock_key_slot(slot);
Ronald Crondbb86462021-06-17 17:17:20 +02002833
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002834 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002835}
2836
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002837psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002838 psa_algorithm_t alg,
2839 const uint8_t *input,
2840 size_t input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002841 uint8_t *mac,
2842 size_t mac_size,
2843 size_t *mac_length)
2844{
2845 return psa_mac_compute_internal(key, alg,
2846 input, input_length,
2847 mac, mac_size, mac_length, 1);
2848}
2849
2850psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2851 psa_algorithm_t alg,
2852 const uint8_t *input,
2853 size_t input_length,
2854 const uint8_t *mac,
2855 size_t mac_length)
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002856{
2857 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron4ed83682021-06-18 14:51:29 +02002858 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2859 size_t actual_mac_length;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002860
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002861 status = psa_mac_compute_internal(key, alg,
2862 input, input_length,
2863 actual_mac, sizeof(actual_mac),
2864 &actual_mac_length, 0);
2865 if (status != PSA_SUCCESS) {
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002866 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002867 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002868
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002869 if (mac_length != actual_mac_length) {
Ronald Cron4ed83682021-06-18 14:51:29 +02002870 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002871 goto exit;
Ronald Cron4ed83682021-06-18 14:51:29 +02002872 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002873 if (mbedtls_psa_safer_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Cron4ed83682021-06-18 14:51:29 +02002874 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002875 goto exit;
Ronald Cron4ed83682021-06-18 14:51:29 +02002876 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002877
2878exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002879 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002880
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002881 return status;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002882}
Gilles Peskine20035e32018-02-03 22:44:14 +01002883
Gilles Peskine20035e32018-02-03 22:44:14 +01002884/****************************************************************/
2885/* Asymmetric cryptography */
2886/****************************************************************/
2887
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002888static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2889 psa_algorithm_t alg)
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002890{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002891 if (input_is_message) {
2892 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2893 return PSA_ERROR_INVALID_ARGUMENT;
2894 }
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002895
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002896 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2897 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2898 return PSA_ERROR_INVALID_ARGUMENT;
2899 }
2900 }
2901 } else {
2902 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2903 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm56980482021-05-05 13:56:27 +02002904 }
2905 }
gabor-mezei-arm56980482021-05-05 13:56:27 +02002906
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002907 return PSA_SUCCESS;
gabor-mezei-arm56980482021-05-05 13:56:27 +02002908}
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002909
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002910static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2911 int input_is_message,
2912 psa_algorithm_t alg,
2913 const uint8_t *input,
2914 size_t input_length,
2915 uint8_t *signature,
2916 size_t signature_size,
2917 size_t *signature_length)
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002918{
2919 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2920 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002921 psa_key_attributes_t attributes;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002922 psa_key_slot_t *slot;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002923
2924 *signature_length = 0;
2925
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002926 status = psa_sign_verify_check_alg(input_is_message, alg);
2927 if (status != PSA_SUCCESS) {
gabor-mezei-arm56980482021-05-05 13:56:27 +02002928 return status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002929 }
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002930
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002931 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12ff4d52021-05-05 13:54:55 +02002932 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002933 * buffer can in principle be empty since it doesn't actually have
2934 * to be a hash.) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002935 if (signature_size == 0) {
2936 return PSA_ERROR_BUFFER_TOO_SMALL;
2937 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002938
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002939 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002940 key, &slot,
2941 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2942 PSA_KEY_USAGE_SIGN_HASH,
2943 alg);
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002944
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002945 if (status != PSA_SUCCESS) {
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002946 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002947 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002948
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002949 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002950 status = PSA_ERROR_INVALID_ARGUMENT;
2951 goto exit;
2952 }
2953
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002954 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002955 .core = slot->attr
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002956 };
2957
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002958 if (input_is_message) {
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002959 status = psa_driver_wrapper_sign_message(
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002960 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002961 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002962 signature, signature_size, signature_length);
2963 } else {
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002964
2965 status = psa_driver_wrapper_sign_hash(
2966 &attributes, slot->key.data, slot->key.bytes,
2967 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002968 signature, signature_size, signature_length);
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002969 }
2970
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002971
2972exit:
2973 /* Fill the unused part of the output buffer (the whole buffer on error,
2974 * the trailing part on success) with something that isn't a valid signature
2975 * (barring an attack on the signature and deliberately-crafted input),
2976 * in case the caller doesn't check the return status properly. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002977 if (status == PSA_SUCCESS) {
2978 memset(signature + *signature_length, '!',
2979 signature_size - *signature_length);
2980 } else {
2981 memset(signature, '!', signature_size);
2982 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002983 /* If signature_size is 0 then we have nothing to do. We must not call
2984 * memset because signature may be NULL in this case. */
2985
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002986 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002987
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002988 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002989}
2990
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002991static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2992 int input_is_message,
2993 psa_algorithm_t alg,
2994 const uint8_t *input,
2995 size_t input_length,
2996 const uint8_t *signature,
2997 size_t signature_length)
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002998{
2999 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3000 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3001 psa_key_slot_t *slot;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02003002
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003003 status = psa_sign_verify_check_alg(input_is_message, alg);
3004 if (status != PSA_SUCCESS) {
gabor-mezei-arm56980482021-05-05 13:56:27 +02003005 return status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003006 }
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003007
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003008 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003009 key, &slot,
3010 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
3011 PSA_KEY_USAGE_VERIFY_HASH,
3012 alg);
gabor-mezei-arme8efa392021-04-14 21:14:28 +02003013
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003014 if (status != PSA_SUCCESS) {
3015 return status;
3016 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02003017
3018 psa_key_attributes_t attributes = {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003019 .core = slot->attr
gabor-mezei-arme8efa392021-04-14 21:14:28 +02003020 };
3021
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003022 if (input_is_message) {
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003023 status = psa_driver_wrapper_verify_message(
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003024 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003025 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003026 signature, signature_length);
3027 } else {
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003028 status = psa_driver_wrapper_verify_hash(
3029 &attributes, slot->key.data, slot->key.bytes,
3030 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003031 signature, signature_length);
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003032 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02003033
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003034 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arme8efa392021-04-14 21:14:28 +02003035
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003036 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003037
3038}
3039
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02003040psa_status_t psa_sign_message_builtin(
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003041 const psa_key_attributes_t *attributes,
3042 const uint8_t *key_buffer,
3043 size_t key_buffer_size,
3044 psa_algorithm_t alg,
3045 const uint8_t *input,
3046 size_t input_length,
3047 uint8_t *signature,
3048 size_t signature_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003049 size_t *signature_length)
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003050{
3051 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003052
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003053 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-arm9719a842021-05-03 16:26:20 +02003054 size_t hash_length;
3055 uint8_t hash[PSA_HASH_MAX_SIZE];
3056
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02003057 status = psa_driver_wrapper_hash_compute(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003058 PSA_ALG_SIGN_GET_HASH(alg),
3059 input, input_length,
3060 hash, sizeof(hash), &hash_length);
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003061
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003062 if (status != PSA_SUCCESS) {
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02003063 return status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003064 }
gabor-mezei-arm9719a842021-05-03 16:26:20 +02003065
3066 return psa_driver_wrapper_sign_hash(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003067 attributes, key_buffer, key_buffer_size,
3068 alg, hash, hash_length,
3069 signature, signature_size, signature_length);
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02003070 }
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003071
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003072 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003073}
3074
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003075psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3076 psa_algorithm_t alg,
Thomas Daubney290aac42024-01-18 17:23:02 +00003077 const uint8_t *input_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003078 size_t input_length,
Thomas Daubney290aac42024-01-18 17:23:02 +00003079 uint8_t *signature_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003080 size_t signature_size,
3081 size_t *signature_length)
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003082{
Thomas Daubney290aac42024-01-18 17:23:02 +00003083 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3084 LOCAL_INPUT_DECLARE(input_external, input);
3085 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3086
3087 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3088 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3089 status = psa_sign_internal(key, 1, alg, input, input_length, signature,
3090 signature_size, signature_length);
3091
Thomas Daubneyf446b892024-01-30 13:36:01 +00003092#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney290aac42024-01-18 17:23:02 +00003093exit:
Thomas Daubneyf446b892024-01-30 13:36:01 +00003094#endif
Thomas Daubney290aac42024-01-18 17:23:02 +00003095 LOCAL_INPUT_FREE(input_external, input);
3096 LOCAL_OUTPUT_FREE(signature_external, signature);
3097 return status;
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003098}
3099
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02003100psa_status_t psa_verify_message_builtin(
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003101 const psa_key_attributes_t *attributes,
3102 const uint8_t *key_buffer,
3103 size_t key_buffer_size,
3104 psa_algorithm_t alg,
3105 const uint8_t *input,
3106 size_t input_length,
3107 const uint8_t *signature,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003108 size_t signature_length)
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003109{
3110 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003111
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003112 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-arm9719a842021-05-03 16:26:20 +02003113 size_t hash_length;
3114 uint8_t hash[PSA_HASH_MAX_SIZE];
3115
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02003116 status = psa_driver_wrapper_hash_compute(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003117 PSA_ALG_SIGN_GET_HASH(alg),
3118 input, input_length,
3119 hash, sizeof(hash), &hash_length);
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003120
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003121 if (status != PSA_SUCCESS) {
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02003122 return status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003123 }
gabor-mezei-arm9719a842021-05-03 16:26:20 +02003124
3125 return psa_driver_wrapper_verify_hash(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003126 attributes, key_buffer, key_buffer_size,
3127 alg, hash, hash_length,
3128 signature, signature_length);
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02003129 }
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003130
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003131 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003132}
3133
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003134psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3135 psa_algorithm_t alg,
Thomas Daubney290aac42024-01-18 17:23:02 +00003136 const uint8_t *input_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003137 size_t input_length,
Thomas Daubney290aac42024-01-18 17:23:02 +00003138 const uint8_t *signature_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003139 size_t signature_length)
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003140{
Thomas Daubney290aac42024-01-18 17:23:02 +00003141 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3142 LOCAL_INPUT_DECLARE(input_external, input);
3143 LOCAL_INPUT_DECLARE(signature_external, signature);
3144
3145 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3146 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3147 status = psa_verify_internal(key, 1, alg, input, input_length, signature,
3148 signature_length);
3149
Thomas Daubneyf446b892024-01-30 13:36:01 +00003150#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney290aac42024-01-18 17:23:02 +00003151exit:
Thomas Daubneyf446b892024-01-30 13:36:01 +00003152#endif
Thomas Daubney290aac42024-01-18 17:23:02 +00003153 LOCAL_INPUT_FREE(input_external, input);
3154 LOCAL_INPUT_FREE(signature_external, signature);
3155
3156 return status;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02003157}
3158
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02003159psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003160 const psa_key_attributes_t *attributes,
3161 const uint8_t *key_buffer, size_t key_buffer_size,
3162 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003163 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskine20035e32018-02-03 22:44:14 +01003164{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003165 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3166 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3167 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003168#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003169 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3170 return mbedtls_psa_rsa_sign_hash(
3171 attributes,
3172 key_buffer, key_buffer_size,
3173 alg, hash, hash_length,
3174 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003175#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3176 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003177 } else {
3178 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003179 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003180 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3181 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003182#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003183 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3184 return mbedtls_psa_ecdsa_sign_hash(
3185 attributes,
3186 key_buffer, key_buffer_size,
3187 alg, hash, hash_length,
3188 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003189#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3190 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003191 } else {
3192 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003193 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003194 }
Ronald Cron4501c982021-03-19 20:09:32 +01003195
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003196 (void) key_buffer;
3197 (void) key_buffer_size;
3198 (void) hash;
3199 (void) hash_length;
3200 (void) signature;
3201 (void) signature_size;
3202 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003203
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003204 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003205}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003206
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003207psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3208 psa_algorithm_t alg,
Thomas Daubney290aac42024-01-18 17:23:02 +00003209 const uint8_t *hash_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003210 size_t hash_length,
Thomas Daubney290aac42024-01-18 17:23:02 +00003211 uint8_t *signature_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003212 size_t signature_size,
3213 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003214{
Thomas Daubney290aac42024-01-18 17:23:02 +00003215 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3216 LOCAL_INPUT_DECLARE(hash_external, hash);
3217 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3218
3219 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3220 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3221 status = psa_sign_internal(key, 0, alg, hash, hash_length, signature,
3222 signature_size, signature_length);
3223
Thomas Daubneyf446b892024-01-30 13:36:01 +00003224#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney290aac42024-01-18 17:23:02 +00003225exit:
Thomas Daubneyf446b892024-01-30 13:36:01 +00003226#endif
Thomas Daubney290aac42024-01-18 17:23:02 +00003227 LOCAL_INPUT_FREE(hash_external, hash);
3228 LOCAL_OUTPUT_FREE(signature_external, signature);
3229
3230 return status;
itayzafrir5c753392018-05-08 11:18:38 +03003231}
3232
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02003233psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003234 const psa_key_attributes_t *attributes,
3235 const uint8_t *key_buffer, size_t key_buffer_size,
3236 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003237 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003238{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003239 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3240 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3241 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003242#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003243 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3244 return mbedtls_psa_rsa_verify_hash(
3245 attributes,
3246 key_buffer, key_buffer_size,
3247 alg, hash, hash_length,
3248 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003249#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3250 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003251 } else {
3252 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003253 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003254 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3255 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003256#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003257 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3258 return mbedtls_psa_ecdsa_verify_hash(
3259 attributes,
3260 key_buffer, key_buffer_size,
3261 alg, hash, hash_length,
3262 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003263#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3264 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003265 } else {
3266 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003267 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003268 }
Ronald Cron4501c982021-03-19 20:09:32 +01003269
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003270 (void) key_buffer;
3271 (void) key_buffer_size;
3272 (void) hash;
3273 (void) hash_length;
3274 (void) signature;
3275 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003276
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003277 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003278}
3279
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003280psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3281 psa_algorithm_t alg,
Thomas Daubney290aac42024-01-18 17:23:02 +00003282 const uint8_t *hash_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003283 size_t hash_length,
Thomas Daubney290aac42024-01-18 17:23:02 +00003284 const uint8_t *signature_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003285 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003286{
Thomas Daubney290aac42024-01-18 17:23:02 +00003287 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3288 LOCAL_INPUT_DECLARE(hash_external, hash);
3289 LOCAL_INPUT_DECLARE(signature_external, signature);
3290
3291 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3292 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3293 status = psa_verify_internal(key, 0, alg, hash, hash_length, signature,
3294 signature_length);
3295
Thomas Daubneyf446b892024-01-30 13:36:01 +00003296#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney290aac42024-01-18 17:23:02 +00003297exit:
Thomas Daubneyf446b892024-01-30 13:36:01 +00003298#endif
Thomas Daubney290aac42024-01-18 17:23:02 +00003299 LOCAL_INPUT_FREE(hash_external, hash);
3300 LOCAL_INPUT_FREE(signature_external, signature);
3301
3302 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01003303}
3304
John Durkop0e005192020-10-31 22:06:54 -07003305#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003306static void psa_rsa_oaep_set_padding_mode(psa_algorithm_t alg,
3307 mbedtls_rsa_context *rsa)
Gilles Peskine072ac562018-06-30 00:21:29 +02003308{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003309 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH(alg);
3310 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa(hash_alg);
3311 mbedtls_md_type_t md_alg = mbedtls_md_get_type(md_info);
3312 mbedtls_rsa_set_padding(rsa, MBEDTLS_RSA_PKCS_V21, md_alg);
Gilles Peskine072ac562018-06-30 00:21:29 +02003313}
John Durkop0e005192020-10-31 22:06:54 -07003314#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003315
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003316psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3317 psa_algorithm_t alg,
3318 const uint8_t *input,
3319 size_t input_length,
3320 const uint8_t *salt,
3321 size_t salt_length,
3322 uint8_t *output,
3323 size_t output_size,
3324 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003325{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003326 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003327 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003328 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003329
Darryl Green5cc689a2018-07-24 15:34:10 +01003330 (void) input;
3331 (void) input_length;
3332 (void) salt;
3333 (void) output;
3334 (void) output_size;
3335
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003336 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003337
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003338 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3339 return PSA_ERROR_INVALID_ARGUMENT;
3340 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003341
Ronald Cron5c522922020-11-14 16:35:34 +01003342 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003343 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3344 if (status != PSA_SUCCESS) {
3345 return status;
3346 }
3347 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3348 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003349 status = PSA_ERROR_INVALID_ARGUMENT;
3350 goto exit;
3351 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003352
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003353 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Ronald Cron7207d572021-09-08 14:28:35 +02003354#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003355 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooremana2371e52020-07-28 14:30:39 +02003356 mbedtls_rsa_context *rsa = NULL;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003357 status = mbedtls_psa_rsa_load_representation(slot->attr.type,
3358 slot->key.data,
3359 slot->key.bytes,
3360 &rsa);
3361 if (status != PSA_SUCCESS) {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003362 goto rsa_exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003363 }
Steven Cooremana2371e52020-07-28 14:30:39 +02003364
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003365 if (output_size < mbedtls_rsa_get_len(rsa)) {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003366 status = PSA_ERROR_BUFFER_TOO_SMALL;
3367 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003368 }
Ronald Cron7207d572021-09-08 14:28:35 +02003369#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3370 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003371 if (alg == PSA_ALG_RSA_PKCS1V15_CRYPT) {
Ronald Cron7207d572021-09-08 14:28:35 +02003372#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003373 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003374 mbedtls_rsa_pkcs1_encrypt(rsa,
3375 mbedtls_psa_get_random,
3376 MBEDTLS_PSA_RANDOM_STATE,
3377 MBEDTLS_RSA_PUBLIC,
3378 input_length,
3379 input,
3380 output));
Ronald Cron7207d572021-09-08 14:28:35 +02003381#else
3382 status = PSA_ERROR_NOT_SUPPORTED;
3383#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003384 } else
3385 if (PSA_ALG_IS_RSA_OAEP(alg)) {
Ronald Cron7207d572021-09-08 14:28:35 +02003386#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003387 psa_rsa_oaep_set_padding_mode(alg, rsa);
Steven Cooreman4fed4552020-08-03 14:46:03 +02003388 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003389 mbedtls_rsa_rsaes_oaep_encrypt(rsa,
3390 mbedtls_psa_get_random,
3391 MBEDTLS_PSA_RANDOM_STATE,
3392 MBEDTLS_RSA_PUBLIC,
3393 salt, salt_length,
3394 input_length,
3395 input,
3396 output));
Ronald Cron7207d572021-09-08 14:28:35 +02003397#else
3398 status = PSA_ERROR_NOT_SUPPORTED;
3399#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003400 } else {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003401 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003402 }
Ronald Cron7207d572021-09-08 14:28:35 +02003403#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003404 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003405rsa_exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003406 if (status == PSA_SUCCESS) {
3407 *output_length = mbedtls_rsa_get_len(rsa);
3408 }
Steven Cooremana01795d2020-07-24 22:48:15 +02003409
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003410 mbedtls_rsa_free(rsa);
3411 mbedtls_free(rsa);
John Durkop9814fa22020-11-04 12:28:15 -08003412#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003413 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003414 } else {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003415 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003416 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003417
3418exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003419 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003420
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003421 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003422}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003423
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003424psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3425 psa_algorithm_t alg,
3426 const uint8_t *input,
3427 size_t input_length,
3428 const uint8_t *salt,
3429 size_t salt_length,
3430 uint8_t *output,
3431 size_t output_size,
3432 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003433{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003434 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003435 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003436 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003437
Darryl Green5cc689a2018-07-24 15:34:10 +01003438 (void) input;
3439 (void) input_length;
3440 (void) salt;
3441 (void) output;
3442 (void) output_size;
3443
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003444 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003445
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003446 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3447 return PSA_ERROR_INVALID_ARGUMENT;
3448 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003449
Ronald Cron5c522922020-11-14 16:35:34 +01003450 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003451 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3452 if (status != PSA_SUCCESS) {
3453 return status;
3454 }
3455 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003456 status = PSA_ERROR_INVALID_ARGUMENT;
3457 goto exit;
3458 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003459
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003460 if (slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
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 +02003463 mbedtls_rsa_context *rsa = NULL;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003464 status = mbedtls_psa_rsa_load_representation(slot->attr.type,
3465 slot->key.data,
3466 slot->key.bytes,
3467 &rsa);
3468 if (status != PSA_SUCCESS) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003469 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003470 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003471
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003472 if (input_length != mbedtls_rsa_get_len(rsa)) {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003473 status = PSA_ERROR_INVALID_ARGUMENT;
3474 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003475 }
Ronald Cron7207d572021-09-08 14:28:35 +02003476#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3477 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003478
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003479 if (alg == PSA_ALG_RSA_PKCS1V15_CRYPT) {
Ronald Cron7207d572021-09-08 14:28:35 +02003480#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003481 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003482 mbedtls_rsa_pkcs1_decrypt(rsa,
3483 mbedtls_psa_get_random,
3484 MBEDTLS_PSA_RANDOM_STATE,
3485 MBEDTLS_RSA_PRIVATE,
3486 output_length,
3487 input,
3488 output,
3489 output_size));
Ronald Cron7207d572021-09-08 14:28:35 +02003490#else
3491 status = PSA_ERROR_NOT_SUPPORTED;
3492#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003493 } else
3494 if (PSA_ALG_IS_RSA_OAEP(alg)) {
Ronald Cron7207d572021-09-08 14:28:35 +02003495#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003496 psa_rsa_oaep_set_padding_mode(alg, rsa);
Steven Cooreman4fed4552020-08-03 14:46:03 +02003497 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003498 mbedtls_rsa_rsaes_oaep_decrypt(rsa,
3499 mbedtls_psa_get_random,
3500 MBEDTLS_PSA_RANDOM_STATE,
3501 MBEDTLS_RSA_PRIVATE,
3502 salt, salt_length,
3503 output_length,
3504 input,
3505 output,
3506 output_size));
Ronald Cron7207d572021-09-08 14:28:35 +02003507#else
3508 status = PSA_ERROR_NOT_SUPPORTED;
3509#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003510 } else {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003511 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003512 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003513
Ronald Cron7207d572021-09-08 14:28:35 +02003514#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003515 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003516rsa_exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003517 mbedtls_rsa_free(rsa);
3518 mbedtls_free(rsa);
John Durkop6ba40d12020-11-10 08:50:04 -08003519#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3520 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003521 } else {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003522 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003523 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003524
3525exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003526 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003527
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003528 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003529}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003530
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003531
3532
mohammad1603503973b2018-03-12 15:59:30 +02003533/****************************************************************/
3534/* Symmetric cryptography */
3535/****************************************************************/
3536
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003537static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
3538 mbedtls_svc_key_id_t key,
3539 psa_algorithm_t alg,
3540 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02003541{
3542 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3543 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003544 psa_key_attributes_t attributes;
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003545 psa_key_slot_t *slot = NULL;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003546 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
3547 PSA_KEY_USAGE_ENCRYPT :
3548 PSA_KEY_USAGE_DECRYPT);
Ronald Cronab99ac22020-10-01 16:38:28 +02003549
3550 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003551 if (operation->id != 0) {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003552 status = PSA_ERROR_BAD_STATE;
3553 goto exit;
3554 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003555
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003556 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003557 status = PSA_ERROR_INVALID_ARGUMENT;
3558 goto exit;
3559 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003560
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003561 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
3562 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003563 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003564 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003565
Ronald Cron49fafa92021-03-10 08:34:23 +01003566 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003567 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003568 * so we only set it (in the driver wrapper) after resources have been
3569 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003570 operation->iv_set = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003571 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003572 operation->iv_required = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003573 } else if (slot->attr.type == PSA_KEY_TYPE_ARC4) {
Gilles Peskine4a83c102022-04-20 17:00:22 +02003574 operation->iv_required = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003575 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02003576 operation->iv_required = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003577 }
3578 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02003579
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003580 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003581 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01003582 };
3583
Ronald Cronab99ac22020-10-01 16:38:28 +02003584 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003585 if (cipher_operation == MBEDTLS_ENCRYPT) {
3586 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
3587 &attributes,
3588 slot->key.data,
3589 slot->key.bytes,
3590 alg);
3591 } else {
3592 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
3593 &attributes,
3594 slot->key.data,
3595 slot->key.bytes,
3596 alg);
3597 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003598
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003599exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003600 if (status != PSA_SUCCESS) {
3601 psa_cipher_abort(operation);
3602 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003603
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003604 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003605
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003606 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02003607}
3608
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003609psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
3610 mbedtls_svc_key_id_t key,
3611 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003612{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003613 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003614}
3615
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003616psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
3617 mbedtls_svc_key_id_t key,
3618 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003619{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003620 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003621}
3622
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003623psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
3624 uint8_t *iv,
3625 size_t iv_size,
3626 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02003627{
Ronald Cron6d051732020-10-01 14:10:20 +02003628 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc423acb2021-07-05 12:31:44 +02003629 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergey04eb7c02023-03-06 15:37:23 -07003630 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01003631
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003632 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003633 status = PSA_ERROR_BAD_STATE;
3634 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003635 }
3636
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003637 if (operation->iv_set || !operation->iv_required) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003638 status = PSA_ERROR_BAD_STATE;
3639 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003640 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003641
Ronald Cronc423acb2021-07-05 12:31:44 +02003642 default_iv_length = operation->default_iv_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003643 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01003644 status = PSA_ERROR_BUFFER_TOO_SMALL;
3645 goto exit;
3646 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003647
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003648 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc423acb2021-07-05 12:31:44 +02003649 status = PSA_ERROR_GENERIC_ERROR;
3650 goto exit;
3651 }
3652
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003653 status = psa_generate_random(local_iv, default_iv_length);
3654 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01003655 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003656 }
Ronald Cron5618a392021-03-26 09:52:26 +01003657
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003658 status = psa_driver_wrapper_cipher_set_iv(operation,
3659 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01003660
3661exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003662 if (status == PSA_SUCCESS) {
3663 memcpy(iv, local_iv, default_iv_length);
Ronald Cronc423acb2021-07-05 12:31:44 +02003664 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02003665 operation->iv_set = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003666 } else {
Ronald Cronc423acb2021-07-05 12:31:44 +02003667 *iv_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003668 psa_cipher_abort(operation);
Ronald Cronc423acb2021-07-05 12:31:44 +02003669 }
Ronald Cron6d051732020-10-01 14:10:20 +02003670
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003671 return status;
mohammad1603503973b2018-03-12 15:59:30 +02003672}
3673
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003674psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
3675 const uint8_t *iv,
3676 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02003677{
Ronald Cron6d051732020-10-01 14:10:20 +02003678 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003679
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003680 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003681 status = PSA_ERROR_BAD_STATE;
3682 goto exit;
3683 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003684
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003685 if (operation->iv_set || !operation->iv_required) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003686 status = PSA_ERROR_BAD_STATE;
3687 goto exit;
3688 }
Ronald Crona0d68172021-03-26 10:15:08 +01003689
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003690 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003691 status = PSA_ERROR_INVALID_ARGUMENT;
3692 goto exit;
3693 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003694
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003695 status = psa_driver_wrapper_cipher_set_iv(operation,
3696 iv,
3697 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02003698
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003699exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003700 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03003701 operation->iv_set = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003702 } else {
3703 psa_cipher_abort(operation);
3704 }
3705 return status;
mohammad1603503973b2018-03-12 15:59:30 +02003706}
3707
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003708psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
3709 const uint8_t *input,
3710 size_t input_length,
3711 uint8_t *output,
3712 size_t output_size,
3713 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02003714{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003715 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003716
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003717 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003718 status = PSA_ERROR_BAD_STATE;
3719 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003720 }
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003721
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003722 if (operation->iv_required && !operation->iv_set) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003723 status = PSA_ERROR_BAD_STATE;
3724 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003725 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003726
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003727 status = psa_driver_wrapper_cipher_update(operation,
3728 input,
3729 input_length,
3730 output,
3731 output_size,
3732 output_length);
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003733
3734exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003735 if (status != PSA_SUCCESS) {
3736 psa_cipher_abort(operation);
3737 }
Ronald Cron6d051732020-10-01 14:10:20 +02003738
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003739 return status;
mohammad1603503973b2018-03-12 15:59:30 +02003740}
3741
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003742psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
3743 uint8_t *output,
3744 size_t output_size,
3745 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02003746{
David Saadab4ecc272019-02-14 13:48:10 +02003747 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003748
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003749 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003750 status = PSA_ERROR_BAD_STATE;
3751 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003752 }
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003753
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003754 if (operation->iv_required && !operation->iv_set) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003755 status = PSA_ERROR_BAD_STATE;
3756 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003757 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003758
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003759 status = psa_driver_wrapper_cipher_finish(operation,
3760 output,
3761 output_size,
3762 output_length);
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003763
3764exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003765 if (status == PSA_SUCCESS) {
3766 return psa_cipher_abort(operation);
3767 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02003768 *output_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003769 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01003770
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003771 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003772 }
mohammad1603503973b2018-03-12 15:59:30 +02003773}
3774
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003775psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02003776{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003777 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02003778 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003779 * in use. It's ok to call abort on such an object, and there's
3780 * nothing to do. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003781 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02003782 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003783
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003784 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02003785
Ronald Cron49fafa92021-03-10 08:34:23 +01003786 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003787 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003788 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003789
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003790 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02003791}
3792
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003793psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
3794 psa_algorithm_t alg,
David Horstmann926193a2023-12-13 15:55:25 +00003795 const uint8_t *input_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003796 size_t input_length,
David Horstmann926193a2023-12-13 15:55:25 +00003797 uint8_t *output_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003798 size_t output_size,
3799 size_t *output_length)
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003800{
3801 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003802 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003803 psa_key_attributes_t attributes;
Ronald Cron16377072021-07-08 19:00:07 +02003804 psa_key_slot_t *slot = NULL;
Ronald Cron4c224fe2021-07-09 18:44:58 +02003805 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
3806 size_t default_iv_length = 0;
gabor-mezei-arm52ae8712021-06-25 15:21:11 +02003807
David Horstmannb80e35a2023-12-14 18:12:47 +00003808 LOCAL_INPUT_DECLARE(input_external, input);
3809 LOCAL_OUTPUT_DECLARE(output_external, output);
3810
David Horstmann926193a2023-12-13 15:55:25 +00003811 LOCAL_INPUT_ALLOC(input_external, input_length, input);
David Horstmann926193a2023-12-13 15:55:25 +00003812 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmannd2ad8862023-11-27 17:43:05 +00003813
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003814 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron16377072021-07-08 19:00:07 +02003815 status = PSA_ERROR_INVALID_ARGUMENT;
3816 goto exit;
3817 }
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003818
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003819 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3820 PSA_KEY_USAGE_ENCRYPT,
3821 alg);
3822 if (status != PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003823 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003824 }
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003825
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003826 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003827 .core = slot->attr
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003828 };
3829
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003830 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
3831 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron4c224fe2021-07-09 18:44:58 +02003832 status = PSA_ERROR_GENERIC_ERROR;
3833 goto exit;
3834 }
3835
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003836 if (default_iv_length > 0) {
3837 if (output_size < default_iv_length) {
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003838 status = PSA_ERROR_BUFFER_TOO_SMALL;
3839 goto exit;
3840 }
3841
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003842 status = psa_generate_random(local_iv, default_iv_length);
3843 if (status != PSA_SUCCESS) {
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003844 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003845 }
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003846 }
3847
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003848 status = psa_driver_wrapper_cipher_encrypt(
3849 &attributes, slot->key.data, slot->key.bytes,
Ronald Cron4c224fe2021-07-09 18:44:58 +02003850 alg, local_iv, default_iv_length, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003851 mbedtls_buffer_offset(output, default_iv_length),
3852 output_size - default_iv_length, output_length);
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003853
3854exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003855 unlock_status = psa_unlock_key_slot(slot);
3856 if (status == PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003857 status = unlock_status;
Ronald Cron4c224fe2021-07-09 18:44:58 +02003858 }
Ronald Cron16377072021-07-08 19:00:07 +02003859
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003860 if (status == PSA_SUCCESS) {
3861 if (default_iv_length > 0) {
3862 memcpy(output, local_iv, default_iv_length);
3863 }
3864 *output_length += default_iv_length;
3865 } else {
3866 *output_length = 0;
3867 }
3868
David Horstmannb80e35a2023-12-14 18:12:47 +00003869 LOCAL_INPUT_FREE(input_external, input);
3870 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannd2ad8862023-11-27 17:43:05 +00003871
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003872 return status;
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003873}
3874
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003875psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
3876 psa_algorithm_t alg,
3877 const uint8_t *input,
3878 size_t input_length,
3879 uint8_t *output,
3880 size_t output_size,
3881 size_t *output_length)
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003882{
3883 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003884 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003885 psa_key_attributes_t attributes;
Ronald Cron16377072021-07-08 19:00:07 +02003886 psa_key_slot_t *slot = NULL;
gabor-mezei-arm52ae8712021-06-25 15:21:11 +02003887
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003888 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron16377072021-07-08 19:00:07 +02003889 status = PSA_ERROR_INVALID_ARGUMENT;
3890 goto exit;
3891 }
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003892
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003893 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3894 PSA_KEY_USAGE_DECRYPT,
3895 alg);
3896 if (status != PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003897 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003898 }
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003899
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003900 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003901 .core = slot->attr
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003902 };
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003903
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003904 if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm3fd792d2021-06-25 15:25:38 +02003905 status = PSA_ERROR_INVALID_ARGUMENT;
3906 goto exit;
3907 }
3908
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003909 status = psa_driver_wrapper_cipher_decrypt(
3910 &attributes, slot->key.data, slot->key.bytes,
3911 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003912 output, output_size, output_length);
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003913
gabor-mezei-arm3fd792d2021-06-25 15:25:38 +02003914exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003915 unlock_status = psa_unlock_key_slot(slot);
3916 if (status == PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003917 status = unlock_status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003918 }
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003919
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003920 if (status != PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003921 *output_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003922 }
Ronald Cron16377072021-07-08 19:00:07 +02003923
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003924 return status;
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003925}
3926
3927
mohammad16035955c982018-04-26 00:53:03 +03003928/****************************************************************/
3929/* AEAD */
3930/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003931
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003932psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
3933 psa_algorithm_t alg,
3934 const uint8_t *nonce,
3935 size_t nonce_length,
3936 const uint8_t *additional_data,
3937 size_t additional_data_length,
3938 const uint8_t *plaintext,
3939 size_t plaintext_length,
3940 uint8_t *ciphertext,
3941 size_t ciphertext_size,
3942 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03003943{
Ronald Cron215633c2021-03-16 17:15:37 +01003944 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3945 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003946
mohammad1603f08a5502018-06-03 15:05:47 +03003947 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003948
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003949 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
3950 return PSA_ERROR_NOT_SUPPORTED;
3951 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01003952
Ronald Cron9a986162021-03-26 12:40:07 +01003953 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003954 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3955 if (status != PSA_SUCCESS) {
3956 return status;
3957 }
mohammad16035955c982018-04-26 00:53:03 +03003958
Ronald Cron215633c2021-03-16 17:15:37 +01003959 psa_key_attributes_t attributes = {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003960 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01003961 };
mohammad16035955c982018-04-26 00:53:03 +03003962
Ronald Cronde822812021-03-17 16:08:20 +01003963 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003964 &attributes, slot->key.data, slot->key.bytes,
3965 alg,
3966 nonce, nonce_length,
3967 additional_data, additional_data_length,
3968 plaintext, plaintext_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003969 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02003970
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003971 if (status != PSA_SUCCESS && ciphertext_size != 0) {
3972 memset(ciphertext, 0, ciphertext_size);
3973 }
Gilles Peskine2d277862018-06-18 15:41:12 +02003974
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003975 psa_unlock_key_slot(slot);
mohammad16035955c982018-04-26 00:53:03 +03003976
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003977 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02003978}
3979
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003980psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
3981 psa_algorithm_t alg,
3982 const uint8_t *nonce,
3983 size_t nonce_length,
3984 const uint8_t *additional_data,
3985 size_t additional_data_length,
3986 const uint8_t *ciphertext,
3987 size_t ciphertext_length,
3988 uint8_t *plaintext,
3989 size_t plaintext_size,
3990 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03003991{
Ronald Cron215633c2021-03-16 17:15:37 +01003992 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3993 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003994
Gilles Peskineee652a32018-06-01 19:23:52 +02003995 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003996
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003997 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
3998 return PSA_ERROR_NOT_SUPPORTED;
3999 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004000
Ronald Cron9a986162021-03-26 12:40:07 +01004001 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004002 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4003 if (status != PSA_SUCCESS) {
4004 return status;
4005 }
mohammad16035955c982018-04-26 00:53:03 +03004006
Ronald Cron215633c2021-03-16 17:15:37 +01004007 psa_key_attributes_t attributes = {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004008 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004009 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004010
Ronald Cronde822812021-03-17 16:08:20 +01004011 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004012 &attributes, slot->key.data, slot->key.bytes,
4013 alg,
4014 nonce, nonce_length,
4015 additional_data, additional_data_length,
4016 ciphertext, ciphertext_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004017 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004018
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004019 if (status != PSA_SUCCESS && plaintext_size != 0) {
4020 memset(plaintext, 0, plaintext_size);
4021 }
mohammad160360a64d02018-06-03 17:20:42 +03004022
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004023 psa_unlock_key_slot(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004024
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004025 return status;
mohammad16035955c982018-04-26 00:53:03 +03004026}
4027
Gilles Peskinee59236f2018-01-27 23:32:46 +01004028/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02004029/* Generators */
4030/****************************************************************/
4031
John Durkop07cc04a2020-11-16 22:08:34 -08004032#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4033 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4034 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4035#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman9878a162021-05-06 17:58:36 +02004036#endif /* At least one builtin KDF */
4037
4038#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
4039 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4040 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4041static psa_status_t psa_key_derivation_start_hmac(
4042 psa_mac_operation_t *operation,
4043 psa_algorithm_t hash_alg,
4044 const uint8_t *hmac_key,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004045 size_t hmac_key_length)
Steven Cooreman9878a162021-05-06 17:58:36 +02004046{
4047 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4048 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004049 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
4050 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
4051 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman9878a162021-05-06 17:58:36 +02004052
Steven Cooreman15f0d922021-05-07 14:14:37 +02004053 operation->is_sign = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004054 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman15f0d922021-05-07 14:14:37 +02004055
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004056 status = psa_driver_wrapper_mac_sign_setup(operation,
4057 &attributes,
4058 hmac_key, hmac_key_length,
4059 PSA_ALG_HMAC(hash_alg));
Steven Cooreman9878a162021-05-06 17:58:36 +02004060
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004061 psa_reset_key_attributes(&attributes);
4062 return status;
Steven Cooreman9878a162021-05-06 17:58:36 +02004063}
4064#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08004065
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004066#define HKDF_STATE_INIT 0 /* no input yet */
4067#define HKDF_STATE_STARTED 1 /* got salt */
4068#define HKDF_STATE_KEYED 2 /* got key */
4069#define HKDF_STATE_OUTPUT 3 /* output started */
4070
Gilles Peskinecbe66502019-05-16 16:59:18 +02004071static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004072 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004073{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004074 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
4075 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
4076 } else {
4077 return operation->alg;
4078 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004079}
4080
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004081psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02004082{
4083 psa_status_t status = PSA_SUCCESS;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004084 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
4085 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02004086 /* The object has (apparently) been initialized but it is not
4087 * in use. It's ok to call abort on such an object, and there's
4088 * nothing to do. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004089 } else
John Durkopd0321952020-10-29 21:37:36 -07004090#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004091 if (PSA_ALG_IS_HKDF(kdf_alg)) {
4092 mbedtls_free(operation->ctx.hkdf.info);
4093 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
4094 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004095#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4096#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4097 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004098 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
4099 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
4100 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
4101 if (operation->ctx.tls12_prf.secret != NULL) {
4102 mbedtls_platform_zeroize(operation->ctx.tls12_prf.secret,
4103 operation->ctx.tls12_prf.secret_length);
4104 mbedtls_free(operation->ctx.tls12_prf.secret);
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004105 }
4106
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004107 if (operation->ctx.tls12_prf.seed != NULL) {
4108 mbedtls_platform_zeroize(operation->ctx.tls12_prf.seed,
4109 operation->ctx.tls12_prf.seed_length);
4110 mbedtls_free(operation->ctx.tls12_prf.seed);
Janos Follath6a1d2622019-06-11 10:37:28 +01004111 }
4112
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004113 if (operation->ctx.tls12_prf.label != NULL) {
4114 mbedtls_platform_zeroize(operation->ctx.tls12_prf.label,
4115 operation->ctx.tls12_prf.label_length);
4116 mbedtls_free(operation->ctx.tls12_prf.label);
Janos Follath6a1d2622019-06-11 10:37:28 +01004117 }
4118
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004119 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01004120
4121 /* We leave the fields Ai and output_block to be erased safely by the
4122 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004123 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004124#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4125 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004126 {
4127 status = PSA_ERROR_BAD_STATE;
4128 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004129 mbedtls_platform_zeroize(operation, sizeof(*operation));
4130 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004131}
4132
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004133psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004134 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02004135{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004136 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004137 /* This is a blank key derivation operation. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004138 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004139 }
4140
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004141 *capacity = operation->capacity;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004142 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004143}
4144
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004145psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
4146 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004147{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004148 if (operation->alg == 0) {
4149 return PSA_ERROR_BAD_STATE;
4150 }
4151 if (capacity > operation->capacity) {
4152 return PSA_ERROR_INVALID_ARGUMENT;
4153 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004154 operation->capacity = capacity;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004155 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004156}
4157
John Durkopd0321952020-10-29 21:37:36 -07004158#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004159/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004160 * of the expand phase of the HKDF algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004161static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
4162 psa_algorithm_t hash_alg,
4163 uint8_t *output,
4164 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02004165{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004166 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremanb27e3502021-04-29 19:11:25 +02004167 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004168 psa_status_t status;
4169
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004170 if (hkdf->state < HKDF_STATE_KEYED || !hkdf->info_set) {
4171 return PSA_ERROR_BAD_STATE;
4172 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004173 hkdf->state = HKDF_STATE_OUTPUT;
4174
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004175 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02004176 /* Copy what remains of the current block */
4177 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004178 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02004179 n = (uint8_t) output_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004180 }
4181 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02004182 output += n;
4183 output_length -= n;
4184 hkdf->offset_in_block += n;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004185 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02004186 break;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004187 }
Gilles Peskined54931c2018-07-17 21:06:59 +02004188 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004189 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004190 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004191 * object was corrupted or if this function is called directly
4192 * inside the library. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004193 if (hkdf->block_number == 0xff) {
4194 return PSA_ERROR_BAD_STATE;
4195 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004196
4197 /* We need a new block */
4198 ++hkdf->block_number;
4199 hkdf->offset_in_block = 0;
Steven Cooremanb27e3502021-04-29 19:11:25 +02004200
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004201 status = psa_key_derivation_start_hmac(&hkdf->hmac,
4202 hash_alg,
4203 hkdf->prk,
4204 hash_length);
4205 if (status != PSA_SUCCESS) {
4206 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004207 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004208
4209 if (hkdf->block_number != 1) {
4210 status = psa_mac_update(&hkdf->hmac,
4211 hkdf->output_block,
4212 hash_length);
4213 if (status != PSA_SUCCESS) {
4214 return status;
4215 }
4216 }
4217 status = psa_mac_update(&hkdf->hmac,
4218 hkdf->info,
4219 hkdf->info_length);
4220 if (status != PSA_SUCCESS) {
4221 return status;
4222 }
4223 status = psa_mac_update(&hkdf->hmac,
4224 &hkdf->block_number, 1);
4225 if (status != PSA_SUCCESS) {
4226 return status;
4227 }
4228 status = psa_mac_sign_finish(&hkdf->hmac,
4229 hkdf->output_block,
4230 sizeof(hkdf->output_block),
4231 &hmac_output_length);
4232 if (status != PSA_SUCCESS) {
4233 return status;
4234 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004235 }
4236
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004237 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004238}
John Durkop07cc04a2020-11-16 22:08:34 -08004239#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004240
John Durkop07cc04a2020-11-16 22:08:34 -08004241#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4242 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01004243static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4244 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004245 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01004246{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004247 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
4248 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004249 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
4250 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01004251 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004252
Janos Follath7742fee2019-06-17 12:58:10 +01004253 /* We can't be wanting more output after block 0xff, otherwise
4254 * the capacity check in psa_key_derivation_output_bytes() would have
4255 * prevented this call. It could happen only if the operation
4256 * object was corrupted or if this function is called directly
4257 * inside the library. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004258 if (tls12_prf->block_number == 0xff) {
4259 return PSA_ERROR_CORRUPTION_DETECTED;
4260 }
Janos Follath7742fee2019-06-17 12:58:10 +01004261
4262 /* We need a new block */
4263 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004264 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004265
4266 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4267 *
4268 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4269 *
4270 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4271 * HMAC_hash(secret, A(2) + seed) +
4272 * HMAC_hash(secret, A(3) + seed) + ...
4273 *
4274 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004275 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004276 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004277 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004278 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004279 * is currently extracted as `output_block` and where i is
4280 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004281 */
4282
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004283 status = psa_key_derivation_start_hmac(&hmac,
4284 hash_alg,
4285 tls12_prf->secret,
4286 tls12_prf->secret_length);
4287 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004288 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004289 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004290
4291 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004292 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004293 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4294 * the variable seed and in this instance means it in the context of the
4295 * P_hash function, where seed = label + seed.) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004296 status = psa_mac_update(&hmac,
4297 tls12_prf->label,
4298 tls12_prf->label_length);
4299 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004300 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004301 }
4302 status = psa_mac_update(&hmac,
4303 tls12_prf->seed,
4304 tls12_prf->seed_length);
4305 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004306 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004307 }
4308 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01004309 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004310 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
4311 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004312 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004313 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004314 }
4315
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004316 status = psa_mac_sign_finish(&hmac,
4317 tls12_prf->Ai, hash_length,
4318 &hmac_output_length);
4319 if (hmac_output_length != hash_length) {
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004320 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004321 }
4322 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004323 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004324 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004325
4326 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004327 status = psa_key_derivation_start_hmac(&hmac,
4328 hash_alg,
4329 tls12_prf->secret,
4330 tls12_prf->secret_length);
4331 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004332 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004333 }
4334 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
4335 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004336 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004337 }
4338 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
4339 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004340 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004341 }
4342 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
4343 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004344 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004345 }
4346 status = psa_mac_sign_finish(&hmac,
4347 tls12_prf->output_block, hash_length,
4348 &hmac_output_length);
4349 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004350 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004351 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004352
Janos Follath7742fee2019-06-17 12:58:10 +01004353
4354cleanup:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004355 cleanup_status = psa_mac_abort(&hmac);
4356 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004357 status = cleanup_status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004358 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004359
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004360 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01004361}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004362
Janos Follath844eb0e2019-06-19 12:10:49 +01004363static psa_status_t psa_key_derivation_tls12_prf_read(
4364 psa_tls12_prf_key_derivation_t *tls12_prf,
4365 psa_algorithm_t alg,
4366 uint8_t *output,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004367 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01004368{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004369 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
4370 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01004371 psa_status_t status;
4372 uint8_t offset, length;
4373
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004374 switch (tls12_prf->state) {
Gilles Peskinef216f0d2021-06-11 22:41:46 +02004375 case PSA_TLS12_PRF_STATE_LABEL_SET:
4376 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4377 break;
4378 case PSA_TLS12_PRF_STATE_OUTPUT:
4379 break;
4380 default:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004381 return PSA_ERROR_BAD_STATE;
Gilles Peskinef216f0d2021-06-11 22:41:46 +02004382 }
4383
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004384 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01004385 /* Check if we have fully processed the current block. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004386 if (tls12_prf->left_in_block == 0) {
4387 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
4388 alg);
4389 if (status != PSA_SUCCESS) {
4390 return status;
4391 }
Janos Follath844eb0e2019-06-19 12:10:49 +01004392
4393 continue;
4394 }
4395
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004396 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01004397 length = (uint8_t) output_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004398 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01004399 length = tls12_prf->left_in_block;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004400 }
Janos Follath844eb0e2019-06-19 12:10:49 +01004401
4402 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004403 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01004404 output += length;
4405 output_length -= length;
4406 tls12_prf->left_in_block -= length;
4407 }
4408
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004409 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01004410}
John Durkop07cc04a2020-11-16 22:08:34 -08004411#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4412 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004413
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004414psa_status_t psa_key_derivation_output_bytes(
4415 psa_key_derivation_operation_t *operation,
4416 uint8_t *output,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004417 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02004418{
4419 psa_status_t status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004420 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02004421
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004422 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004423 /* This is a blank operation. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004424 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004425 }
4426
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004427 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004428 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004429 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004430 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004431 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004432 goto exit;
4433 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004434 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004435 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004436 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004437 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4438 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004439 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004440 * output_length > 0. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004441 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004442 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004443 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004444
John Durkopd0321952020-10-29 21:37:36 -07004445#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004446 if (PSA_ALG_IS_HKDF(kdf_alg)) {
4447 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
4448 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, hash_alg,
4449 output, output_length);
4450 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004451#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4452#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4453 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004454 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
4455 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
4456 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
4457 kdf_alg, output,
4458 output_length);
4459 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004460#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4461 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004462 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004463 (void) kdf_alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004464 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004465 }
4466
4467exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004468 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004469 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004470 * This allows us to differentiate between exhausted operations and
4471 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4472 * operations. */
4473 psa_algorithm_t alg = operation->alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004474 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004475 operation->alg = alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004476 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02004477 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004478 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004479}
4480
David Brown7807bf72021-02-09 16:28:23 -07004481#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004482static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02004483{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004484 if (data_size >= 8) {
4485 mbedtls_des_key_set_parity(data);
4486 }
4487 if (data_size >= 16) {
4488 mbedtls_des_key_set_parity(data + 8);
4489 }
4490 if (data_size >= 24) {
4491 mbedtls_des_key_set_parity(data + 16);
4492 }
Gilles Peskine08542d82018-07-19 17:05:42 +02004493}
David Brown7807bf72021-02-09 16:28:23 -07004494#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004495
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004496static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004497 psa_key_slot_t *slot,
4498 size_t bits,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004499 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02004500{
4501 uint8_t *data = NULL;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004502 size_t bytes = PSA_BITS_TO_BYTES(bits);
Gilles Peskineeab56e42018-07-12 17:12:33 +02004503 psa_status_t status;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01004504 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004505
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004506 if (!key_type_is_raw_bytes(slot->attr.type)) {
4507 return PSA_ERROR_INVALID_ARGUMENT;
4508 }
4509 if (bits % 8 != 0) {
4510 return PSA_ERROR_INVALID_ARGUMENT;
4511 }
4512 data = mbedtls_calloc(1, bytes);
4513 if (data == NULL) {
4514 return PSA_ERROR_INSUFFICIENT_MEMORY;
4515 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02004516
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004517 status = psa_key_derivation_output_bytes(operation, data, bytes);
4518 if (status != PSA_SUCCESS) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02004519 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004520 }
David Brown12ca5032021-02-11 11:02:00 -07004521#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004522 if (slot->attr.type == PSA_KEY_TYPE_DES) {
4523 psa_des_set_key_parity(data, bytes);
4524 }
David Brown8107e312021-02-12 08:08:46 -07004525#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004526
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004527 status = psa_allocate_buffer_to_slot(slot, bytes);
4528 if (status != PSA_SUCCESS) {
Paul Elliottda3e7db2021-02-09 18:58:20 +00004529 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004530 }
Ronald Crondd04d422020-11-28 15:14:42 +01004531
Ronald Cronbf33c932020-11-28 18:06:53 +01004532 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01004533 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004534 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004535 };
4536
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004537 status = psa_driver_wrapper_import_key(&attributes,
4538 data, bytes,
4539 slot->key.data,
4540 slot->key.bytes,
4541 &slot->key.bytes, &bits);
4542 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01004543 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004544 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02004545
4546exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004547 mbedtls_free(data);
4548 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004549}
4550
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004551psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
4552 psa_key_derivation_operation_t *operation,
4553 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004554{
4555 psa_status_t status;
4556 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004557 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004558
Ronald Cron81709fc2020-11-14 12:10:32 +01004559 *key = MBEDTLS_SVC_KEY_ID_INIT;
4560
Gilles Peskine0f84d622019-09-12 19:03:13 +02004561 /* Reject any attempt to create a zero-length key so that we don't
4562 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004563 if (psa_get_key_bits(attributes) == 0) {
4564 return PSA_ERROR_INVALID_ARGUMENT;
4565 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02004566
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004567 if (operation->alg == PSA_ALG_NONE) {
4568 return PSA_ERROR_BAD_STATE;
4569 }
Dave Rodgman021e7242021-11-16 10:32:48 +00004570
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004571 if (!operation->can_output_key) {
4572 return PSA_ERROR_NOT_PERMITTED;
4573 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004574
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004575 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
4576 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004577#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004578 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004579 /* Deriving a key in a secure element is not implemented yet. */
4580 status = PSA_ERROR_NOT_SUPPORTED;
4581 }
4582#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004583 if (status == PSA_SUCCESS) {
4584 status = psa_generate_derived_key_internal(slot,
4585 attributes->core.bits,
4586 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004587 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004588 if (status == PSA_SUCCESS) {
4589 status = psa_finish_key_creation(slot, driver, key);
4590 }
4591 if (status != PSA_SUCCESS) {
4592 psa_fail_key_creation(slot, driver);
4593 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004594
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004595 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004596}
4597
Gilles Peskineeab56e42018-07-12 17:12:33 +02004598
4599
4600/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004601/* Key derivation */
4602/****************************************************************/
4603
Steven Cooreman932ffb72021-02-15 12:14:32 +01004604#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004605static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskinecdacf042021-04-29 21:10:00 +02004606{
4607#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004608 if (PSA_ALG_IS_HKDF(kdf_alg)) {
4609 return 1;
4610 }
Gilles Peskinecdacf042021-04-29 21:10:00 +02004611#endif
4612#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004613 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
4614 return 1;
4615 }
Gilles Peskinecdacf042021-04-29 21:10:00 +02004616#endif
4617#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004618 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
4619 return 1;
4620 }
Gilles Peskinecdacf042021-04-29 21:10:00 +02004621#endif
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004622 return 0;
Gilles Peskinecdacf042021-04-29 21:10:00 +02004623}
4624
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004625static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004626{
4627 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004628 psa_status_t status = psa_hash_setup(&operation, alg);
4629 psa_hash_abort(&operation);
4630 return status;
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004631}
4632
Gilles Peskine969c5d62019-01-16 15:53:06 +01004633static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004634 psa_key_derivation_operation_t *operation,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004635 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004636{
Janos Follath5fe19732019-06-20 15:09:30 +01004637 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4638 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004639 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01004640
Gilles Peskine969c5d62019-01-16 15:53:06 +01004641 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004642 if (!is_kdf_alg_supported(kdf_alg)) {
4643 return PSA_ERROR_NOT_SUPPORTED;
4644 }
John Durkop07cc04a2020-11-16 22:08:34 -08004645
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004646 /* All currently supported key derivation algorithms are based on a
4647 * hash algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004648 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
4649 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
4650 if (hash_size == 0) {
4651 return PSA_ERROR_NOT_SUPPORTED;
4652 }
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004653
4654 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
4655 * we might fail later, which is somewhat unfriendly and potentially
4656 * risk-prone. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004657 psa_status_t status = psa_hash_try_support(hash_alg);
4658 if (status != PSA_SUCCESS) {
4659 return status;
4660 }
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004661
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004662 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
4663 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
4664 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
4665 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004666 }
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004667
Gilles Peskinecdacf042021-04-29 21:10:00 +02004668 operation->capacity = 255 * hash_size;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004669 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004670}
Gilles Peskine739c98c2021-04-29 21:34:33 +02004671
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004672static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine739c98c2021-04-29 21:34:33 +02004673{
4674#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004675 if (alg == PSA_ALG_ECDH) {
4676 return PSA_SUCCESS;
4677 }
Gilles Peskine739c98c2021-04-29 21:34:33 +02004678#endif
4679 (void) alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004680 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine739c98c2021-04-29 21:34:33 +02004681}
John Durkop07cc04a2020-11-16 22:08:34 -08004682#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004683
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004684psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
4685 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004686{
4687 psa_status_t status;
4688
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004689 if (operation->alg != 0) {
4690 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004691 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004692
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004693 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
4694 return PSA_ERROR_INVALID_ARGUMENT;
4695 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
4696#if defined(AT_LEAST_ONE_BUILTIN_KDF)
4697 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
4698 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
4699 status = psa_key_agreement_try_support(ka_alg);
4700 if (status != PSA_SUCCESS) {
4701 return status;
4702 }
4703 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
4704#else
4705 return PSA_ERROR_NOT_SUPPORTED;
4706#endif /* AT_LEAST_ONE_BUILTIN_KDF */
4707 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
4708#if defined(AT_LEAST_ONE_BUILTIN_KDF)
4709 status = psa_key_derivation_setup_kdf(operation, alg);
4710#else
4711 return PSA_ERROR_NOT_SUPPORTED;
4712#endif /* AT_LEAST_ONE_BUILTIN_KDF */
4713 } else {
4714 return PSA_ERROR_INVALID_ARGUMENT;
4715 }
4716
4717 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004718 operation->alg = alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004719 }
4720 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004721}
4722
John Durkopd0321952020-10-29 21:37:36 -07004723#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004724static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
4725 psa_algorithm_t hash_alg,
4726 psa_key_derivation_step_t step,
4727 const uint8_t *data,
4728 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004729{
4730 psa_status_t status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004731 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02004732 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004733 if (hkdf->state != HKDF_STATE_INIT) {
4734 return PSA_ERROR_BAD_STATE;
4735 } else {
4736 status = psa_key_derivation_start_hmac(&hkdf->hmac,
4737 hash_alg,
4738 data, data_length);
4739 if (status != PSA_SUCCESS) {
4740 return status;
4741 }
Steven Cooremanb27e3502021-04-29 19:11:25 +02004742 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004743 return PSA_SUCCESS;
Steven Cooremanb27e3502021-04-29 19:11:25 +02004744 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004745 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004746 /* If no salt was provided, use an empty salt. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004747 if (hkdf->state == HKDF_STATE_INIT) {
4748 status = psa_key_derivation_start_hmac(&hkdf->hmac,
4749 hash_alg,
4750 NULL, 0);
4751 if (status != PSA_SUCCESS) {
4752 return status;
4753 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004754 hkdf->state = HKDF_STATE_STARTED;
4755 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004756 if (hkdf->state != HKDF_STATE_STARTED) {
4757 return PSA_ERROR_BAD_STATE;
4758 }
4759 status = psa_mac_update(&hkdf->hmac,
4760 data, data_length);
4761 if (status != PSA_SUCCESS) {
4762 return status;
4763 }
4764 status = psa_mac_sign_finish(&hkdf->hmac,
4765 hkdf->prk,
4766 sizeof(hkdf->prk),
4767 &data_length);
4768 if (status != PSA_SUCCESS) {
4769 return status;
4770 }
4771 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Gilles Peskine2b522db2019-04-12 15:11:49 +02004772 hkdf->block_number = 0;
4773 hkdf->state = HKDF_STATE_KEYED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004774 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02004775 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004776 if (hkdf->state == HKDF_STATE_OUTPUT) {
4777 return PSA_ERROR_BAD_STATE;
4778 }
4779 if (hkdf->info_set) {
4780 return PSA_ERROR_BAD_STATE;
4781 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004782 hkdf->info_length = data_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004783 if (data_length != 0) {
4784 hkdf->info = mbedtls_calloc(1, data_length);
4785 if (hkdf->info == NULL) {
4786 return PSA_ERROR_INSUFFICIENT_MEMORY;
4787 }
4788 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004789 }
4790 hkdf->info_set = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004791 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004792 default:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004793 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004794 }
4795}
John Durkop07cc04a2020-11-16 22:08:34 -08004796#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004797
John Durkop07cc04a2020-11-16 22:08:34 -08004798#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4799 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004800static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
4801 const uint8_t *data,
4802 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01004803{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004804 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
4805 return PSA_ERROR_BAD_STATE;
4806 }
Janos Follathf08e2652019-06-13 09:05:41 +01004807
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004808 if (data_length != 0) {
4809 prf->seed = mbedtls_calloc(1, data_length);
4810 if (prf->seed == NULL) {
4811 return PSA_ERROR_INSUFFICIENT_MEMORY;
4812 }
Janos Follathf08e2652019-06-13 09:05:41 +01004813
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004814 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01004815 prf->seed_length = data_length;
4816 }
Janos Follathf08e2652019-06-13 09:05:41 +01004817
Gilles Peskine43f958b2020-12-13 14:55:14 +01004818 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004819
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004820 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01004821}
4822
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004823static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
4824 const uint8_t *data,
4825 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01004826{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004827 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
4828 return PSA_ERROR_BAD_STATE;
4829 }
Janos Follath81550542019-06-13 14:26:34 +01004830
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004831 if (data_length != 0) {
4832 prf->secret = mbedtls_calloc(1, data_length);
4833 if (prf->secret == NULL) {
4834 return PSA_ERROR_INSUFFICIENT_MEMORY;
4835 }
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004836
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004837 memcpy(prf->secret, data, data_length);
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004838 prf->secret_length = data_length;
4839 }
Janos Follath81550542019-06-13 14:26:34 +01004840
Gilles Peskine43f958b2020-12-13 14:55:14 +01004841 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004842
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004843 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01004844}
4845
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004846static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
4847 const uint8_t *data,
4848 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01004849{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004850 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
4851 return PSA_ERROR_BAD_STATE;
4852 }
Janos Follath63028dd2019-06-13 09:15:47 +01004853
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004854 if (data_length != 0) {
4855 prf->label = mbedtls_calloc(1, data_length);
4856 if (prf->label == NULL) {
4857 return PSA_ERROR_INSUFFICIENT_MEMORY;
4858 }
Janos Follath63028dd2019-06-13 09:15:47 +01004859
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004860 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01004861 prf->label_length = data_length;
4862 }
Janos Follath63028dd2019-06-13 09:15:47 +01004863
Gilles Peskine43f958b2020-12-13 14:55:14 +01004864 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004865
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004866 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01004867}
4868
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004869static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
4870 psa_key_derivation_step_t step,
4871 const uint8_t *data,
4872 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01004873{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004874 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01004875 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004876 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01004877 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004878 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01004879 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004880 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01004881 default:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004882 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01004883 }
4884}
John Durkop07cc04a2020-11-16 22:08:34 -08004885#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4886 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4887
4888#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4889static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4890 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004891 const uint8_t *data,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004892 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08004893{
4894 psa_status_t status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004895 uint8_t pms[4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE];
John Durkop07cc04a2020-11-16 22:08:34 -08004896 uint8_t *cur = pms;
4897
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004898 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
4899 return PSA_ERROR_INVALID_ARGUMENT;
4900 }
John Durkop07cc04a2020-11-16 22:08:34 -08004901
4902 /* Quoting RFC 4279, Section 2:
4903 *
4904 * The premaster secret is formed as follows: if the PSK is N octets
4905 * long, concatenate a uint16 with the value N, N zero octets, a second
4906 * uint16 with the value N, and the PSK itself.
4907 */
4908
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004909 *cur++ = MBEDTLS_BYTE_1(data_length);
4910 *cur++ = MBEDTLS_BYTE_0(data_length);
4911 memset(cur, 0, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08004912 cur += data_length;
4913 *cur++ = pms[0];
4914 *cur++ = pms[1];
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004915 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08004916 cur += data_length;
4917
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004918 status = psa_tls12_prf_set_key(prf, pms, cur - pms);
John Durkop07cc04a2020-11-16 22:08:34 -08004919
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004920 mbedtls_platform_zeroize(pms, sizeof(pms));
4921 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08004922}
Janos Follath6660f0e2019-06-17 08:44:03 +01004923
4924static psa_status_t psa_tls12_prf_psk_to_ms_input(
4925 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004926 psa_key_derivation_step_t step,
4927 const uint8_t *data,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004928 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01004929{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004930 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
4931 return psa_tls12_prf_psk_to_ms_set_key(prf,
4932 data, data_length);
Janos Follath0c1ed842019-06-28 13:35:36 +01004933 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004934
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004935 return psa_tls12_prf_input(prf, step, data, data_length);
Janos Follath6660f0e2019-06-17 08:44:03 +01004936}
John Durkop07cc04a2020-11-16 22:08:34 -08004937#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004938
Gilles Peskineb8965192019-09-24 16:21:10 +02004939/** Check whether the given key type is acceptable for the given
4940 * input step of a key derivation.
4941 *
4942 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4943 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4944 * Both secret and non-secret inputs can alternatively have the type
4945 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4946 * that the input was passed as a buffer rather than via a key object.
4947 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004948static int psa_key_derivation_check_input_type(
4949 psa_key_derivation_step_t step,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004950 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02004951{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004952 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02004953 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004954 if (key_type == PSA_KEY_TYPE_DERIVE) {
4955 return PSA_SUCCESS;
4956 }
4957 if (key_type == PSA_KEY_TYPE_NONE) {
4958 return PSA_SUCCESS;
4959 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02004960 break;
4961 case PSA_KEY_DERIVATION_INPUT_LABEL:
4962 case PSA_KEY_DERIVATION_INPUT_SALT:
4963 case PSA_KEY_DERIVATION_INPUT_INFO:
4964 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004965 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
4966 return PSA_SUCCESS;
4967 }
4968 if (key_type == PSA_KEY_TYPE_NONE) {
4969 return PSA_SUCCESS;
4970 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02004971 break;
4972 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004973 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02004974}
4975
Janos Follathb80a94e2019-06-12 15:54:46 +01004976static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004977 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004978 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004979 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004980 const uint8_t *data,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004981 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004982{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004983 psa_status_t status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004984 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004985
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004986 status = psa_key_derivation_check_input_type(step, key_type);
4987 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02004988 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004989 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02004990
John Durkopd0321952020-10-29 21:37:36 -07004991#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004992 if (PSA_ALG_IS_HKDF(kdf_alg)) {
4993 status = psa_hkdf_input(&operation->ctx.hkdf,
4994 PSA_ALG_HKDF_GET_HASH(kdf_alg),
4995 step, data, data_length);
4996 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004997#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4998#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004999 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
5000 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
5001 step, data, data_length);
5002 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005003#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
5004#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005005 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5006 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
5007 step, data, data_length);
5008 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005009#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005010 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005011 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01005012 (void) data;
5013 (void) data_length;
5014 (void) kdf_alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005015 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005016 }
5017
Gilles Peskine224b0d62019-09-23 18:13:17 +02005018exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005019 if (status != PSA_SUCCESS) {
5020 psa_key_derivation_abort(operation);
5021 }
5022 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005023}
5024
Janos Follath51f4a0f2019-06-14 11:35:55 +01005025psa_status_t psa_key_derivation_input_bytes(
5026 psa_key_derivation_operation_t *operation,
5027 psa_key_derivation_step_t step,
5028 const uint8_t *data,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005029 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005030{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005031 return psa_key_derivation_input_internal(operation, step,
5032 PSA_KEY_TYPE_NONE,
5033 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01005034}
5035
Janos Follath51f4a0f2019-06-14 11:35:55 +01005036psa_status_t psa_key_derivation_input_key(
5037 psa_key_derivation_operation_t *operation,
5038 psa_key_derivation_step_t step,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005039 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005040{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005041 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005042 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005043 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005044
Ronald Cron5c522922020-11-14 16:35:34 +01005045 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005046 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
5047 if (status != PSA_SUCCESS) {
5048 psa_key_derivation_abort(operation);
5049 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02005050 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005051
5052 /* Passing a key object as a SECRET input unlocks the permission
5053 * to output to a key object. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005054 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005055 operation->can_output_key = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005056 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02005057
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005058 status = psa_key_derivation_input_internal(operation,
5059 step, slot->attr.type,
5060 slot->key.data,
5061 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02005062
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005063 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02005064
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005065 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005066}
Gilles Peskineea0fb492018-07-12 17:17:20 +02005067
5068
5069
5070/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02005071/* Key agreement */
5072/****************************************************************/
5073
John Durkop6ba40d12020-11-10 08:50:04 -08005074#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005075static psa_status_t psa_key_agreement_ecdh(const uint8_t *peer_key,
5076 size_t peer_key_length,
5077 const mbedtls_ecp_keypair *our_key,
5078 uint8_t *shared_secret,
5079 size_t shared_secret_size,
5080 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005081{
Steven Cooremand4867872020-08-05 16:31:39 +02005082 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005083 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00005084 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005085 size_t bits = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005086 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa(our_key->grp.id, &bits);
5087 mbedtls_ecdh_init(&ecdh);
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005088
Ronald Cron90857082020-11-25 14:58:33 +01005089 status = mbedtls_psa_ecp_load_representation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005090 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
5091 bits,
5092 peer_key,
5093 peer_key_length,
5094 &their_key);
5095 if (status != PSA_SUCCESS) {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005096 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005097 }
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005098
Jaeden Amero97271b32019-01-10 19:38:51 +00005099 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005100 mbedtls_ecdh_get_params(&ecdh, their_key, MBEDTLS_ECDH_THEIRS));
5101 if (status != PSA_SUCCESS) {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005102 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005103 }
Jaeden Amero97271b32019-01-10 19:38:51 +00005104 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005105 mbedtls_ecdh_get_params(&ecdh, our_key, MBEDTLS_ECDH_OURS));
5106 if (status != PSA_SUCCESS) {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005107 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005108 }
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005109
Jaeden Amero97271b32019-01-10 19:38:51 +00005110 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005111 mbedtls_ecdh_calc_secret(&ecdh,
5112 shared_secret_length,
5113 shared_secret, shared_secret_size,
5114 mbedtls_psa_get_random,
5115 MBEDTLS_PSA_RANDOM_STATE));
5116 if (status != PSA_SUCCESS) {
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005117 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005118 }
5119 if (PSA_BITS_TO_BYTES(bits) != *shared_secret_length) {
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005120 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005121 }
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005122
5123exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005124 if (status != PSA_SUCCESS) {
5125 mbedtls_platform_zeroize(shared_secret, shared_secret_size);
5126 }
5127 mbedtls_ecdh_free(&ecdh);
5128 mbedtls_ecp_keypair_free(their_key);
5129 mbedtls_free(their_key);
Steven Cooremana2371e52020-07-28 14:30:39 +02005130
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005131 return status;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005132}
John Durkop6ba40d12020-11-10 08:50:04 -08005133#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005134
Gilles Peskine01d718c2018-09-18 12:01:02 +02005135#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5136
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005137static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
5138 psa_key_slot_t *private_key,
5139 const uint8_t *peer_key,
5140 size_t peer_key_length,
5141 uint8_t *shared_secret,
5142 size_t shared_secret_size,
5143 size_t *shared_secret_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02005144{
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01005145 mbedtls_ecp_keypair *ecp = NULL;
5146 psa_status_t status;
Agathiyan Bragadeeshe7eb8052023-07-31 16:16:38 +01005147
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005148 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08005149#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005150 case PSA_ALG_ECDH:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005151 if (!PSA_KEY_TYPE_IS_ECC_KEY_PAIR(private_key->attr.type)) {
5152 return PSA_ERROR_INVALID_ARGUMENT;
5153 }
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01005154 status = mbedtls_psa_ecp_load_representation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005155 private_key->attr.type,
5156 private_key->attr.bits,
5157 private_key->key.data,
5158 private_key->key.bytes,
5159 &ecp);
5160 if (status != PSA_SUCCESS) {
5161 return status;
5162 }
5163 status = psa_key_agreement_ecdh(peer_key, peer_key_length,
5164 ecp,
5165 shared_secret, shared_secret_size,
5166 shared_secret_length);
5167 mbedtls_ecp_keypair_free(ecp);
5168 mbedtls_free(ecp);
5169 return status;
John Durkop6ba40d12020-11-10 08:50:04 -08005170#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005171 default:
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01005172 (void) ecp;
5173 (void) status;
Gilles Peskine93f85002018-11-16 16:43:31 +01005174 (void) private_key;
5175 (void) peer_key;
5176 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005177 (void) shared_secret;
5178 (void) shared_secret_size;
5179 (void) shared_secret_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005180 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005181 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005182}
5183
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005184/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005185 * to potentially free embedded data structures and wipe confidential data.
5186 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005187static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
5188 psa_key_derivation_step_t step,
5189 psa_key_slot_t *private_key,
5190 const uint8_t *peer_key,
5191 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02005192{
5193 psa_status_t status;
5194 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5195 size_t shared_secret_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005196 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02005197
5198 /* Step 1: run the secret agreement algorithm to generate the shared
5199 * secret. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005200 status = psa_key_agreement_raw_internal(ka_alg,
5201 private_key,
5202 peer_key, peer_key_length,
5203 shared_secret,
5204 sizeof(shared_secret),
5205 &shared_secret_length);
5206 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02005207 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005208 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02005209
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005210 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005211 * the shared secret. A shared secret is permitted wherever a key
5212 * of type DERIVE is permitted. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005213 status = psa_key_derivation_input_internal(operation, step,
5214 PSA_KEY_TYPE_DERIVE,
5215 shared_secret,
5216 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02005217exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005218 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
5219 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02005220}
5221
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005222psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
5223 psa_key_derivation_step_t step,
5224 mbedtls_svc_key_id_t private_key,
5225 const uint8_t *peer_key,
5226 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02005227{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005228 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005229 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005230 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005231
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005232 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5233 return PSA_ERROR_INVALID_ARGUMENT;
5234 }
Ronald Cron5c522922020-11-14 16:35:34 +01005235 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005236 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
5237 if (status != PSA_SUCCESS) {
5238 return status;
5239 }
5240 status = psa_key_agreement_internal(operation, step,
5241 slot,
5242 peer_key, peer_key_length);
5243 if (status != PSA_SUCCESS) {
5244 psa_key_derivation_abort(operation);
5245 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005246 /* If a private key has been added as SECRET, we allow the derived
5247 * key material to be used as a key in PSA Crypto. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005248 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005249 operation->can_output_key = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005250 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005251 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005252
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005253 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02005254
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005255 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005256}
5257
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005258psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
5259 mbedtls_svc_key_id_t private_key,
5260 const uint8_t *peer_key,
5261 size_t peer_key_length,
5262 uint8_t *output,
5263 size_t output_size,
5264 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005265{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005266 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005267 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005268 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01005269 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005270
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005271 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02005272 status = PSA_ERROR_INVALID_ARGUMENT;
5273 goto exit;
5274 }
Ronald Cron5c522922020-11-14 16:35:34 +01005275 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005276 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
5277 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02005278 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005279 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005280
Gilles Peskine42313fb2022-04-14 00:17:15 +02005281 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
5282 * for the output size. The PSA specification only guarantees that this
5283 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
5284 * but it might be nice to allow smaller buffers if the output fits.
5285 * At the time of writing this comment, with only ECDH implemented,
5286 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
5287 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
5288 * be exact for it as well. */
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01005289 expected_length =
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005290 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
5291 if (output_size < expected_length) {
Gilles Peskine42313fb2022-04-14 00:17:15 +02005292 status = PSA_ERROR_BUFFER_TOO_SMALL;
5293 goto exit;
5294 }
5295
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005296 status = psa_key_agreement_raw_internal(alg, slot,
5297 peer_key, peer_key_length,
5298 output, output_size,
5299 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02005300
5301exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005302 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02005303 /* If an error happens and is not handled properly, the output
5304 * may be used as a key to protect sensitive data. Arrange for such
5305 * a key to be random, which is likely to result in decryption or
5306 * verification errors. This is better than filling the buffer with
5307 * some constant data such as zeros, which would result in the data
5308 * being protected with a reproducible, easily knowable key.
5309 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005310 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02005311 *output_length = output_size;
5312 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005313
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005314 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02005315
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005316 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005317}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005318
5319
Gilles Peskine30524eb2020-11-13 17:02:26 +01005320
Gilles Peskine86a440b2018-11-12 18:39:40 +01005321/****************************************************************/
5322/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005323/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005324
Gilles Peskine9a9d5ee2023-04-28 21:00:28 +02005325#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5326#include "mbedtls/entropy_poll.h"
5327#endif
5328
Gilles Peskine30524eb2020-11-13 17:02:26 +01005329/** Initialize the PSA random generator.
5330 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005331static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01005332{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005333#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005334 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005335#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5336
Gilles Peskine30524eb2020-11-13 17:02:26 +01005337 /* Set default configuration if
5338 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005339 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005340 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005341 }
5342 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005343 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005344 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01005345
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005346 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01005347#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5348 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5349 /* The PSA entropy injection feature depends on using NV seed as an entropy
5350 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005351 mbedtls_entropy_add_source(&rng->entropy,
5352 mbedtls_nv_seed_poll, NULL,
5353 MBEDTLS_ENTROPY_BLOCK_SIZE,
5354 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01005355#endif
5356
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005357 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005358#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005359}
5360
5361/** Deinitialize the PSA random generator.
5362 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005363static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01005364{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005365#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005366 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005367#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005368 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
5369 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005370#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005371}
5372
5373/** Seed the PSA random generator.
5374 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005375static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01005376{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005377#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5378 /* Do nothing: the external RNG seeds itself. */
5379 (void) rng;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005380 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005381#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005382 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005383 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
5384 drbg_seed, sizeof(drbg_seed) - 1);
5385 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005386#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005387}
5388
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005389psa_status_t psa_generate_random(uint8_t *output,
5390 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005391{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005392 GUARD_MODULE_INITIALIZED;
5393
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005394#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5395
5396 size_t output_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005397 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
5398 output, output_size,
5399 &output_length);
5400 if (status != PSA_SUCCESS) {
5401 return status;
5402 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005403 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove49f99bc2022-12-04 16:44:21 +00005404 * for the external RNG interface. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005405 if (output_length != output_size) {
5406 return PSA_ERROR_INSUFFICIENT_ENTROPY;
5407 }
5408 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005409
5410#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5411
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005412 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005413 size_t request_size =
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005414 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5415 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5416 output_size);
5417 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
5418 output, request_size);
5419 if (ret != 0) {
5420 return mbedtls_to_psa_error(ret);
5421 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01005422 output_size -= request_size;
5423 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005424 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005425 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005426#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005427}
5428
Gilles Peskine8814fc42020-12-14 15:33:44 +01005429/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005430 *
5431 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5432 * `psa_generate_random(...)`. The state parameter is ignored since the
5433 * PSA API doesn't support passing an explicit state.
5434 *
5435 * In the non-external case, psa_generate_random() calls an
5436 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5437 * and semantics as mbedtls_psa_get_random(). As an optimization,
5438 * instead of doing this back-and-forth between the PSA API and the
5439 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5440 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005441 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005442#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5443int mbedtls_psa_get_random(void *p_rng,
5444 unsigned char *output,
5445 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01005446{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005447 /* This function takes a pointer to the RNG state because that's what
5448 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5449 * its own state internally and doesn't let the caller access that state.
5450 * So we just ignore the state parameter, and in practice we'll pass
5451 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005452 (void) p_rng;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005453 psa_status_t status = psa_generate_random(output, output_size);
5454 if (status == PSA_SUCCESS) {
5455 return 0;
5456 } else {
5457 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
5458 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01005459}
5460#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5461
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005462#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005463psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
5464 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005465{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005466 if (global_data.initialized) {
5467 return PSA_ERROR_NOT_PERMITTED;
5468 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005469
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005470 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
5471 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
5472 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
5473 return PSA_ERROR_INVALID_ARGUMENT;
5474 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005475
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005476 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005477}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005478#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005479
Ronald Cron3772afe2021-02-08 16:10:05 +01005480/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005481 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005482 * \param type The key type
5483 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005484 *
5485 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005486 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005487 * \retval #PSA_ERROR_INVALID_ARGUMENT
5488 * The size in bits of the key is not valid.
5489 * \retval #PSA_ERROR_NOT_SUPPORTED
5490 * The type and/or the size in bits of the key or the combination of
5491 * the two is not supported.
5492 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005493static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005494 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005495{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005496 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005497
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005498 if (key_type_is_raw_bytes(type)) {
5499 status = validate_unstructured_key_bit_size(type, bits);
5500 if (status != PSA_SUCCESS) {
5501 return status;
5502 }
5503 } else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005504#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005505 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
5506 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
5507 return PSA_ERROR_NOT_SUPPORTED;
5508 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005509
Ronald Cron01b2aba2020-10-05 09:42:02 +02005510 /* Accept only byte-aligned keys, for the same reasons as
5511 * in psa_import_rsa_key(). */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005512 if (bits % 8 != 0) {
5513 return PSA_ERROR_NOT_SUPPORTED;
5514 }
5515 } else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005516#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005517
Ronald Cron5c4d3862020-12-07 11:07:24 +01005518#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005519 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01005520 /* To avoid empty block, return successfully here. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005521 return PSA_SUCCESS;
5522 } else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005523#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005524 {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005525 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005526 }
5527
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005528 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005529}
5530
Ronald Cron55ed0592020-10-05 10:30:40 +02005531psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005532 const psa_key_attributes_t *attributes,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005533 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005534{
5535 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005536 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005537
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005538 if ((attributes->domain_parameters == NULL) &&
5539 (attributes->domain_parameters_size != 0)) {
5540 return PSA_ERROR_INVALID_ARGUMENT;
5541 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02005542
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005543 if (key_type_is_raw_bytes(type)) {
5544 status = psa_generate_random(key_buffer, key_buffer_size);
5545 if (status != PSA_SUCCESS) {
5546 return status;
5547 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005548
David Brown12ca5032021-02-11 11:02:00 -07005549#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005550 if (type == PSA_KEY_TYPE_DES) {
5551 psa_des_set_key_parity(key_buffer, key_buffer_size);
5552 }
David Brown8107e312021-02-12 08:08:46 -07005553#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005554 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01005555
Jaeden Ameroc17f2932021-05-14 08:34:32 +01005556#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5557 defined(MBEDTLS_GENPRIME)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005558 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
5559 return mbedtls_psa_rsa_generate_key(attributes,
5560 key_buffer,
5561 key_buffer_size,
5562 key_buffer_length);
5563 } else
Jaeden Ameroc17f2932021-05-14 08:34:32 +01005564#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5565 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005566
John Durkop9814fa22020-11-04 12:28:15 -08005567#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005568 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
5569 return mbedtls_psa_ecp_generate_key(attributes,
5570 key_buffer,
5571 key_buffer_size,
5572 key_buffer_length);
5573 } else
John Durkop9814fa22020-11-04 12:28:15 -08005574#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005575 {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005576 (void) key_buffer_length;
5577 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02005578 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005579
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005580 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005581}
Darryl Green0c6575a2018-11-07 16:05:30 +00005582
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005583psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
5584 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005585{
5586 psa_status_t status;
5587 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005588 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005589 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005590
Ronald Cron81709fc2020-11-14 12:10:32 +01005591 *key = MBEDTLS_SVC_KEY_ID_INIT;
5592
Gilles Peskine0f84d622019-09-12 19:03:13 +02005593 /* Reject any attempt to create a zero-length key so that we don't
5594 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005595 if (psa_get_key_bits(attributes) == 0) {
5596 return PSA_ERROR_INVALID_ARGUMENT;
5597 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02005598
Przemyslaw Stekiel5b20a7e2021-10-07 11:08:56 +02005599 /* Reject any attempt to create a public key. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005600 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
5601 return PSA_ERROR_INVALID_ARGUMENT;
5602 }
Przemyslaw Stekiel5b20a7e2021-10-07 11:08:56 +02005603
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005604 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
5605 &slot, &driver);
5606 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02005607 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005608 }
Gilles Peskine11792082019-08-06 18:36:36 +02005609
Ronald Cron977c2472020-10-13 08:32:21 +02005610 /* In the case of a transparent key or an opaque key stored in local
5611 * storage (thus not in the case of generating a key in a secure element
5612 * or cryptoprocessor with storage), we have to allocate a buffer to
5613 * hold the generated key material. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005614 if (slot->key.data == NULL) {
5615 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
5616 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01005617 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005618 attributes->core.type, attributes->core.bits);
5619 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01005620 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005621 }
Ronald Cron3772afe2021-02-08 16:10:05 +01005622
5623 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005624 attributes->core.type,
5625 attributes->core.bits);
5626 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02005627 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005628 attributes, &key_buffer_size);
5629 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01005630 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005631 }
Ronald Cron977c2472020-10-13 08:32:21 +02005632 }
Ronald Cron977c2472020-10-13 08:32:21 +02005633
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005634 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
5635 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02005636 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005637 }
Ronald Cron977c2472020-10-13 08:32:21 +02005638 }
5639
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005640 status = psa_driver_wrapper_generate_key(attributes,
5641 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02005642
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005643 if (status != PSA_SUCCESS) {
5644 psa_remove_key_data_from_memory(slot);
5645 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02005646
Gilles Peskine11792082019-08-06 18:36:36 +02005647exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005648 if (status == PSA_SUCCESS) {
5649 status = psa_finish_key_creation(slot, driver, key);
5650 }
5651 if (status != PSA_SUCCESS) {
5652 psa_fail_key_creation(slot, driver);
5653 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005654
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005655 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005656}
5657
Gilles Peskinee59236f2018-01-27 23:32:46 +01005658/****************************************************************/
5659/* Module setup */
5660/****************************************************************/
5661
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005662#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005663psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005664 void (* entropy_init)(mbedtls_entropy_context *ctx),
5665 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01005666{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005667 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
5668 return PSA_ERROR_BAD_STATE;
5669 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01005670 global_data.rng.entropy_init = entropy_init;
5671 global_data.rng.entropy_free = entropy_free;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005672 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01005673}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005674#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005675
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005676void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005677{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005678 psa_wipe_all_key_slots();
5679 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
5680 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01005681 }
5682 /* Wipe all remaining data, including configuration.
5683 * In particular, this sets all state indicator to the value
5684 * indicating "uninitialized". */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005685 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron088d5d02021-04-10 16:57:30 +02005686
5687 /* Terminate drivers */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005688 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01005689}
5690
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005691#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5692/** Recover a transaction that was interrupted by a power failure.
5693 *
5694 * This function is called during initialization, before psa_crypto_init()
5695 * returns. If this function returns a failure status, the initialization
5696 * fails.
5697 */
5698static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005699 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005700{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005701 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005702 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5703 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005704 /* TODO - fall through to the failure case until this
5705 * is implemented.
5706 * https://github.com/ARMmbed/mbed-crypto/issues/218
5707 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005708 default:
5709 /* We found an unsupported transaction in the storage.
5710 * We don't know what state the storage is in. Give up. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005711 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005712 }
5713}
5714#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5715
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005716psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005717{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005718 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005719
Gilles Peskinec6b69072018-11-20 21:42:52 +01005720 /* Double initialization is explicitly allowed. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005721 if (global_data.initialized != 0) {
5722 return PSA_SUCCESS;
5723 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005724
Gilles Peskine30524eb2020-11-13 17:02:26 +01005725 /* Initialize and seed the random generator. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005726 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01005727 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005728 status = mbedtls_psa_random_seed(&global_data.rng);
5729 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01005730 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005731 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01005732 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005733
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005734 status = psa_initialize_key_slots();
5735 if (status != PSA_SUCCESS) {
Gilles Peskine66fb1262018-12-10 16:29:04 +01005736 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005737 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01005738
Ronald Cron088d5d02021-04-10 16:57:30 +02005739 /* Init drivers */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005740 status = psa_driver_wrapper_init();
5741 if (status != PSA_SUCCESS) {
Gilles Peskined9348f22019-10-01 15:22:29 +02005742 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005743 }
Gilles Peskined9348f22019-10-01 15:22:29 +02005744
Gilles Peskine4b734222019-07-24 15:56:31 +02005745#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005746 status = psa_crypto_load_transaction();
5747 if (status == PSA_SUCCESS) {
5748 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
5749 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005750 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005751 }
5752 status = psa_crypto_stop_transaction();
5753 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02005754 /* There's no transaction to complete. It's all good. */
5755 status = PSA_SUCCESS;
5756 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005757#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005758
Gilles Peskinec6b69072018-11-20 21:42:52 +01005759 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005760 global_data.initialized = 1;
5761
5762exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005763 if (status != PSA_SUCCESS) {
5764 mbedtls_psa_crypto_free();
5765 }
5766 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005767}
5768
David Horstmann114d8242023-12-07 18:39:17 +00005769/* Memory copying test hooks. These are called before input copy, after input
5770 * copy, before output copy and after output copy, respectively.
5771 * They are used by memory-poisoning tests to temporarily unpoison buffers
5772 * while they are copied. */
David Horstmann63f82f72023-11-28 15:21:56 +00005773#if defined(MBEDTLS_TEST_HOOKS)
5774void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
5775void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
5776void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
5777void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
5778#endif
5779
David Horstmanndf493552023-11-15 15:18:30 +00005780/** Copy from an input buffer to a local copy.
5781 *
5782 * \param[in] input Pointer to input buffer.
5783 * \param[in] input_len Length of the input buffer.
5784 * \param[out] input_copy Pointer to a local copy in which to store the input data.
5785 * \param[out] input_copy_len Length of the local copy buffer.
5786 * \return #PSA_SUCCESS, if the buffer was successfully
5787 * copied.
5788 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
5789 * copy is too small to hold contents of the
5790 * input buffer.
5791 */
5792MBEDTLS_STATIC_TESTABLE
David Horstmann957f9802023-10-30 20:29:43 +00005793psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
5794 uint8_t *input_copy, size_t input_copy_len)
5795{
5796 if (input_len > input_copy_len) {
David Horstmann8684ad52023-11-03 19:51:40 +00005797 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmann957f9802023-10-30 20:29:43 +00005798 }
5799
David Horstmann0760b152023-11-24 16:21:04 +00005800#if defined(MBEDTLS_TEST_HOOKS)
David Horstmann63f82f72023-11-28 15:21:56 +00005801 if (psa_input_pre_copy_hook != NULL) {
5802 psa_input_pre_copy_hook(input, input_len);
5803 }
David Horstmann0760b152023-11-24 16:21:04 +00005804#endif
5805
David Horstmann660027f2023-11-15 17:33:47 +00005806 if (input_len > 0) {
5807 memcpy(input_copy, input, input_len);
5808 }
David Horstmann957f9802023-10-30 20:29:43 +00005809
David Horstmann0760b152023-11-24 16:21:04 +00005810#if defined(MBEDTLS_TEST_HOOKS)
David Horstmann63f82f72023-11-28 15:21:56 +00005811 if (psa_input_post_copy_hook != NULL) {
5812 psa_input_post_copy_hook(input, input_len);
5813 }
David Horstmann0760b152023-11-24 16:21:04 +00005814#endif
5815
David Horstmann957f9802023-10-30 20:29:43 +00005816 return PSA_SUCCESS;
5817}
5818
David Horstmanndf493552023-11-15 15:18:30 +00005819/** Copy from a local output buffer into a user-supplied one.
5820 *
5821 * \param[in] output_copy Pointer to a local buffer containing the output.
5822 * \param[in] output_copy_len Length of the local buffer.
5823 * \param[out] output Pointer to user-supplied output buffer.
5824 * \param[out] output_len Length of the user-supplied output buffer.
5825 * \return #PSA_SUCCESS, if the buffer was successfully
5826 * copied.
David Horstmann232ab252023-11-20 12:39:38 +00005827 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmanndf493552023-11-15 15:18:30 +00005828 * user-supplied output buffer is too small to
5829 * hold the contents of the local buffer.
5830 */
5831MBEDTLS_STATIC_TESTABLE
David Horstmann2bd296e2023-10-30 20:37:12 +00005832psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
5833 uint8_t *output, size_t output_len)
5834{
5835 if (output_len < output_copy_len) {
David Horstmann232ab252023-11-20 12:39:38 +00005836 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann2bd296e2023-10-30 20:37:12 +00005837 }
David Horstmann660027f2023-11-15 17:33:47 +00005838
David Horstmann0760b152023-11-24 16:21:04 +00005839#if defined(MBEDTLS_TEST_HOOKS)
David Horstmann63f82f72023-11-28 15:21:56 +00005840 if (psa_output_pre_copy_hook != NULL) {
5841 psa_output_pre_copy_hook(output, output_len);
5842 }
David Horstmann0760b152023-11-24 16:21:04 +00005843#endif
5844
David Horstmann660027f2023-11-15 17:33:47 +00005845 if (output_copy_len > 0) {
5846 memcpy(output, output_copy, output_copy_len);
5847 }
5848
David Horstmann0760b152023-11-24 16:21:04 +00005849#if defined(MBEDTLS_TEST_HOOKS)
David Horstmann63f82f72023-11-28 15:21:56 +00005850 if (psa_output_post_copy_hook != NULL) {
5851 psa_output_post_copy_hook(output, output_len);
5852 }
David Horstmann0760b152023-11-24 16:21:04 +00005853#endif
5854
David Horstmann2bd296e2023-10-30 20:37:12 +00005855 return PSA_SUCCESS;
5856}
5857
David Horstmann81a0d572023-11-20 17:15:32 +00005858psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
5859 psa_crypto_local_input_t *local_input)
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005860{
5861 psa_status_t status;
5862
David Horstmann0d52c712023-11-23 15:50:37 +00005863 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005864
David Horstmann726bf052023-11-15 18:11:26 +00005865 if (input_len == 0) {
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005866 return PSA_SUCCESS;
5867 }
5868
David Horstmann81a0d572023-11-20 17:15:32 +00005869 local_input->buffer = mbedtls_calloc(input_len, 1);
5870 if (local_input->buffer == NULL) {
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005871 /* Since we dealt with the zero-length case above, we know that
5872 * a NULL return value means a failure of allocation. */
5873 return PSA_ERROR_INSUFFICIENT_MEMORY;
5874 }
David Horstmann81a0d572023-11-20 17:15:32 +00005875 /* From now on, we must free local_input->buffer on error. */
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005876
David Horstmann81a0d572023-11-20 17:15:32 +00005877 local_input->length = input_len;
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005878
5879 status = psa_crypto_copy_input(input, input_len,
David Horstmann81a0d572023-11-20 17:15:32 +00005880 local_input->buffer, local_input->length);
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005881 if (status != PSA_SUCCESS) {
5882 goto error;
5883 }
5884
5885 return PSA_SUCCESS;
5886
5887error:
David Horstmann81a0d572023-11-20 17:15:32 +00005888 mbedtls_free(local_input->buffer);
5889 local_input->buffer = NULL;
5890 local_input->length = 0;
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005891 return status;
5892}
5893
David Horstmann81a0d572023-11-20 17:15:32 +00005894void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmannfa2d75d2023-11-07 18:00:41 +00005895{
David Horstmann81a0d572023-11-20 17:15:32 +00005896 mbedtls_free(local_input->buffer);
5897 local_input->buffer = NULL;
5898 local_input->length = 0;
David Horstmannfa2d75d2023-11-07 18:00:41 +00005899}
5900
David Horstmann1a76ab12023-11-20 12:54:09 +00005901psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
5902 psa_crypto_local_output_t *local_output)
David Horstmann953cd5b2023-11-08 15:19:43 +00005903{
David Horstmann0d52c712023-11-23 15:50:37 +00005904 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmann953cd5b2023-11-08 15:19:43 +00005905
David Horstmann726bf052023-11-15 18:11:26 +00005906 if (output_len == 0) {
David Horstmann953cd5b2023-11-08 15:19:43 +00005907 return PSA_SUCCESS;
5908 }
David Horstmann1a76ab12023-11-20 12:54:09 +00005909 local_output->buffer = mbedtls_calloc(output_len, 1);
5910 if (local_output->buffer == NULL) {
David Horstmann953cd5b2023-11-08 15:19:43 +00005911 /* Since we dealt with the zero-length case above, we know that
5912 * a NULL return value means a failure of allocation. */
5913 return PSA_ERROR_INSUFFICIENT_MEMORY;
5914 }
David Horstmann1a76ab12023-11-20 12:54:09 +00005915 local_output->length = output_len;
5916 local_output->original = output;
David Horstmann953cd5b2023-11-08 15:19:43 +00005917
5918 return PSA_SUCCESS;
5919}
5920
Gabor Mezei3b0c3712024-01-24 13:07:17 +01005921psa_status_t psa_crypto_local_output_alloc_with_copy(uint8_t *output, size_t output_len,
5922 psa_crypto_local_output_t *local_output)
5923{
5924 psa_status_t status;
5925 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
5926
5927 if (output_len == 0) {
5928 return PSA_SUCCESS;
5929 }
5930 local_output->buffer = mbedtls_calloc(output_len, 1);
5931 if (local_output->buffer == NULL) {
5932 /* Since we dealt with the zero-length case above, we know that
5933 * a NULL return value means a failure of allocation. */
5934 return PSA_ERROR_INSUFFICIENT_MEMORY;
5935 }
5936 local_output->length = output_len;
5937 local_output->original = output;
5938
5939 status = psa_crypto_copy_input(output, output_len,
5940 local_output->buffer, local_output->length);
5941 if (status != PSA_SUCCESS) {
5942 goto error;
5943 }
5944
5945 return PSA_SUCCESS;
5946
5947error:
5948 mbedtls_free(local_output->buffer);
5949 local_output->buffer = NULL;
5950 local_output->length = 0;
5951 return status;
5952}
5953
David Horstmann1a76ab12023-11-20 12:54:09 +00005954psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmannaeeb2742023-11-08 17:44:18 +00005955{
David Horstmann761761f2023-11-15 15:57:32 +00005956 psa_status_t status;
5957
David Horstmann1a76ab12023-11-20 12:54:09 +00005958 if (local_output->buffer == NULL) {
5959 local_output->length = 0;
David Horstmannaeeb2742023-11-08 17:44:18 +00005960 return PSA_SUCCESS;
5961 }
David Horstmann1a76ab12023-11-20 12:54:09 +00005962 if (local_output->original == NULL) {
David Horstmannaeeb2742023-11-08 17:44:18 +00005963 /* We have an internal copy but nothing to copy back to. */
5964 return PSA_ERROR_CORRUPTION_DETECTED;
5965 }
5966
David Horstmann1a76ab12023-11-20 12:54:09 +00005967 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
5968 local_output->original, local_output->length);
David Horstmann761761f2023-11-15 15:57:32 +00005969 if (status != PSA_SUCCESS) {
5970 return status;
5971 }
David Horstmannaeeb2742023-11-08 17:44:18 +00005972
David Horstmann1a76ab12023-11-20 12:54:09 +00005973 mbedtls_free(local_output->buffer);
5974 local_output->buffer = NULL;
5975 local_output->length = 0;
David Horstmannaeeb2742023-11-08 17:44:18 +00005976
5977 return PSA_SUCCESS;
5978}
5979
Gilles Peskinee59236f2018-01-27 23:32:46 +01005980#endif /* MBEDTLS_PSA_CRYPTO_C */