blob: 05467bdb7c95d37467e7daf9041e3f434bfcc5f3 [file] [log] [blame]
Gilles Peskinee59236f2018-01-27 23:32:46 +01001/*
2 * PSA crypto layer on top of Mbed TLS crypto
3 */
Bence Szépkúti86974652020-06-15 11:59:37 +02004/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02005 * Copyright The Mbed TLS Contributors
Dave Rodgman7ff79652023-11-03 12:04:52 +00006 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskinee59236f2018-01-27 23:32:46 +01007 */
8
Gilles Peskinedb09ef62020-06-03 01:43:33 +02009#include "common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010010
11#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030012
John Durkop07cc04a2020-11-16 22:08:34 -080013#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
14#include "check_crypto_config.h"
15#endif
16
Gilles Peskinee59236f2018-01-27 23:32:46 +010017#include "psa/crypto.h"
18
Ronald Crond6d28882020-12-14 14:56:02 +010019#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010020#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010021#include "psa_crypto_invasive.h"
Steven Cooremancd84cb42020-07-16 20:28:36 +020022#include "psa_crypto_driver_wrappers.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010023#include "psa_crypto_ecp.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010024#include "psa_crypto_hash.h"
Steven Cooreman32d56942021-03-19 17:39:17 +010025#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010026#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010027#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020028#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020029#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020030#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010031#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010032/* Include internal declarations that are useful for implementing persistently
33 * stored keys. */
34#include "psa_crypto_storage.h"
35
Gilles Peskineb2b64d32020-12-14 16:43:58 +010036#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010037
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010038#include <stdlib.h>
39#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010040#include "mbedtls/platform.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010041
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010042#include "mbedtls/aes.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010043#include "mbedtls/arc4.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020044#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000045#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020046#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010047#include "mbedtls/blowfish.h"
48#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020049#include "mbedtls/chacha20.h"
50#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010051#include "mbedtls/cipher.h"
52#include "mbedtls/ccm.h"
53#include "mbedtls/cmac.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010054#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020055#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010056#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010057#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010058#include "mbedtls/error.h"
59#include "mbedtls/gcm.h"
60#include "mbedtls/md2.h"
61#include "mbedtls/md4.h"
62#include "mbedtls/md5.h"
Gilles Peskine20035e32018-02-03 22:44:14 +010063#include "mbedtls/md.h"
64#include "mbedtls/md_internal.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010065#include "mbedtls/pk.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010066#include "mbedtls/pk_internal.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010067#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000068#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010069#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010070#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010071#include "mbedtls/sha1.h"
72#include "mbedtls/sha256.h"
73#include "mbedtls/sha512.h"
74#include "mbedtls/xtea.h"
75
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010076#define ARRAY_LENGTH(array) (sizeof(array) / sizeof(*(array)))
Gilles Peskine996deb12018-08-01 15:45:45 +020077
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010078/****************************************************************/
79/* Global data, support functions and library management */
80/****************************************************************/
81
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010082static int key_type_is_raw_bytes(psa_key_type_t type)
Gilles Peskine48c0ea12018-06-21 14:15:31 +020083{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010084 return PSA_KEY_TYPE_IS_UNSTRUCTURED(type);
Gilles Peskine48c0ea12018-06-21 14:15:31 +020085}
86
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010087/* Values for psa_global_data_t::rng_state */
88#define RNG_NOT_INITIALIZED 0
89#define RNG_INITIALIZED 1
90#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +010091
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010092typedef struct {
Gilles Peskinec6b69072018-11-20 21:42:52 +010093 unsigned initialized : 1;
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010094 unsigned rng_state : 2;
Gilles Peskineb8006a62021-11-08 22:20:03 +010095 mbedtls_psa_random_context_t rng;
Gilles Peskinee59236f2018-01-27 23:32:46 +010096} psa_global_data_t;
97
98static psa_global_data_t global_data;
99
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100100#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
101mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
102 &global_data.rng.drbg;
103#endif
104
itayzafrir0adf0fc2018-09-06 16:24:41 +0300105#define GUARD_MODULE_INITIALIZED \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100106 if (global_data.initialized == 0) \
107 return PSA_ERROR_BAD_STATE;
itayzafrir0adf0fc2018-09-06 16:24:41 +0300108
David Horstmannc0a2c302023-11-29 17:24:08 +0000109#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
David Horstmann926193a2023-12-13 15:55:25 +0000110
David Horstmannb80e35a2023-12-14 18:12:47 +0000111/* Declare a local copy of an input buffer and a variable that will be used
112 * to store a pointer to the start of the buffer.
David Horstmann926193a2023-12-13 15:55:25 +0000113 *
114 * Note: This macro must be called before any operations which may jump to
115 * the exit label, so that the local input copy object is safe to be freed.
116 *
117 * Assumptions:
118 * - input is the name of a pointer to the buffer to be copied
119 * - The name LOCAL_INPUT_COPY_OF_input is unused in the current scope
David Horstmannb80e35a2023-12-14 18:12:47 +0000120 * - input_copy_name is a name that is unused in the current scope
David Horstmann926193a2023-12-13 15:55:25 +0000121 */
David Horstmannb80e35a2023-12-14 18:12:47 +0000122#define LOCAL_INPUT_DECLARE(input, input_copy_name) \
123 psa_crypto_local_input_t LOCAL_INPUT_COPY_OF_##input = PSA_CRYPTO_LOCAL_INPUT_INIT; \
124 const uint8_t *input_copy_name = NULL;
David Horstmann926193a2023-12-13 15:55:25 +0000125
David Horstmannb80e35a2023-12-14 18:12:47 +0000126/* Allocate a copy of the buffer input and set the pointer input_copy to
127 * point to the start of the copy.
David Horstmann926193a2023-12-13 15:55:25 +0000128 *
David Horstmann34980bd2023-11-29 17:07:13 +0000129 * Assumptions:
130 * - psa_status_t status exists
131 * - An exit label is declared
David Horstmann926193a2023-12-13 15:55:25 +0000132 * - input is the name of a pointer to the buffer to be copied
David Horstmannb80e35a2023-12-14 18:12:47 +0000133 * - LOCAL_INPUT_DECLARE(input, input_copy) has previously been called
David Horstmann34980bd2023-11-29 17:07:13 +0000134 */
David Horstmannb80e35a2023-12-14 18:12:47 +0000135#define LOCAL_INPUT_ALLOC(input, length, input_copy) \
David Horstmann926193a2023-12-13 15:55:25 +0000136 status = psa_crypto_local_input_alloc(input, length, \
137 &LOCAL_INPUT_COPY_OF_##input); \
David Horstmann34980bd2023-11-29 17:07:13 +0000138 if (status != PSA_SUCCESS) { \
139 goto exit; \
140 } \
David Horstmannb80e35a2023-12-14 18:12:47 +0000141 input_copy = LOCAL_INPUT_COPY_OF_##input.buffer;
David Horstmann34980bd2023-11-29 17:07:13 +0000142
David Horstmann926193a2023-12-13 15:55:25 +0000143/* Free the local input copy allocated previously by LOCAL_INPUT_ALLOC()
144 *
David Horstmann1f532132023-12-08 14:08:18 +0000145 * Assumptions:
David Horstmannb80e35a2023-12-14 18:12:47 +0000146 * - input_copy is the name of the input copy pointer set by LOCAL_INPUT_ALLOC()
David Horstmann926193a2023-12-13 15:55:25 +0000147 * - input is the name of the original buffer that was copied
David Horstmann1f532132023-12-08 14:08:18 +0000148 */
David Horstmannb80e35a2023-12-14 18:12:47 +0000149#define LOCAL_INPUT_FREE(input, input_copy) \
150 input_copy = NULL; \
David Horstmann926193a2023-12-13 15:55:25 +0000151 psa_crypto_local_input_free(&LOCAL_INPUT_COPY_OF_##input);
David Horstmann34980bd2023-11-29 17:07:13 +0000152
David Horstmannb80e35a2023-12-14 18:12:47 +0000153/* Declare a local copy of an output buffer and a variable that will be used
154 * to store a pointer to the start of the buffer.
David Horstmann926193a2023-12-13 15:55:25 +0000155 *
156 * Note: This macro must be called before any operations which may jump to
157 * the exit label, so that the local output copy object is safe to be freed.
158 *
159 * Assumptions:
160 * - output is the name of a pointer to the buffer to be copied
161 * - The name LOCAL_OUTPUT_COPY_OF_output is unused in the current scope
David Horstmannb80e35a2023-12-14 18:12:47 +0000162 * - output_copy_name is a name that is unused in the current scope
David Horstmann926193a2023-12-13 15:55:25 +0000163 */
David Horstmannb80e35a2023-12-14 18:12:47 +0000164#define LOCAL_OUTPUT_DECLARE(output, output_copy_name) \
165 psa_crypto_local_output_t LOCAL_OUTPUT_COPY_OF_##output = PSA_CRYPTO_LOCAL_OUTPUT_INIT; \
166 uint8_t *output_copy_name = NULL;
David Horstmann926193a2023-12-13 15:55:25 +0000167
David Horstmannb80e35a2023-12-14 18:12:47 +0000168/* Allocate a copy of the buffer output and set the pointer output_copy to
169 * point to the start of the copy.
David Horstmann926193a2023-12-13 15:55:25 +0000170 *
David Horstmann34980bd2023-11-29 17:07:13 +0000171 * Assumptions:
172 * - psa_status_t status exists
173 * - An exit label is declared
David Horstmann926193a2023-12-13 15:55:25 +0000174 * - output is the name of a pointer to the buffer to be copied
David Horstmannb80e35a2023-12-14 18:12:47 +0000175 * - LOCAL_OUTPUT_DECLARE(output, output_copy) has previously been called
David Horstmann34980bd2023-11-29 17:07:13 +0000176 */
David Horstmannb80e35a2023-12-14 18:12:47 +0000177#define LOCAL_OUTPUT_ALLOC(output, length, output_copy) \
David Horstmann926193a2023-12-13 15:55:25 +0000178 status = psa_crypto_local_output_alloc(output, length, \
179 &LOCAL_OUTPUT_COPY_OF_##output); \
David Horstmann34980bd2023-11-29 17:07:13 +0000180 if (status != PSA_SUCCESS) { \
181 goto exit; \
182 } \
David Horstmannb80e35a2023-12-14 18:12:47 +0000183 output_copy = LOCAL_OUTPUT_COPY_OF_##output.buffer;
David Horstmann34980bd2023-11-29 17:07:13 +0000184
Gabor Mezei3b0c3712024-01-24 13:07:17 +0100185/* Allocate a copy of the buffer output and set the pointer output_copy to
186 * point to the start of the copy.
187 *
188 * Assumptions:
189 * - psa_status_t status exists
190 * - An exit label is declared
191 * - output is the name of a pointer to the buffer to be copied
192 * - LOCAL_OUTPUT_DECLARE(output, output_copy) has previously been called
193 */
194#define LOCAL_OUTPUT_ALLOC_WITH_COPY(output, length, output_copy) \
195 status = psa_crypto_local_output_alloc_with_copy(output, length, \
196 &LOCAL_OUTPUT_COPY_OF_##output); \
197 if (status != PSA_SUCCESS) { \
198 goto exit; \
199 } \
200 output_copy = LOCAL_OUTPUT_COPY_OF_##output.buffer;
201
David Horstmannb80e35a2023-12-14 18:12:47 +0000202/* Free the local output copy allocated previously by LOCAL_OUTPUT_ALLOC()
David Horstmann1f532132023-12-08 14:08:18 +0000203 * after first copying back its contents to the original buffer.
David Horstmann926193a2023-12-13 15:55:25 +0000204 *
David Horstmann1f532132023-12-08 14:08:18 +0000205 * Assumptions:
David Horstmann1f532132023-12-08 14:08:18 +0000206 * - psa_status_t status exists
David Horstmannb80e35a2023-12-14 18:12:47 +0000207 * - output_copy is the name of the output copy pointer set by LOCAL_OUTPUT_ALLOC()
208 * - output is the name of the original buffer that was copied
David Horstmann1f532132023-12-08 14:08:18 +0000209 */
David Horstmannb80e35a2023-12-14 18:12:47 +0000210#define LOCAL_OUTPUT_FREE(output, output_copy) \
211 output_copy = NULL; \
David Horstmann2b70a662023-12-13 14:09:08 +0000212 do { \
213 psa_status_t local_output_status; \
David Horstmann926193a2023-12-13 15:55:25 +0000214 local_output_status = psa_crypto_local_output_free(&LOCAL_OUTPUT_COPY_OF_##output); \
David Horstmann2b70a662023-12-13 14:09:08 +0000215 if (local_output_status != PSA_SUCCESS) { \
216 /* Since this error case is an internal error, it's more serious than \
217 * any existing error code and so it's fine to overwrite the existing \
218 * status. */ \
219 status = local_output_status; \
220 } \
221 } while (0)
David Horstmannc0a2c302023-11-29 17:24:08 +0000222#else /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
David Horstmannb80e35a2023-12-14 18:12:47 +0000223#define LOCAL_INPUT_DECLARE(input, input_copy_name) \
224 const uint8_t *input_copy_name = NULL;
225#define LOCAL_INPUT_ALLOC(input, length, input_copy) \
226 input_copy = input;
227#define LOCAL_INPUT_FREE(input, input_copy) \
228 input_copy = NULL;
229#define LOCAL_OUTPUT_DECLARE(output, output_copy_name) \
230 uint8_t *output_copy_name = NULL;
231#define LOCAL_OUTPUT_ALLOC(output, length, output_copy) \
232 output_copy = output;
233#define LOCAL_OUTPUT_FREE(output, output_copy) \
234 output_copy = NULL;
David Horstmannc0a2c302023-11-29 17:24:08 +0000235#endif /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
David Horstmann34980bd2023-11-29 17:07:13 +0000236
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100237psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100238{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100239 /* Mbed TLS error codes can combine a high-level error code and a
240 * low-level error code. The low-level error usually reflects the
241 * root cause better, so dispatch on that preferably. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100242 int low_level_ret = -(-ret & 0x007f);
243 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100244 case 0:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100245 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100246
247 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
248 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
249 case MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100250 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100251 case MBEDTLS_ERR_AES_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100252 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100253
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200254 case MBEDTLS_ERR_ARC4_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100255 return PSA_ERROR_HARDWARE_FAILURE;
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200256
Gilles Peskine9a944802018-06-21 09:35:35 +0200257 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
258 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
259 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
260 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
261 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100262 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200263 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100264 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200265 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100266 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskine9a944802018-06-21 09:35:35 +0200267
Jaeden Amero93e21112019-02-20 13:57:28 +0000268#if defined(MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000269 case MBEDTLS_ERR_BLOWFISH_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000270#elif defined(MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH)
271 case MBEDTLS_ERR_BLOWFISH_INVALID_KEY_LENGTH:
272#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100273 case MBEDTLS_ERR_BLOWFISH_INVALID_INPUT_LENGTH:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100274 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100275 case MBEDTLS_ERR_BLOWFISH_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100276 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100277
Jaeden Amero93e21112019-02-20 13:57:28 +0000278#if defined(MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000279 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Jaeden Amero93e21112019-02-20 13:57:28 +0000280#elif defined(MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH)
281 case MBEDTLS_ERR_CAMELLIA_INVALID_KEY_LENGTH:
282#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100283 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100284 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100285 case MBEDTLS_ERR_CAMELLIA_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100286 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100287
288 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100289 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100290 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100291 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100292 case MBEDTLS_ERR_CCM_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100293 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100294
Gilles Peskine26869f22019-05-06 15:25:00 +0200295 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100296 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine26869f22019-05-06 15:25:00 +0200297
298 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100299 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200300 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100301 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200302
Gilles Peskinea5905292018-02-07 20:59:33 +0100303 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100304 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100305 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100306 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100307 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100308 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100309 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100310 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100311 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100312 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100313 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100314 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100315 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100316 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100317 case MBEDTLS_ERR_CIPHER_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100318 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100319
320 case MBEDTLS_ERR_CMAC_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100321 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100322
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100323#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
324 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100325 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
326 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100327 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100328 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100329 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
330 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100331 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100332 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100333 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100334#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100335
336 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100337 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100338 case MBEDTLS_ERR_DES_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100339 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100340
Gilles Peskinee59236f2018-01-27 23:32:46 +0100341 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
342 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
343 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100344 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100345
346 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100347 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100348 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100349 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100350 case MBEDTLS_ERR_GCM_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100351 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100352
Gilles Peskine82e57d12020-11-13 21:31:17 +0100353#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100354 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100355 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
356 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100357 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100358 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100359 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
360 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100361 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100362 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100363 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100364#endif
365
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200366 case MBEDTLS_ERR_MD2_HW_ACCEL_FAILED:
367 case MBEDTLS_ERR_MD4_HW_ACCEL_FAILED:
368 case MBEDTLS_ERR_MD5_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100369 return PSA_ERROR_HARDWARE_FAILURE;
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200370
Gilles Peskinea5905292018-02-07 20:59:33 +0100371 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100372 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100373 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100374 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100375 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100376 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100377 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100378 return PSA_ERROR_STORAGE_FAILURE;
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200379 case MBEDTLS_ERR_MD_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100380 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100381
Gilles Peskinef76aa772018-10-29 19:24:33 +0100382 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100383 return PSA_ERROR_STORAGE_FAILURE;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100384 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100385 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100386 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100387 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100388 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100389 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100390 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100391 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100392 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100393 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100394 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100395 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100396 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100397 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100398
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100399 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100400 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100401 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
402 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100403 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100404 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100405 return PSA_ERROR_STORAGE_FAILURE;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100406 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
407 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100408 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100409 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100410 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100411 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
412 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100413 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100414 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100415 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100416 case MBEDTLS_ERR_PK_INVALID_ALG:
417 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
418 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100419 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100420 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100421 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100422 case MBEDTLS_ERR_PK_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100423 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100424
Gilles Peskineff2d2002019-05-06 15:26:23 +0200425 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100426 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200427 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100428 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200429
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200430 case MBEDTLS_ERR_RIPEMD160_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100431 return PSA_ERROR_HARDWARE_FAILURE;
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200432
Gilles Peskinea5905292018-02-07 20:59:33 +0100433 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100434 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100435 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100436 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100437 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100438 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100439 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100440 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100441 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
442 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100443 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100444 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100445 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100446 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100447 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100448 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100449 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100450 case MBEDTLS_ERR_RSA_UNSUPPORTED_OPERATION:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100451 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100452 case MBEDTLS_ERR_RSA_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100453 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100454
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200455 case MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED:
456 case MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED:
457 case MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100458 return PSA_ERROR_HARDWARE_FAILURE;
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200459
Gilles Peskinea5905292018-02-07 20:59:33 +0100460 case MBEDTLS_ERR_XTEA_INVALID_INPUT_LENGTH:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100461 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100462 case MBEDTLS_ERR_XTEA_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100463 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100464
itayzafrir5c753392018-05-08 11:18:38 +0300465 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300466 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100467 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300468 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100469 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300470 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100471 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300472 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
473 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100474 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300475 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100476 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100477 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100478 return PSA_ERROR_INSUFFICIENT_ENTROPY;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300479 case MBEDTLS_ERR_ECP_HW_ACCEL_FAILED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100480 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskine40d81602020-11-25 00:09:47 +0100481
Janos Follatha13b9052019-11-22 12:48:59 +0000482 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100483 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300484
Gilles Peskinee59236f2018-01-27 23:32:46 +0100485 default:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100486 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100487 }
488}
489
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200490
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200491
492
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100493/****************************************************************/
494/* Key management */
495/****************************************************************/
496
John Durkop9814fa22020-11-04 12:28:15 -0800497#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
John Durkop6ba40d12020-11-10 08:50:04 -0800498 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) || \
Ronald Cron9ecdd972021-11-19 18:02:34 +0100499 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
500 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) || \
501 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100502mbedtls_ecp_group_id mbedtls_ecc_group_of_psa(psa_ecc_family_t curve,
503 size_t bits,
504 int bits_is_sloppy)
Gilles Peskine12313cd2018-06-20 00:20:32 +0200505{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100506 switch (curve) {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100507 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100508 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100509#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100510 case 192:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100511 return MBEDTLS_ECP_DP_SECP192R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100512#endif
513#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100514 case 224:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100515 return MBEDTLS_ECP_DP_SECP224R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100516#endif
517#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100518 case 256:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100519 return MBEDTLS_ECP_DP_SECP256R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100520#endif
521#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100522 case 384:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100523 return MBEDTLS_ECP_DP_SECP384R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100524#endif
525#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100526 case 521:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100527 return MBEDTLS_ECP_DP_SECP521R1;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100528 case 528:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100529 if (bits_is_sloppy) {
530 return MBEDTLS_ECP_DP_SECP521R1;
531 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100532 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100533#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100534 }
535 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100536
Paul Elliott8ff510a2020-06-02 17:19:28 +0100537 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100538 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100539#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100540 case 256:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100541 return MBEDTLS_ECP_DP_BP256R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100542#endif
543#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100544 case 384:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100545 return MBEDTLS_ECP_DP_BP384R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100546#endif
547#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100548 case 512:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100549 return MBEDTLS_ECP_DP_BP512R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100550#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100551 }
552 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100553
Paul Elliott8ff510a2020-06-02 17:19:28 +0100554 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100555 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100556#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100557 case 255:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100558 return MBEDTLS_ECP_DP_CURVE25519;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100559 case 256:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100560 if (bits_is_sloppy) {
561 return MBEDTLS_ECP_DP_CURVE25519;
562 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100563 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100564#endif
565#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100566 case 448:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100567 return MBEDTLS_ECP_DP_CURVE448;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100568#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100569 }
570 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100571
Paul Elliott8ff510a2020-06-02 17:19:28 +0100572 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100573 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100574#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100575 case 192:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100576 return MBEDTLS_ECP_DP_SECP192K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100577#endif
578#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100579 case 224:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100580 return MBEDTLS_ECP_DP_SECP224K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100581#endif
582#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100583 case 256:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100584 return MBEDTLS_ECP_DP_SECP256K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100585#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100586 }
587 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200588 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100589
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100590 (void) bits_is_sloppy;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100591 return MBEDTLS_ECP_DP_NONE;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200592}
John Durkop9814fa22020-11-04 12:28:15 -0800593#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
Ronald Cron9ecdd972021-11-19 18:02:34 +0100594 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) ||
595 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
596 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) ||
597 defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH) */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200598
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100599static psa_status_t validate_unstructured_key_bit_size(psa_key_type_t type,
600 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200601{
602 /* Check that the bit size is acceptable for the key type */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100603 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200604 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200605 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200606 case PSA_KEY_TYPE_DERIVE:
607 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100608#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200609 case PSA_KEY_TYPE_AES:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100610 if (bits != 128 && bits != 192 && bits != 256) {
611 return PSA_ERROR_INVALID_ARGUMENT;
612 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200613 break;
614#endif
Gilles Peskine8890f642021-09-21 11:59:39 +0200615#if defined(PSA_WANT_KEY_TYPE_ARIA)
616 case PSA_KEY_TYPE_ARIA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100617 if (bits != 128 && bits != 192 && bits != 256) {
618 return PSA_ERROR_INVALID_ARGUMENT;
619 }
Gilles Peskine8890f642021-09-21 11:59:39 +0200620 break;
621#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100622#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200623 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100624 if (bits != 128 && bits != 192 && bits != 256) {
625 return PSA_ERROR_INVALID_ARGUMENT;
626 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200627 break;
628#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100629#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200630 case PSA_KEY_TYPE_DES:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100631 if (bits != 64 && bits != 128 && bits != 192) {
632 return PSA_ERROR_INVALID_ARGUMENT;
633 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200634 break;
635#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100636#if defined(PSA_WANT_KEY_TYPE_ARC4)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200637 case PSA_KEY_TYPE_ARC4:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100638 if (bits < 8 || bits > 2048) {
639 return PSA_ERROR_INVALID_ARGUMENT;
640 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200641 break;
642#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100643#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200644 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100645 if (bits != 256) {
646 return PSA_ERROR_INVALID_ARGUMENT;
647 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200648 break;
649#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200650 default:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100651 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200652 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100653 if (bits % 8 != 0) {
654 return PSA_ERROR_INVALID_ARGUMENT;
655 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200656
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100657 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200658}
659
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100660/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100661 *
Steven Cooremancd640932021-03-08 12:00:27 +0100662 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
663 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100664 *
665 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100666 * \param[in] key_type The key type of the key to be used with the
667 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100668 *
669 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100670 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100671 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100672 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100673 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100674MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100675 psa_algorithm_t algorithm,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100676 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100677{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100678 if (PSA_ALG_IS_HMAC(algorithm)) {
679 if (key_type == PSA_KEY_TYPE_HMAC) {
680 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100681 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100682 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100683
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100684 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
685 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
686 * key. */
687 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
688 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
689 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
690 * the block length (larger than 1) for block ciphers. */
691 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
692 return PSA_SUCCESS;
693 }
694 }
695 }
696
697 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100698}
699
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100700psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
701 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200702{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100703 if (slot->key.data != NULL) {
704 return PSA_ERROR_ALREADY_EXISTS;
705 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200706
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100707 slot->key.data = mbedtls_calloc(1, buffer_length);
708 if (slot->key.data == NULL) {
709 return PSA_ERROR_INSUFFICIENT_MEMORY;
710 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200711
Ronald Cronea0f8a62020-11-25 17:52:23 +0100712 slot->key.bytes = buffer_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100713 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200714}
715
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100716psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
717 const uint8_t *data,
718 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200719{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100720 psa_status_t status = psa_allocate_buffer_to_slot(slot,
721 data_length);
722 if (status != PSA_SUCCESS) {
723 return status;
724 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200725
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100726 memcpy(slot->key.data, data, data_length);
727 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200728}
729
Ronald Crona0fe59f2020-11-29 11:14:53 +0100730psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100731 const psa_key_attributes_t *attributes,
732 const uint8_t *data, size_t data_length,
733 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100734 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100735{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100736 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
737 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100738
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200739 /* zero-length keys are never supported. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100740 if (data_length == 0) {
741 return PSA_ERROR_NOT_SUPPORTED;
742 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200743
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100744 if (key_type_is_raw_bytes(type)) {
745 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200746
Steven Cooreman75b74362020-07-28 14:30:13 +0200747 /* Ensure that the bytes-to-bits conversion hasn't overflown. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100748 if (data_length > SIZE_MAX / 8) {
749 return PSA_ERROR_NOT_SUPPORTED;
750 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200751
Gilles Peskine1b9505c2019-08-07 10:59:45 +0200752 /* Enforce a size limit, and in particular ensure that the bit
753 * size fits in its representation type. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100754 if ((*bits) > PSA_MAX_KEY_BITS) {
755 return PSA_ERROR_NOT_SUPPORTED;
756 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200757
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100758 status = validate_unstructured_key_bit_size(type, *bits);
759 if (status != PSA_SUCCESS) {
760 return status;
761 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200762
Ronald Crondd04d422020-11-28 15:14:42 +0100763 /* Copy the key material. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100764 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100765 *key_buffer_length = data_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100766 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200767
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100768 return PSA_SUCCESS;
769 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
John Durkop9814fa22020-11-04 12:28:15 -0800770#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100771 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
772 if (PSA_KEY_TYPE_IS_ECC(type)) {
773 return mbedtls_psa_ecp_import_key(attributes,
774 data, data_length,
775 key_buffer, key_buffer_size,
776 key_buffer_length,
777 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100778 }
John Durkop9814fa22020-11-04 12:28:15 -0800779#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
780 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
John Durkop0e005192020-10-31 22:06:54 -0700781#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100782 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
783 if (PSA_KEY_TYPE_IS_RSA(type)) {
784 return mbedtls_psa_rsa_import_key(attributes,
785 data, data_length,
786 key_buffer, key_buffer_size,
787 key_buffer_length,
788 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200789 }
John Durkop9814fa22020-11-04 12:28:15 -0800790#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
791 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100792 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100793
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100794 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100795}
796
Gilles Peskinef603c712019-01-19 13:40:11 +0100797/** Calculate the intersection of two algorithm usage policies.
798 *
799 * Return 0 (which allows no operation) on incompatibility.
800 */
801static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100802 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100803 psa_algorithm_t alg1,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100804 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100805{
Gilles Peskine549ea862019-05-22 11:45:59 +0200806 /* Common case: both sides actually specify the same policy. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100807 if (alg1 == alg2) {
808 return alg1;
809 }
Steven Cooreman03488022021-02-18 12:07:20 +0100810 /* If the policies are from the same hash-and-sign family, check
811 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100812 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
813 PSA_ALG_IS_SIGN_HASH(alg2) &&
814 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
815 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
816 return alg2;
817 }
818 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
819 return alg1;
820 }
Steven Cooreman03488022021-02-18 12:07:20 +0100821 }
822 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100823 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100824 * restrictive tag length. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100825 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
826 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
827 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
828 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
829 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100830 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100831
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100832 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100833 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
834 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
835 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
836 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100837 }
838 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100839 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
840 (alg1_len <= alg2_len)) {
841 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100842 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100843 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
844 (alg2_len <= alg1_len)) {
845 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100846 }
847 }
848 /* If the policies are from the same MAC family, check whether one
849 * of them is a minimum-MAC-length policy. Calculate the most
850 * restrictive tag length. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100851 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
852 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
853 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100854 /* Validate the combination of key type and algorithm. Since the base
855 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100856 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
857 return 0;
858 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100859
Steven Cooreman31a876d2021-03-03 20:47:40 +0100860 /* Get the (exact or at-least) output lengths for both sides of the
861 * requested intersection. None of the currently supported algorithms
862 * have an output length dependent on the actual key size, so setting it
863 * to a bogus value of 0 is currently OK.
864 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100865 * Note that for at-least-this-length wildcard algorithms, the output
866 * length is set to the shortest allowed length, which allows us to
867 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100868 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
869 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100870 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100871
Steven Cooremana1d83222021-02-25 10:20:29 +0100872 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100873 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
874 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
875 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100876 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100877
878 /* If only one is an at-least-this-length policy, the intersection would
879 * be the other (fixed-length) policy as long as said fixed length is
880 * equal to or larger than the shortest allowed length. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100881 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
882 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100883 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100884 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
885 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100886 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100887
Steven Cooremancd640932021-03-08 12:00:27 +0100888 /* If none of them are wildcards, check whether they define the same tag
889 * length. This is still possible here when one is default-length and
890 * the other specific-length. Ensure to always return the
891 * specific-length version for the intersection. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100892 if (alg1_len == alg2_len) {
893 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
894 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100895 }
896 /* If the policies are incompatible, allow nothing. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100897 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100898}
899
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100900static int psa_key_algorithm_permits(psa_key_type_t key_type,
901 psa_algorithm_t policy_alg,
902 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200903{
Gilles Peskine549ea862019-05-22 11:45:59 +0200904 /* Common case: the policy only allows requested_alg. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100905 if (requested_alg == policy_alg) {
906 return 1;
907 }
Steven Cooreman03488022021-02-18 12:07:20 +0100908 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
909 * and requested_alg is the same hash-and-sign family with any hash,
910 * then requested_alg is compliant with policy_alg. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100911 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
912 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
913 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
914 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100915 }
916 /* If policy_alg is a wildcard AEAD algorithm of the same base as
917 * the requested algorithm, check the requested tag length to be
918 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100919 if (PSA_ALG_IS_AEAD(policy_alg) &&
920 PSA_ALG_IS_AEAD(requested_alg) &&
921 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
922 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
923 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
924 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
925 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100926 }
Steven Cooremancd640932021-03-08 12:00:27 +0100927 /* If policy_alg is a MAC algorithm of the same base as the requested
928 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100929 if (PSA_ALG_IS_MAC(policy_alg) &&
930 PSA_ALG_IS_MAC(requested_alg) &&
931 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
932 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100933 /* Validate the combination of key type and algorithm. Since the policy
934 * and requested algorithms are the same, we only need this once. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100935 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
936 return 0;
937 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100938
Steven Cooreman31a876d2021-03-03 20:47:40 +0100939 /* Get both the requested output length for the algorithm which is to be
940 * verified, and the default output length for the base algorithm.
941 * Note that none of the currently supported algorithms have an output
942 * length dependent on actual key size, so setting it to a bogus value
943 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100944 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100945 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100946 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100947 key_type, 0,
948 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100949
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100950 /* If the policy is default-length, only allow an algorithm with
951 * a declared exact-length matching the default. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100952 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
953 return requested_output_length == default_output_length;
954 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100955
956 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100957 * length exactly matches the default length. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100958 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
959 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
960 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100961 }
962
Steven Cooremancd640932021-03-08 12:00:27 +0100963 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
964 * check for the requested MAC length to be equal to or longer than the
965 * minimum allowed length. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100966 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
967 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
968 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100969 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200970 }
Steven Cooremance48e852020-10-05 16:02:45 +0200971 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200972 * a key derivation with that key agreement should also be allowed. This
973 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100974 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
975 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
976 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
977 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +0200978 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100979 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100980 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200981}
982
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100983/** Test whether a policy permits an algorithm.
984 *
985 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100986 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100987 * \note This function requires providing the key type for which the policy is
988 * being validated, since some algorithm policy definitions (e.g. MAC)
989 * have different properties depending on what kind of cipher it is
990 * combined with.
991 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100992 * \retval PSA_SUCCESS When \p alg is a specific algorithm
993 * allowed by the \p policy.
994 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
995 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
996 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100997 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100998static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
999 psa_key_type_t key_type,
1000 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001001{
Steven Cooremand788fab2021-02-25 11:29:17 +01001002 /* '0' is not a valid algorithm */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001003 if (alg == 0) {
1004 return PSA_ERROR_INVALID_ARGUMENT;
1005 }
Steven Cooremand788fab2021-02-25 11:29:17 +01001006
Steven Cooreman7e39f052021-02-23 14:18:32 +01001007 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001008 if (PSA_ALG_IS_WILDCARD(alg)) {
1009 return PSA_ERROR_INVALID_ARGUMENT;
1010 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001011
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001012 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
1013 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
1014 return PSA_SUCCESS;
1015 } else {
1016 return PSA_ERROR_NOT_PERMITTED;
1017 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001018}
1019
Gilles Peskinef603c712019-01-19 13:40:11 +01001020/** Restrict a key policy based on a constraint.
1021 *
Steven Cooreman5a172672021-03-02 21:27:42 +01001022 * \note This function requires providing the key type for which the policy is
1023 * being restricted, since some algorithm policy definitions (e.g. MAC)
1024 * have different properties depending on what kind of cipher it is
1025 * combined with.
1026 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001027 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +01001028 * \param[in,out] policy The policy to restrict.
1029 * \param[in] constraint The policy constraint to apply.
1030 *
1031 * \retval #PSA_SUCCESS
1032 * \c *policy contains the intersection of the original value of
1033 * \c *policy and \c *constraint.
1034 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001035 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +01001036 * \c *policy is unchanged.
1037 */
1038static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001039 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +01001040 psa_key_policy_t *policy,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001041 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +01001042{
1043 psa_algorithm_t intersection_alg =
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001044 psa_key_policy_algorithm_intersection(key_type, policy->alg,
1045 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +02001046 psa_algorithm_t intersection_alg2 =
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001047 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
1048 constraint->alg2);
1049 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
1050 return PSA_ERROR_INVALID_ARGUMENT;
1051 }
1052 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
1053 return PSA_ERROR_INVALID_ARGUMENT;
1054 }
Gilles Peskinef603c712019-01-19 13:40:11 +01001055 policy->usage &= constraint->usage;
1056 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001057 policy->alg2 = intersection_alg2;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001058 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +01001059}
1060
Ronald Cron5c522922020-11-14 16:35:34 +01001061/** Get the description of a key given its identifier and policy constraints
1062 * and lock it.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001063 *
Ronald Cron5c522922020-11-14 16:35:34 +01001064 * The key must have allow all the usage flags set in \p usage. If \p alg is
Steven Cooremand788fab2021-02-25 11:29:17 +01001065 * nonzero, the key must allow operations with this algorithm. If \p alg is
1066 * zero, the algorithm is not checked.
Ronald Cron7587ae42020-11-11 15:04:25 +01001067 *
Ronald Cron5c522922020-11-14 16:35:34 +01001068 * In case of a persistent key, the function loads the description of the key
1069 * into a key slot if not already done.
1070 *
1071 * On success, the returned key slot is locked. It is the responsibility of
1072 * the caller to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001073 */
Ronald Cron5c522922020-11-14 16:35:34 +01001074static psa_status_t psa_get_and_lock_key_slot_with_policy(
1075 mbedtls_svc_key_id_t key,
1076 psa_key_slot_t **p_slot,
1077 psa_key_usage_t usage,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001078 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +01001079{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001080 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1081 psa_key_slot_t *slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001082
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001083 status = psa_get_and_lock_key_slot(key, p_slot);
1084 if (status != PSA_SUCCESS) {
1085 return status;
1086 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001087 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001088
1089 /* Enforce that usage policy for the key slot contains all the flags
1090 * required by the usage parameter. There is one exception: public
1091 * keys can always be exported, so we treat public key objects as
1092 * if they had the export flag. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001093 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +01001094 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001095 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001096
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001097 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +01001098 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001099 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001100 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001101
Shaun Case0e7791f2021-12-20 21:14:10 -08001102 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001103 if (alg != 0) {
1104 status = psa_key_policy_permits(&slot->attr.policy,
1105 slot->attr.type,
1106 alg);
1107 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +01001108 goto error;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001109 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001110 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001111
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001112 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001113
1114error:
1115 *p_slot = NULL;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001116 psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001117
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001118 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +01001119}
Darryl Green940d72c2018-07-13 13:18:51 +01001120
Ronald Cron5c522922020-11-14 16:35:34 +01001121/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001122 *
1123 * A transparent key is a key for which the key material is directly
Ronald Cron8a0466a2021-08-24 15:39:44 +02001124 * available, as opposed to a key in a secure element and/or to be used
1125 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001126 *
Ronald Cron8a0466a2021-08-24 15:39:44 +02001127 * This is a temporary function that may be used instead of
1128 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
1129 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001130 *
Ronald Cron5c522922020-11-14 16:35:34 +01001131 * On success, the returned key slot is locked. It is the responsibility of the
1132 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001133 */
Ronald Cron5c522922020-11-14 16:35:34 +01001134static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1135 mbedtls_svc_key_id_t key,
1136 psa_key_slot_t **p_slot,
1137 psa_key_usage_t usage,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001138 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +02001139{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001140 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
1141 usage, alg);
1142 if (status != PSA_SUCCESS) {
1143 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001144 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001145
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001146 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
1147 psa_unlock_key_slot(*p_slot);
1148 *p_slot = NULL;
1149 return PSA_ERROR_NOT_SUPPORTED;
1150 }
1151
1152 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001153}
Gilles Peskine28f8f302019-07-24 13:30:31 +02001154
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001155psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +00001156{
Ronald Cronea0f8a62020-11-25 17:52:23 +01001157 /* Data pointer will always be either a valid pointer or NULL in an
1158 * initialized slot, so we can just free it. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001159 if (slot->key.data != NULL) {
1160 mbedtls_platform_zeroize(slot->key.data, slot->key.bytes);
1161 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001162
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001163 mbedtls_free(slot->key.data);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001164 slot->key.data = NULL;
1165 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001166
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001167 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001168}
1169
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001170/** Completely wipe a slot in memory, including its policy.
1171 * Persistent storage is not affected. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001172psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001173{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001174 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001175
1176 /*
1177 * As the return error code may not be handled in case of multiple errors,
Ronald Cron5c522922020-11-14 16:35:34 +01001178 * do our best to report an unexpected lock counter: if available
Ronald Cronddd3d052020-10-30 14:07:07 +01001179 * call MBEDTLS_PARAM_FAILED that may terminate execution (if called as
1180 * part of the execution of a test suite this will stop the test suite
Ronald Cron4640c152020-11-13 10:11:01 +01001181 * execution).
Ronald Cronddd3d052020-10-30 14:07:07 +01001182 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001183 if (slot->lock_count != 1) {
Ronald Cronddd3d052020-10-30 14:07:07 +01001184#ifdef MBEDTLS_CHECK_PARAMS
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001185 MBEDTLS_PARAM_FAILED(slot->lock_count == 1);
Ronald Cronddd3d052020-10-30 14:07:07 +01001186#endif
Ronald Cronddd3d052020-10-30 14:07:07 +01001187 status = PSA_ERROR_CORRUPTION_DETECTED;
1188 }
1189
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001190 /* Multipart operations may still be using the key. This is safe
1191 * because all multipart operation objects are independent from
1192 * the key slot: if they need to access the key after the setup
1193 * phase, they have a copy of the key. Note that this means that
1194 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001195 /* At this point, key material and other type-specific content has
1196 * been wiped. Clear remaining metadata. We can call memset and not
1197 * zeroize because the metadata is not particularly sensitive. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001198 memset(slot, 0, sizeof(*slot));
1199 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001200}
1201
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001202psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001203{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001204 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001205 psa_status_t status; /* status of the last operation */
1206 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001207#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1208 psa_se_drv_table_entry_t *driver;
1209#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001210
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001211 if (mbedtls_svc_key_id_is_null(key)) {
1212 return PSA_SUCCESS;
1213 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001214
Ronald Cronf2911112020-10-29 17:51:10 +01001215 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001216 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001217 * key, this will load the key description from persistent memory if not
1218 * done yet. We cannot avoid this loading as without it we don't know if
1219 * the key is operated by an SE or not and this information is needed by
1220 * the current implementation.
1221 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001222 status = psa_get_and_lock_key_slot(key, &slot);
1223 if (status != PSA_SUCCESS) {
1224 return status;
1225 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001226
Ronald Cronf2911112020-10-29 17:51:10 +01001227 /*
1228 * If the key slot containing the key description is under access by the
1229 * library (apart from the present access), the key cannot be destroyed
1230 * yet. For the time being, just return in error. Eventually (to be
1231 * implemented), the key should be destroyed when all accesses have
1232 * stopped.
1233 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001234 if (slot->lock_count > 1) {
1235 psa_unlock_key_slot(slot);
1236 return PSA_ERROR_GENERIC_ERROR;
Ronald Cronf2911112020-10-29 17:51:10 +01001237 }
1238
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001239 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine251c7742021-04-21 22:32:05 +02001240 /* Refuse the destruction of a read-only key (which may or may not work
1241 * if we attempt it, depending on whether the key is merely read-only
1242 * by policy or actually physically read-only).
Gilles Peskine2bfbb172021-06-07 23:27:54 +02001243 * Just do the best we can, which is to wipe the copy in memory
1244 * (done in this function's cleanup code). */
1245 overall_status = PSA_ERROR_NOT_PERMITTED;
1246 goto exit;
Gilles Peskine251c7742021-04-21 22:32:05 +02001247 }
1248
Gilles Peskine354f7672019-07-12 23:46:38 +02001249#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001250 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1251 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001252 /* For a key in a secure element, we need to do three things:
1253 * remove the key file in internal storage, destroy the
1254 * key inside the secure element, and update the driver's
1255 * persistent data. Start a transaction that will encompass these
1256 * three actions. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001257 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001258 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001259 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001260 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001261 status = psa_crypto_save_transaction();
1262 if (status != PSA_SUCCESS) {
1263 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001264 /* We should still try to destroy the key in the secure
1265 * element and the key metadata in storage. This is especially
1266 * important if the error is that the storage is full.
1267 * But how to do it exactly without risking an inconsistent
1268 * state after a reset?
1269 * https://github.com/ARMmbed/mbed-crypto/issues/215
1270 */
1271 overall_status = status;
1272 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001273 }
1274
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001275 status = psa_destroy_se_key(driver,
1276 psa_key_slot_get_slot_number(slot));
1277 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001278 overall_status = status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001279 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001280 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001281#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1282
Darryl Greend49a4992018-06-18 17:27:26 +01001283#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001284 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
1285 status = psa_destroy_persistent_key(slot->attr.id);
1286 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001287 overall_status = status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001288 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001289
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001290 /* TODO: other slots may have a copy of the same key. We should
1291 * invalidate them.
1292 * https://github.com/ARMmbed/mbed-crypto/issues/214
1293 */
Darryl Greend49a4992018-06-18 17:27:26 +01001294 }
1295#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001296
Gilles Peskinefc762652019-07-22 19:30:34 +02001297#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001298 if (driver != NULL) {
1299 status = psa_save_se_persistent_data(driver);
1300 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001301 overall_status = status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001302 }
1303 status = psa_crypto_stop_transaction();
1304 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001305 overall_status = status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001306 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001307 }
1308#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1309
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001310exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001311 status = psa_wipe_key_slot(slot);
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001312 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001313 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001314 overall_status = status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001315 }
1316 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001317}
1318
John Durkop07cc04a2020-11-16 22:08:34 -08001319#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001320 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001321static psa_status_t psa_get_rsa_public_exponent(
1322 const mbedtls_rsa_context *rsa,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001323 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001324{
1325 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001326 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001327 uint8_t *buffer = NULL;
1328 size_t buflen;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001329 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001330
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001331 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1332 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001333 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001334 }
1335 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001336 /* It's the default value, which is reported as an empty string,
1337 * so there's nothing to do. */
1338 goto exit;
1339 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001340
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001341 buflen = mbedtls_mpi_size(&mpi);
1342 buffer = mbedtls_calloc(1, buflen);
1343 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001344 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1345 goto exit;
1346 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001347 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1348 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001349 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001350 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001351 attributes->domain_parameters = buffer;
1352 attributes->domain_parameters_size = buflen;
1353
1354exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001355 mbedtls_mpi_free(&mpi);
1356 if (ret != 0) {
1357 mbedtls_free(buffer);
1358 }
1359 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001360}
John Durkop07cc04a2020-11-16 22:08:34 -08001361#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001362 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001363
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001364/** Retrieve all the publicly-accessible attributes of a key.
1365 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001366psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1367 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001368{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001369 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001370 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001371 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001372
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001373 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001374
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001375 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1376 if (status != PSA_SUCCESS) {
1377 return status;
1378 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001379
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001380 attributes->core = slot->attr;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001381 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1382 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001383
1384#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001385 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1386 psa_set_key_slot_number(attributes,
1387 psa_key_slot_get_slot_number(slot));
1388 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001389#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001390
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001391 switch (slot->attr.type) {
John Durkop07cc04a2020-11-16 22:08:34 -08001392#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
John Durkop0e005192020-10-31 22:06:54 -07001393 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001394 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001395 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001396 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001397 * is not yet implemented.
1398 * https://github.com/ARMmbed/mbed-crypto/issues/216
1399 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001400 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001401 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001402
Ronald Cron90857082020-11-25 14:58:33 +01001403 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001404 slot->attr.type,
1405 slot->key.data,
1406 slot->key.bytes,
1407 &rsa);
1408 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001409 break;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001410 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001411
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001412 status = psa_get_rsa_public_exponent(rsa,
1413 attributes);
1414 mbedtls_rsa_free(rsa);
1415 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001416 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001417 break;
John Durkop07cc04a2020-11-16 22:08:34 -08001418#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
John Durkop9814fa22020-11-04 12:28:15 -08001419 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001420 default:
1421 /* Nothing else to do. */
1422 break;
1423 }
1424
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001425 if (status != PSA_SUCCESS) {
1426 psa_reset_key_attributes(attributes);
1427 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001428
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001429 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001430
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001431 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001432}
1433
Gilles Peskinec8000c02019-08-02 20:15:51 +02001434#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1435psa_status_t psa_get_key_slot_number(
1436 const psa_key_attributes_t *attributes,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001437 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001438{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001439 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001440 *slot_number = attributes->slot_number;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001441 return PSA_SUCCESS;
1442 } else {
1443 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001444 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001445}
1446#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1447
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001448static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1449 size_t key_buffer_size,
1450 uint8_t *data,
1451 size_t data_size,
1452 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001453{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001454 if (key_buffer_size > data_size) {
1455 return PSA_ERROR_BUFFER_TOO_SMALL;
1456 }
1457 memcpy(data, key_buffer, key_buffer_size);
1458 memset(data + key_buffer_size, 0,
1459 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001460 *data_length = key_buffer_size;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001461 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001462}
1463
Ronald Cron7285cda2020-11-26 14:46:37 +01001464psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001465 const psa_key_attributes_t *attributes,
1466 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001467 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001468{
Ronald Crond18b5f82020-11-25 16:46:05 +01001469 psa_key_type_t type = attributes->core.type;
1470
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001471 if (key_type_is_raw_bytes(type) ||
1472 PSA_KEY_TYPE_IS_RSA(type) ||
1473 PSA_KEY_TYPE_IS_ECC(type)) {
1474 return psa_export_key_buffer_internal(
1475 key_buffer, key_buffer_size,
1476 data, data_size, data_length);
1477 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001478 /* This shouldn't happen in the reference implementation, but
1479 it is valid for a special-purpose implementation to omit
1480 support for exporting certain key types. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001481 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001482 }
1483}
1484
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001485psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
1486 uint8_t *data,
1487 size_t data_size,
1488 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001489{
1490 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1491 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1492 psa_key_slot_t *slot;
1493
Ronald Crone907e552021-01-18 13:22:38 +01001494 /* Reject a zero-length output buffer now, since this can never be a
1495 * valid key representation. This way we know that data must be a valid
1496 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001497 if (data_size == 0) {
1498 return PSA_ERROR_BUFFER_TOO_SMALL;
1499 }
Ronald Crone907e552021-01-18 13:22:38 +01001500
Ronald Cron9486f9d2020-11-26 13:36:23 +01001501 /* Set the key to empty now, so that even when there are errors, we always
1502 * set data_length to a value between 0 and data_size. On error, setting
1503 * the key to empty is a good choice because an empty key representation is
1504 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001505 *data_length = 0;
1506
Ronald Cron9486f9d2020-11-26 13:36:23 +01001507 /* Export requires the EXPORT flag. There is an exception for public keys,
1508 * which don't require any flag, but
1509 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1510 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001511 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1512 PSA_KEY_USAGE_EXPORT, 0);
1513 if (status != PSA_SUCCESS) {
1514 return status;
1515 }
mohammad160306e79202018-03-28 13:17:44 +03001516
Ronald Crond18b5f82020-11-25 16:46:05 +01001517 psa_key_attributes_t attributes = {
1518 .core = slot->attr
1519 };
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001520 status = psa_driver_wrapper_export_key(&attributes,
1521 slot->key.data, slot->key.bytes,
1522 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001523
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001524 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001525
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001526 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001527}
1528
Ronald Cron7285cda2020-11-26 14:46:37 +01001529psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001530 const psa_key_attributes_t *attributes,
1531 const uint8_t *key_buffer,
1532 size_t key_buffer_size,
1533 uint8_t *data,
1534 size_t data_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001535 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001536{
Ronald Crond18b5f82020-11-25 16:46:05 +01001537 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001538
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001539 if (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type)) {
1540 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type)) {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001541 /* Exporting public -> public */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001542 return psa_export_key_buffer_internal(
1543 key_buffer, key_buffer_size,
1544 data, data_size, data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001545 }
Steven Cooremanb9b84422020-10-14 14:39:20 +02001546
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001547 if (PSA_KEY_TYPE_IS_RSA(type)) {
John Durkop0e005192020-10-31 22:06:54 -07001548#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001549 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1550 return mbedtls_psa_rsa_export_public_key(attributes,
1551 key_buffer,
1552 key_buffer_size,
1553 data,
1554 data_size,
1555 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001556#else
Steven Cooreman560c28a2020-07-24 23:20:24 +02001557 /* We don't know how to convert a private RSA key to public. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001558 return PSA_ERROR_NOT_SUPPORTED;
John Durkop9814fa22020-11-04 12:28:15 -08001559#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
1560 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001561 } else {
John Durkop6ba40d12020-11-10 08:50:04 -08001562#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001563 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1564 return mbedtls_psa_ecp_export_public_key(attributes,
1565 key_buffer,
1566 key_buffer_size,
1567 data,
1568 data_size,
1569 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001570#else
1571 /* We don't know how to convert a private ECC key to public */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001572 return PSA_ERROR_NOT_SUPPORTED;
John Durkop9814fa22020-11-04 12:28:15 -08001573#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) ||
1574 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Moran Pekera998bc62018-04-16 18:16:20 +03001575 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001576 } else {
Steven Cooreman560c28a2020-07-24 23:20:24 +02001577 /* This shouldn't happen in the reference implementation, but
1578 it is valid for a special-purpose implementation to omit
1579 support for exporting certain key types. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001580 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001581 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001582}
Ronald Crond18b5f82020-11-25 16:46:05 +01001583
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001584psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
1585 uint8_t *data,
1586 size_t data_size,
1587 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001588{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001589 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001590 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01001591 psa_key_attributes_t attributes;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001592 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001593
Ronald Crone907e552021-01-18 13:22:38 +01001594 /* Reject a zero-length output buffer now, since this can never be a
1595 * valid key representation. This way we know that data must be a valid
1596 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001597 if (data_size == 0) {
1598 return PSA_ERROR_BUFFER_TOO_SMALL;
1599 }
Ronald Crone907e552021-01-18 13:22:38 +01001600
Darryl Greendd8fb772018-11-07 16:00:44 +00001601 /* Set the key to empty now, so that even when there are errors, we always
1602 * set data_length to a value between 0 and data_size. On error, setting
1603 * the key to empty is a good choice because an empty key representation is
1604 * unlikely to be accepted anywhere. */
1605 *data_length = 0;
1606
1607 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001608 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1609 if (status != PSA_SUCCESS) {
1610 return status;
1611 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001612
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001613 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1614 status = PSA_ERROR_INVALID_ARGUMENT;
1615 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001616 }
1617
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01001618 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001619 .core = slot->attr
1620 };
Ronald Cron67227982020-11-26 15:16:05 +01001621 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001622 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001623 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001624
1625exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001626 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001627
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001628 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001629}
1630
Tom Cosgrovebdd01a72023-03-08 14:19:51 +00001631MBEDTLS_STATIC_ASSERT((MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1632 "One or more key attribute flag is listed as both external-only and dual-use")
1633MBEDTLS_STATIC_ASSERT((PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1634 "One or more key attribute flag is listed as both internal-only and dual-use")
1635MBEDTLS_STATIC_ASSERT((PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1636 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001637
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001638/** Validate that a key policy is internally well-formed.
1639 *
1640 * This function only rejects invalid policies. It does not validate the
1641 * consistency of the policy with respect to other attributes of the key
1642 * such as the key type.
1643 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001644static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001645{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001646 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1647 PSA_KEY_USAGE_COPY |
1648 PSA_KEY_USAGE_ENCRYPT |
1649 PSA_KEY_USAGE_DECRYPT |
1650 PSA_KEY_USAGE_SIGN_MESSAGE |
1651 PSA_KEY_USAGE_VERIFY_MESSAGE |
1652 PSA_KEY_USAGE_SIGN_HASH |
1653 PSA_KEY_USAGE_VERIFY_HASH |
1654 PSA_KEY_USAGE_DERIVE)) != 0) {
1655 return PSA_ERROR_INVALID_ARGUMENT;
1656 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001657
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001658 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001659}
1660
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001661/** Validate the internal consistency of key attributes.
1662 *
1663 * This function only rejects invalid attribute values. If does not
1664 * validate the consistency of the attributes with any key data that may
1665 * be involved in the creation of the key.
1666 *
1667 * Call this function early in the key creation process.
1668 *
1669 * \param[in] attributes Key attributes for the new key.
1670 * \param[out] p_drv On any return, the driver for the key, if any.
1671 * NULL for a transparent key.
1672 *
1673 */
1674static psa_status_t psa_validate_key_attributes(
1675 const psa_key_attributes_t *attributes,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001676 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001677{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001678 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001679 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1680 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001681
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001682 status = psa_validate_key_location(lifetime, p_drv);
1683 if (status != PSA_SUCCESS) {
1684 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001685 }
1686
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001687 status = psa_validate_key_persistence(lifetime);
1688 if (status != PSA_SUCCESS) {
1689 return status;
1690 }
1691
1692 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1693 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1694 return PSA_ERROR_INVALID_ARGUMENT;
1695 }
1696 } else {
1697 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1698 return PSA_ERROR_INVALID_ARGUMENT;
1699 }
1700 }
1701
1702 status = psa_validate_key_policy(&attributes->core.policy);
1703 if (status != PSA_SUCCESS) {
1704 return status;
1705 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001706
1707 /* Refuse to create overly large keys.
1708 * Note that this doesn't trigger on import if the attributes don't
1709 * explicitly specify a size (so psa_get_key_bits returns 0), so
1710 * psa_import_key() needs its own checks. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001711 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1712 return PSA_ERROR_NOT_SUPPORTED;
1713 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001714
Gilles Peskine91e8c332019-08-02 19:19:39 +02001715 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001716 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1717 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1718 return PSA_ERROR_INVALID_ARGUMENT;
1719 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001720
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001721 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001722}
1723
Gilles Peskine4747d192019-04-17 15:05:45 +02001724/** Prepare a key slot to receive key material.
1725 *
1726 * This function allocates a key slot and sets its metadata.
1727 *
1728 * If this function fails, call psa_fail_key_creation().
1729 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001730 * This function is intended to be used as follows:
1731 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001732 * it with the specified attributes, and in case of a volatile key assign it
1733 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001734 * -# Populate the slot with the key material.
1735 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1736 * In case of failure at any step, stop the sequence and call
1737 * psa_fail_key_creation().
1738 *
Ronald Cron5c522922020-11-14 16:35:34 +01001739 * On success, the key slot is locked. It is the responsibility of the caller
1740 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001741 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001742 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001743 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001744 * \param[out] p_slot On success, a pointer to the prepared slot.
1745 * \param[out] p_drv On any return, the driver for the key, if any.
1746 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001747 *
1748 * \retval #PSA_SUCCESS
1749 * The key slot is ready to receive key material.
1750 * \return If this function fails, the key slot is an invalid state.
1751 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001752 */
1753static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001754 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001755 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001756 psa_key_slot_t **p_slot,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001757 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001758{
1759 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001760 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001761 psa_key_slot_t *slot;
1762
Gilles Peskinedf179142019-07-15 22:02:14 +02001763 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001764 *p_drv = NULL;
1765
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001766 status = psa_validate_key_attributes(attributes, p_drv);
1767 if (status != PSA_SUCCESS) {
1768 return status;
1769 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001770
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001771 status = psa_get_empty_key_slot(&volatile_key_id, p_slot);
1772 if (status != PSA_SUCCESS) {
1773 return status;
1774 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001775 slot = *p_slot;
1776
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001777 /* We're storing the declared bit-size of the key. It's up to each
1778 * creation mechanism to verify that this information is correct.
1779 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001780 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001781 * is optional (import, copy). In case of a volatile key, assign it the
1782 * volatile key identifier associated to the slot returned to contain its
1783 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001784
1785 slot->attr = attributes->core;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001786 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001787#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1788 slot->attr.id = volatile_key_id;
1789#else
1790 slot->attr.id.key_id = volatile_key_id;
1791#endif
1792 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001793
Gilles Peskine91e8c332019-08-02 19:19:39 +02001794 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001795 * external-only flags, query `attributes`. Thanks to the check
1796 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001797 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001798 * may have set. */
1799 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001800
Gilles Peskinecbaff462019-07-12 23:46:04 +02001801#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001802 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001803 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001804 * create the key file in internal storage, create the
1805 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001806 * persistent data. This is done by starting a transaction that will
1807 * encompass these three actions.
1808 * For registering a volatile key, we just need to find an appropriate
1809 * slot number inside the SE. Since the key is designated volatile, creating
1810 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001811 /* The first thing to do is to find a slot number for the new key.
1812 * We save the slot number in persistent storage as part of the
1813 * transaction data. It will be needed to recover if the power
1814 * fails during the key creation process, to clean up on the secure
1815 * element side after restarting. Obtaining a slot number from the
1816 * secure element driver updates its persistent state, but we do not yet
1817 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001818 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001819 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001820 psa_key_slot_number_t slot_number;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001821 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1822 &slot_number);
1823 if (status != PSA_SUCCESS) {
1824 return status;
1825 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001826
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001827 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1828 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001829 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001830 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001831 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001832 status = psa_crypto_save_transaction();
1833 if (status != PSA_SUCCESS) {
1834 (void) psa_crypto_stop_transaction();
1835 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001836 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001837 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001838
1839 status = psa_copy_key_material_into_slot(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001840 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001841 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001842
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001843 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001844 /* Key registration only makes sense with a secure element. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001845 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001846 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001847#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1848
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001849 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001850}
Gilles Peskine4747d192019-04-17 15:05:45 +02001851
1852/** Finalize the creation of a key once its key material has been set.
1853 *
1854 * This entails writing the key to persistent storage.
1855 *
1856 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001857 * See the documentation of psa_start_key_creation() for the intended use
1858 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001859 *
Ronald Cron5c522922020-11-14 16:35:34 +01001860 * If the finalization succeeds, the function unlocks the key slot (it was
1861 * locked by psa_start_key_creation()) and the key slot cannot be accessed
1862 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001863 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001864 * \param[in,out] slot Pointer to the slot with key material.
1865 * \param[in] driver The secure element driver for the key,
1866 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001867 * \param[out] key On success, identifier of the key. Note that the
1868 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001869 *
1870 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001871 * The key was successfully created.
Gilles Peskineec1eff32023-02-14 19:21:09 +01001872 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1873 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1874 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1875 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1876 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1877 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001878 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001879 * \return If this function fails, the key slot is an invalid state.
1880 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001881 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001882static psa_status_t psa_finish_key_creation(
1883 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001884 psa_se_drv_table_entry_t *driver,
1885 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001886{
1887 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001888 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001889 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001890
1891#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001892 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001893#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001894 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001895 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001896 psa_key_slot_number_t slot_number =
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001897 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001898
Tom Cosgrovebdd01a72023-03-08 14:19:51 +00001899 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1900 sizeof(data.slot_number),
1901 "Slot number size does not match psa_se_key_data_storage_t");
1902
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001903 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1904 status = psa_save_persistent_key(&slot->attr,
1905 (uint8_t *) &data,
1906 sizeof(data));
1907 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001908#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1909 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001910 /* Key material is saved in export representation in the slot, so
1911 * just pass the slot buffer for storage. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001912 status = psa_save_persistent_key(&slot->attr,
1913 slot->key.data,
1914 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001915 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001916 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001917#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1918
Gilles Peskinecbaff462019-07-12 23:46:04 +02001919#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001920 /* Finish the transaction for a key creation. This does not
1921 * happen when registering an existing key. Detect this case
1922 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001923 * creation of a persistent key in a secure element requires a transaction,
1924 * but registration or volatile key creation doesn't use one). */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001925 if (driver != NULL &&
1926 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1927 status = psa_save_se_persistent_data(driver);
1928 if (status != PSA_SUCCESS) {
1929 psa_destroy_persistent_key(slot->attr.id);
1930 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001931 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001932 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001933 }
1934#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1935
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001936 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001937 *key = slot->attr.id;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001938 status = psa_unlock_key_slot(slot);
1939 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001940 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001941 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001942 }
Ronald Cron50972942020-11-14 11:28:25 +01001943
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001944 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001945}
1946
1947/** Abort the creation of a key.
1948 *
1949 * You may call this function after calling psa_start_key_creation(),
1950 * or after psa_finish_key_creation() fails. In other circumstances, this
1951 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001952 * See the documentation of psa_start_key_creation() for the intended use
1953 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001954 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001955 * \param[in,out] slot Pointer to the slot with key material.
1956 * \param[in] driver The secure element driver for the key,
1957 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001958 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001959static void psa_fail_key_creation(psa_key_slot_t *slot,
1960 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001961{
Gilles Peskine011e4282019-06-26 18:34:38 +02001962 (void) driver;
1963
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001964 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001965 return;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001966 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001967
1968#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001969 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001970 * element, and the failure happened later (when saving metadata
1971 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001972 * element.
1973 * https://github.com/ARMmbed/mbed-crypto/issues/217
1974 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001975
Gilles Peskined7729582019-08-05 15:55:54 +02001976 /* Abort the ongoing transaction if any (there may not be one if
1977 * the creation process failed before starting one, or if the
1978 * key creation is a registration of a key in a secure element).
1979 * Earlier functions must already have done what it takes to undo any
1980 * partial creation. All that's left is to update the transaction data
1981 * itself. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001982 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001983#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1984
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001985 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02001986}
1987
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001988/** Validate optional attributes during key creation.
1989 *
1990 * Some key attributes are optional during key creation. If they are
1991 * specified in the attributes structure, check that they are consistent
1992 * with the data in the slot.
1993 *
1994 * This function should be called near the end of key creation, after
1995 * the slot in memory is fully populated but before saving persistent data.
1996 */
1997static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001998 const psa_key_slot_t *slot,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001999 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002000{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002001 if (attributes->core.type != 0) {
2002 if (attributes->core.type != slot->attr.type) {
2003 return PSA_ERROR_INVALID_ARGUMENT;
2004 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002005 }
2006
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002007 if (attributes->domain_parameters_size != 0) {
John Durkop0e005192020-10-31 22:06:54 -07002008#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002009 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
2010 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02002011 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002012 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002013 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002014
Ronald Cron90857082020-11-25 14:58:33 +01002015 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002016 slot->attr.type,
2017 slot->key.data,
2018 slot->key.bytes,
2019 &rsa);
2020 if (status != PSA_SUCCESS) {
2021 return status;
2022 }
Steven Cooreman75b74362020-07-28 14:30:13 +02002023
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002024 mbedtls_mpi_init(&actual);
2025 mbedtls_mpi_init(&required);
2026 ret = mbedtls_rsa_export(rsa,
2027 NULL, NULL, NULL, NULL, &actual);
2028 mbedtls_rsa_free(rsa);
2029 mbedtls_free(rsa);
2030 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002031 goto rsa_exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002032 }
2033 ret = mbedtls_mpi_read_binary(&required,
2034 attributes->domain_parameters,
2035 attributes->domain_parameters_size);
2036 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002037 goto rsa_exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002038 }
2039 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002040 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002041 }
2042rsa_exit:
2043 mbedtls_mpi_free(&actual);
2044 mbedtls_mpi_free(&required);
2045 if (ret != 0) {
2046 return mbedtls_to_psa_error(ret);
2047 }
2048 } else
John Durkop9814fa22020-11-04 12:28:15 -08002049#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) ||
2050 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002051 {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002052 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002053 }
2054 }
2055
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002056 if (attributes->core.bits != 0) {
2057 if (attributes->core.bits != slot->attr.bits) {
2058 return PSA_ERROR_INVALID_ARGUMENT;
2059 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002060 }
2061
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002062 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002063}
2064
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002065psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
2066 const uint8_t *data,
2067 size_t data_length,
2068 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002069{
2070 psa_status_t status;
2071 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002072 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002073 size_t bits;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002074
Ronald Cron81709fc2020-11-14 12:10:32 +01002075 *key = MBEDTLS_SVC_KEY_ID_INIT;
2076
Gilles Peskine0f84d622019-09-12 19:03:13 +02002077 /* Reject zero-length symmetric keys (including raw data key objects).
2078 * This also rejects any key which might be encoded as an empty string,
2079 * which is never valid. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002080 if (data_length == 0) {
2081 return PSA_ERROR_INVALID_ARGUMENT;
2082 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002083
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002084 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2085 &slot, &driver);
2086 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002087 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002088 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002089
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002090 /* In the case of a transparent key or an opaque key stored in local
2091 * storage (thus not in the case of generating a key in a secure element
2092 * or cryptoprocessor with storage), we have to allocate a buffer to
2093 * hold the generated key material. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002094 if (slot->key.data == NULL) {
2095 status = psa_allocate_buffer_to_slot(slot, data_length);
2096 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002097 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002098 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002099 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002100
2101 bits = slot->attr.bits;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002102 status = psa_driver_wrapper_import_key(attributes,
2103 data, data_length,
2104 slot->key.data,
2105 slot->key.bytes,
2106 &slot->key.bytes, &bits);
2107 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002108 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002109 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002110
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002111 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002112 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002113 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002114 status = PSA_ERROR_INVALID_ARGUMENT;
2115 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002116 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002117
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002118 status = psa_validate_optional_attributes(slot, attributes);
2119 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002120 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002121 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002122
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002123 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002124exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002125 if (status != PSA_SUCCESS) {
2126 psa_fail_key_creation(slot, driver);
2127 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002128
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002129 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002130}
2131
Gilles Peskined7729582019-08-05 15:55:54 +02002132#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2133psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002134 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002135{
2136 psa_status_t status;
2137 psa_key_slot_t *slot = NULL;
2138 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002139 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002140
2141 /* Leaving attributes unspecified is not currently supported.
2142 * It could make sense to query the key type and size from the
2143 * secure element, but not all secure elements support this
2144 * and the driver HAL doesn't currently support it. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002145 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2146 return PSA_ERROR_NOT_SUPPORTED;
2147 }
2148 if (psa_get_key_bits(attributes) == 0) {
2149 return PSA_ERROR_NOT_SUPPORTED;
2150 }
Gilles Peskined7729582019-08-05 15:55:54 +02002151
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002152 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2153 &slot, &driver);
2154 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002155 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002156 }
Gilles Peskined7729582019-08-05 15:55:54 +02002157
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002158 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002159
2160exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002161 if (status != PSA_SUCCESS) {
2162 psa_fail_key_creation(slot, driver);
2163 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002164
Gilles Peskined7729582019-08-05 15:55:54 +02002165 /* Registration doesn't keep the key in RAM. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002166 psa_close_key(key);
2167 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002168}
2169#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2170
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002171static psa_status_t psa_copy_key_material(const psa_key_slot_t *source,
2172 psa_key_slot_t *target)
Gilles Peskinef603c712019-01-19 13:40:11 +01002173{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002174 psa_status_t status = psa_copy_key_material_into_slot(target,
2175 source->key.data,
2176 source->key.bytes);
2177 if (status != PSA_SUCCESS) {
2178 return status;
2179 }
Gilles Peskinef603c712019-01-19 13:40:11 +01002180
Steven Cooreman398aee52020-10-13 14:35:45 +02002181 target->attr.type = source->attr.type;
2182 target->attr.bits = source->attr.bits;
2183
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002184 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +01002185}
2186
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002187psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2188 const psa_key_attributes_t *specified_attributes,
2189 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002190{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002191 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002192 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002193 psa_key_slot_t *source_slot = NULL;
2194 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002195 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002196 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskinef603c712019-01-19 13:40:11 +01002197
Ronald Cron81709fc2020-11-14 12:10:32 +01002198 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2199
Ronald Cron5c522922020-11-14 16:35:34 +01002200 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002201 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2202 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002203 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002204 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002205
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002206 status = psa_validate_optional_attributes(source_slot,
2207 specified_attributes);
2208 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002209 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002210 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002211
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002212 status = psa_restrict_key_policy(source_slot->attr.type,
2213 &actual_attributes.core.policy,
2214 &source_slot->attr.policy);
2215 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002216 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002217 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002218
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002219 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2220 &target_slot, &driver);
2221 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002222 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002223 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002224
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002225#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002226 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002227 /* Copying to a secure element is not implemented yet. */
2228 status = PSA_ERROR_NOT_SUPPORTED;
2229 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002230 }
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002231#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskinef603c712019-01-19 13:40:11 +01002232
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002233 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
Ronald Cron6cc66312021-04-02 12:27:47 +02002234 /*
2235 * Copying through an opaque driver is not implemented yet, consider
2236 * a lifetime with an external location as an invalid parameter for
2237 * now.
2238 */
2239 status = PSA_ERROR_INVALID_ARGUMENT;
2240 goto exit;
2241 }
2242
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002243 status = psa_copy_key_material(source_slot, target_slot);
2244 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002245 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002246 }
Gilles Peskinef603c712019-01-19 13:40:11 +01002247
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002248 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002249exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002250 if (status != PSA_SUCCESS) {
2251 psa_fail_key_creation(target_slot, driver);
2252 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002253
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002254 unlock_status = psa_unlock_key_slot(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002255
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002256 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002257}
2258
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002259
2260
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002261/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002262/* Message digests */
2263/****************************************************************/
2264
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002265psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002266{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002267 /* Aborting a non-active operation is allowed */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002268 if (operation->id == 0) {
2269 return PSA_SUCCESS;
2270 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002271
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002272 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002273 operation->id = 0;
2274
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002275 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002276}
2277
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002278psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2279 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002280{
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002281 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002282
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002283 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002284 if (operation->id != 0) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002285 status = PSA_ERROR_BAD_STATE;
2286 goto exit;
2287 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002288
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002289 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002290 status = PSA_ERROR_INVALID_ARGUMENT;
2291 goto exit;
2292 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002293
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002294 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2295 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002296 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002297
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002298 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002299
2300exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002301 if (status != PSA_SUCCESS) {
2302 psa_hash_abort(operation);
2303 }
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002304
2305 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002306}
2307
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002308psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2309 const uint8_t *input,
2310 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002311{
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002312 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2313
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002314 if (operation->id == 0) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002315 status = PSA_ERROR_BAD_STATE;
2316 goto exit;
2317 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002318
Steven Cooremanc8288352021-03-04 14:02:19 +01002319 /* Don't require hash implementations to behave correctly on a
2320 * zero-length input, which may have an invalid pointer. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002321 if (input_length == 0) {
2322 return PSA_SUCCESS;
2323 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002324
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002325 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002326
2327exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002328 if (status != PSA_SUCCESS) {
2329 psa_hash_abort(operation);
2330 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002331
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002332 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002333}
2334
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002335psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2336 uint8_t *hash,
2337 size_t hash_size,
2338 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002339{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002340 *hash_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002341 if (operation->id == 0) {
2342 return PSA_ERROR_BAD_STATE;
2343 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002344
Steven Cooreman1e582352021-02-18 17:24:37 +01002345 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002346 operation, hash, hash_size, hash_length);
2347 psa_hash_abort(operation);
2348 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002349}
2350
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002351psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2352 const uint8_t *hash,
2353 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002354{
Ronald Cron3a95d2b2021-10-18 09:47:58 +02002355 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002356 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002357 psa_status_t status = psa_hash_finish(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002358 operation,
2359 actual_hash, sizeof(actual_hash),
2360 &actual_hash_length);
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002361
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002362 if (status != PSA_SUCCESS) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002363 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002364 }
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002365
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002366 if (actual_hash_length != hash_length) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002367 status = PSA_ERROR_INVALID_SIGNATURE;
2368 goto exit;
2369 }
2370
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002371 if (mbedtls_psa_safer_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002372 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002373 }
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002374
2375exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002376 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2377 if (status != PSA_SUCCESS) {
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002378 psa_hash_abort(operation);
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002379 }
Dave Rodgman4e0a82e2021-06-24 11:52:23 +01002380
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002381 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002382}
2383
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002384psa_status_t psa_hash_compute(psa_algorithm_t alg,
2385 const uint8_t *input, size_t input_length,
2386 uint8_t *hash, size_t hash_size,
2387 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002388{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002389 *hash_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002390 if (!PSA_ALG_IS_HASH(alg)) {
2391 return PSA_ERROR_INVALID_ARGUMENT;
2392 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002393
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002394 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2395 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002396}
2397
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002398psa_status_t psa_hash_compare(psa_algorithm_t alg,
2399 const uint8_t *input, size_t input_length,
2400 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002401{
Ronald Cron3a95d2b2021-10-18 09:47:58 +02002402 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002403 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002404
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002405 if (!PSA_ALG_IS_HASH(alg)) {
2406 return PSA_ERROR_INVALID_ARGUMENT;
2407 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002408
Steven Cooreman1e582352021-02-18 17:24:37 +01002409 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002410 alg, input, input_length,
2411 actual_hash, sizeof(actual_hash),
2412 &actual_hash_length);
2413 if (status != PSA_SUCCESS) {
Gilles Peskineb3f4e5b2021-12-13 12:33:18 +01002414 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002415 }
2416 if (actual_hash_length != hash_length) {
Gilles Peskineb3f4e5b2021-12-13 12:33:18 +01002417 status = PSA_ERROR_INVALID_SIGNATURE;
2418 goto exit;
2419 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002420 if (mbedtls_psa_safer_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskineb3f4e5b2021-12-13 12:33:18 +01002421 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002422 }
Gilles Peskineb3f4e5b2021-12-13 12:33:18 +01002423
2424exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002425 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2426 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002427}
2428
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002429psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2430 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002431{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002432 if (source_operation->id == 0 ||
2433 target_operation->id != 0) {
2434 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002435 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002436
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002437 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2438 target_operation);
2439 if (status != PSA_SUCCESS) {
2440 psa_hash_abort(target_operation);
2441 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002442
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002443 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002444}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002445
2446
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002447/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002448/* MAC */
2449/****************************************************************/
2450
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002451psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002452{
Steven Cooreman07897832021-03-19 18:28:56 +01002453 /* Aborting a non-active operation is allowed */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002454 if (operation->id == 0) {
2455 return PSA_SUCCESS;
2456 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002457
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002458 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman15f0d922021-05-07 14:14:37 +02002459 operation->mac_size = 0;
2460 operation->is_sign = 0;
Steven Cooreman07897832021-03-19 18:28:56 +01002461 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002462
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002463 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002464}
2465
Ronald Cron1c650a12021-06-17 16:33:22 +02002466static psa_status_t psa_mac_finalize_alg_and_key_validation(
2467 psa_algorithm_t alg,
Ronald Crondef68e72021-06-17 16:46:44 +02002468 const psa_key_attributes_t *attributes,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002469 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002470{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002471 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002472 psa_key_type_t key_type = psa_get_key_type(attributes);
2473 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002474
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002475 if (!PSA_ALG_IS_MAC(alg)) {
2476 return PSA_ERROR_INVALID_ARGUMENT;
2477 }
Steven Cooreman07897832021-03-19 18:28:56 +01002478
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002479 /* Validate the combination of key type and algorithm */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002480 status = psa_mac_key_can_do(alg, key_type);
2481 if (status != PSA_SUCCESS) {
2482 return status;
2483 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002484
Steven Cooremana6474de2021-05-10 11:13:41 +02002485 /* Get the output length for the algorithm and key combination */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002486 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002487
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002488 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002489 /* A very short MAC is too short for security since it can be
2490 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2491 * so we make this our minimum, even though 32 bits is still
2492 * too small for security. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002493 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002494 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002495
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002496 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2497 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002498 /* It's impossible to "truncate" to a larger length than the full length
2499 * of the algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002500 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002501 }
2502
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002503 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinebc795822022-03-16 13:54:49 +01002504 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2505 * that is disabled in the compile-time configuration. The result can
2506 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2507 * configuration into account. In this case, force a return of
2508 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2509 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2510 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2511 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2512 * systematically generated tests. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002513 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinebc795822022-03-16 13:54:49 +01002514 }
2515
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002516 return PSA_SUCCESS;
Ronald Cron1c650a12021-06-17 16:33:22 +02002517}
2518
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002519static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2520 mbedtls_svc_key_id_t key,
2521 psa_algorithm_t alg,
2522 int is_sign)
Ronald Cron1c650a12021-06-17 16:33:22 +02002523{
2524 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2525 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002526 psa_key_attributes_t attributes;
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002527 psa_key_slot_t *slot = NULL;
Ronald Cron1c650a12021-06-17 16:33:22 +02002528
2529 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002530 if (operation->id != 0) {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002531 status = PSA_ERROR_BAD_STATE;
2532 goto exit;
2533 }
Ronald Cron1c650a12021-06-17 16:33:22 +02002534
2535 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002536 key,
2537 &slot,
2538 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2539 alg);
2540 if (status != PSA_SUCCESS) {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01002541 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002542 }
Ronald Cron1c650a12021-06-17 16:33:22 +02002543
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002544 attributes = (psa_key_attributes_t) {
Ronald Cron1c650a12021-06-17 16:33:22 +02002545 .core = slot->attr
2546 };
2547
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002548 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2549 &operation->mac_size);
2550 if (status != PSA_SUCCESS) {
Ronald Cron1c650a12021-06-17 16:33:22 +02002551 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002552 }
Ronald Cron1c650a12021-06-17 16:33:22 +02002553
2554 operation->is_sign = is_sign;
Steven Cooreman07897832021-03-19 18:28:56 +01002555 /* Dispatch the MAC setup call with validated input */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002556 if (is_sign) {
2557 status = psa_driver_wrapper_mac_sign_setup(operation,
2558 &attributes,
2559 slot->key.data,
2560 slot->key.bytes,
2561 alg);
2562 } else {
2563 status = psa_driver_wrapper_mac_verify_setup(operation,
2564 &attributes,
2565 slot->key.data,
2566 slot->key.bytes,
2567 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002568 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002569
Gilles Peskinefbfac682018-07-08 20:51:54 +02002570exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002571 if (status != PSA_SUCCESS) {
2572 psa_mac_abort(operation);
2573 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002574
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002575 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002576
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002577 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002578}
2579
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002580psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2581 mbedtls_svc_key_id_t key,
2582 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002583{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002584 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002585}
2586
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002587psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2588 mbedtls_svc_key_id_t key,
2589 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002590{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002591 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002592}
2593
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002594psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2595 const uint8_t *input,
2596 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002597{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002598 if (operation->id == 0) {
2599 return PSA_ERROR_BAD_STATE;
2600 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002601
Steven Cooreman11743f92021-03-19 18:38:46 +01002602 /* Don't require hash implementations to behave correctly on a
2603 * zero-length input, which may have an invalid pointer. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002604 if (input_length == 0) {
2605 return PSA_SUCCESS;
2606 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002607
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002608 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2609 input, input_length);
2610 if (status != PSA_SUCCESS) {
2611 psa_mac_abort(operation);
2612 }
Steven Cooreman11743f92021-03-19 18:38:46 +01002613
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002614 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002615}
2616
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002617psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2618 uint8_t *mac,
2619 size_t mac_size,
2620 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002621{
Steven Cooreman87885df2021-03-19 19:04:39 +01002622 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2623 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002624
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002625 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002626 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002627 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002628 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002629
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002630 if (!operation->is_sign) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002631 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002632 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002633 }
Steven Cooreman15f0d922021-05-07 14:14:37 +02002634
Steven Cooremanf8ad2122021-05-11 11:09:13 +02002635 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2636 * once all the error checks are done. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002637 if (operation->mac_size == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002638 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002639 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002640 }
Steven Cooremanf8ad2122021-05-11 11:09:13 +02002641
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002642 if (mac_size < operation->mac_size) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002643 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman478ab542021-06-25 09:09:02 +01002644 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002645 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002646
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002647 status = psa_driver_wrapper_mac_sign_finish(operation,
2648 mac, operation->mac_size,
2649 mac_length);
Steven Cooreman15f0d922021-05-07 14:14:37 +02002650
Dave Rodgman478ab542021-06-25 09:09:02 +01002651exit:
Ronald Cron882eb782021-06-18 13:05:48 +02002652 /* In case of success, set the potential excess room in the output buffer
2653 * to an invalid value, to avoid potentially leaking a longer MAC.
2654 * In case of error, set the output length and content to a safe default,
2655 * such that in case the caller misses an error check, the output would be
2656 * an unachievable MAC.
2657 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002658 if (status != PSA_SUCCESS) {
Steven Cooreman15f0d922021-05-07 14:14:37 +02002659 *mac_length = mac_size;
Ronald Cron882eb782021-06-18 13:05:48 +02002660 operation->mac_size = 0;
Steven Cooreman15f0d922021-05-07 14:14:37 +02002661 }
mohammad16036df908f2018-04-02 08:34:15 -07002662
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002663 if (mac_size > operation->mac_size) {
2664 memset(&mac[operation->mac_size], '!',
2665 mac_size - operation->mac_size);
2666 }
Ronald Cron882eb782021-06-18 13:05:48 +02002667
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002668 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002669
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002670 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002671}
2672
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002673psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2674 const uint8_t *mac,
2675 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002676{
Steven Cooreman87885df2021-03-19 19:04:39 +01002677 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2678 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman6e3c2cb2021-03-19 17:05:52 +01002679
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002680 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002681 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002682 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002683 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002684
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002685 if (operation->is_sign) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002686 status = PSA_ERROR_BAD_STATE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002687 goto exit;
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01002688 }
Steven Cooreman15f0d922021-05-07 14:14:37 +02002689
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002690 if (operation->mac_size != mac_length) {
Steven Cooreman15f0d922021-05-07 14:14:37 +02002691 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman478ab542021-06-25 09:09:02 +01002692 goto exit;
Steven Cooreman15f0d922021-05-07 14:14:37 +02002693 }
2694
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002695 status = psa_driver_wrapper_mac_verify_finish(operation,
2696 mac, mac_length);
Steven Cooreman15f0d922021-05-07 14:14:37 +02002697
Dave Rodgman478ab542021-06-25 09:09:02 +01002698exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002699 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002700
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002701 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002702}
2703
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002704static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2705 psa_algorithm_t alg,
2706 const uint8_t *input,
2707 size_t input_length,
2708 uint8_t *mac,
2709 size_t mac_size,
2710 size_t *mac_length,
2711 int is_sign)
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002712{
2713 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crondbb86462021-06-17 17:17:20 +02002714 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002715 psa_key_attributes_t attributes;
Ronald Crondbb86462021-06-17 17:17:20 +02002716 psa_key_slot_t *slot;
2717 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002718
Ronald Crondbb86462021-06-17 17:17:20 +02002719 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002720 key,
2721 &slot,
2722 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2723 alg);
2724 if (status != PSA_SUCCESS) {
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002725 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002726 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002727
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002728 attributes = (psa_key_attributes_t) {
Ronald Crondbb86462021-06-17 17:17:20 +02002729 .core = slot->attr
2730 };
2731
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002732 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2733 &operation_mac_size);
2734 if (status != PSA_SUCCESS) {
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002735 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002736 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002737
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002738 if (mac_size < operation_mac_size) {
Ronald Crondbb86462021-06-17 17:17:20 +02002739 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002740 goto exit;
Ronald Crondbb86462021-06-17 17:17:20 +02002741 }
2742
2743 status = psa_driver_wrapper_mac_compute(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002744 &attributes,
2745 slot->key.data, slot->key.bytes,
2746 alg,
2747 input, input_length,
2748 mac, operation_mac_size, mac_length);
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002749
2750exit:
Ronald Cron882eb782021-06-18 13:05:48 +02002751 /* In case of success, set the potential excess room in the output buffer
2752 * to an invalid value, to avoid potentially leaking a longer MAC.
2753 * In case of error, set the output length and content to a safe default,
2754 * such that in case the caller misses an error check, the output would be
2755 * an unachievable MAC.
2756 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002757 if (status != PSA_SUCCESS) {
Ronald Crondbb86462021-06-17 17:17:20 +02002758 *mac_length = mac_size;
Ronald Cron882eb782021-06-18 13:05:48 +02002759 operation_mac_size = 0;
Ronald Crondbb86462021-06-17 17:17:20 +02002760 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002761 if (mac_size > operation_mac_size) {
2762 memset(&mac[operation_mac_size], '!', mac_size - operation_mac_size);
2763 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002764
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002765 unlock_status = psa_unlock_key_slot(slot);
Ronald Crondbb86462021-06-17 17:17:20 +02002766
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002767 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002768}
2769
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002770psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002771 psa_algorithm_t alg,
2772 const uint8_t *input,
2773 size_t input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002774 uint8_t *mac,
2775 size_t mac_size,
2776 size_t *mac_length)
2777{
2778 return psa_mac_compute_internal(key, alg,
2779 input, input_length,
2780 mac, mac_size, mac_length, 1);
2781}
2782
2783psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2784 psa_algorithm_t alg,
2785 const uint8_t *input,
2786 size_t input_length,
2787 const uint8_t *mac,
2788 size_t mac_length)
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002789{
2790 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron4ed83682021-06-18 14:51:29 +02002791 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2792 size_t actual_mac_length;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002793
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002794 status = psa_mac_compute_internal(key, alg,
2795 input, input_length,
2796 actual_mac, sizeof(actual_mac),
2797 &actual_mac_length, 0);
2798 if (status != PSA_SUCCESS) {
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002799 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002800 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002801
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002802 if (mac_length != actual_mac_length) {
Ronald Cron4ed83682021-06-18 14:51:29 +02002803 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002804 goto exit;
Ronald Cron4ed83682021-06-18 14:51:29 +02002805 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002806 if (mbedtls_psa_safer_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Cron4ed83682021-06-18 14:51:29 +02002807 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002808 goto exit;
Ronald Cron4ed83682021-06-18 14:51:29 +02002809 }
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002810
2811exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002812 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002813
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002814 return status;
gabor-mezei-arma00616f2021-03-01 15:34:18 +01002815}
Gilles Peskine20035e32018-02-03 22:44:14 +01002816
Gilles Peskine20035e32018-02-03 22:44:14 +01002817/****************************************************************/
2818/* Asymmetric cryptography */
2819/****************************************************************/
2820
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002821static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2822 psa_algorithm_t alg)
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002823{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002824 if (input_is_message) {
2825 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2826 return PSA_ERROR_INVALID_ARGUMENT;
2827 }
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002828
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002829 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2830 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2831 return PSA_ERROR_INVALID_ARGUMENT;
2832 }
2833 }
2834 } else {
2835 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2836 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm56980482021-05-05 13:56:27 +02002837 }
2838 }
gabor-mezei-arm56980482021-05-05 13:56:27 +02002839
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002840 return PSA_SUCCESS;
gabor-mezei-arm56980482021-05-05 13:56:27 +02002841}
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002842
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002843static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2844 int input_is_message,
2845 psa_algorithm_t alg,
2846 const uint8_t *input,
2847 size_t input_length,
2848 uint8_t *signature,
2849 size_t signature_size,
2850 size_t *signature_length)
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002851{
2852 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2853 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002854 psa_key_attributes_t attributes;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002855 psa_key_slot_t *slot;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002856
2857 *signature_length = 0;
2858
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002859 status = psa_sign_verify_check_alg(input_is_message, alg);
2860 if (status != PSA_SUCCESS) {
gabor-mezei-arm56980482021-05-05 13:56:27 +02002861 return status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002862 }
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002863
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002864 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12ff4d52021-05-05 13:54:55 +02002865 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002866 * buffer can in principle be empty since it doesn't actually have
2867 * to be a hash.) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002868 if (signature_size == 0) {
2869 return PSA_ERROR_BUFFER_TOO_SMALL;
2870 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002871
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002872 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002873 key, &slot,
2874 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2875 PSA_KEY_USAGE_SIGN_HASH,
2876 alg);
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002877
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002878 if (status != PSA_SUCCESS) {
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002879 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002880 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002881
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002882 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002883 status = PSA_ERROR_INVALID_ARGUMENT;
2884 goto exit;
2885 }
2886
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01002887 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002888 .core = slot->attr
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002889 };
2890
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002891 if (input_is_message) {
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002892 status = psa_driver_wrapper_sign_message(
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002893 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002894 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002895 signature, signature_size, signature_length);
2896 } else {
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002897
2898 status = psa_driver_wrapper_sign_hash(
2899 &attributes, slot->key.data, slot->key.bytes,
2900 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002901 signature, signature_size, signature_length);
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002902 }
2903
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002904
2905exit:
2906 /* Fill the unused part of the output buffer (the whole buffer on error,
2907 * the trailing part on success) with something that isn't a valid signature
2908 * (barring an attack on the signature and deliberately-crafted input),
2909 * in case the caller doesn't check the return status properly. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002910 if (status == PSA_SUCCESS) {
2911 memset(signature + *signature_length, '!',
2912 signature_size - *signature_length);
2913 } else {
2914 memset(signature, '!', signature_size);
2915 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002916 /* If signature_size is 0 then we have nothing to do. We must not call
2917 * memset because signature may be NULL in this case. */
2918
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002919 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002920
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002921 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002922}
2923
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002924static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2925 int input_is_message,
2926 psa_algorithm_t alg,
2927 const uint8_t *input,
2928 size_t input_length,
2929 const uint8_t *signature,
2930 size_t signature_length)
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002931{
2932 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2933 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2934 psa_key_slot_t *slot;
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002935
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002936 status = psa_sign_verify_check_alg(input_is_message, alg);
2937 if (status != PSA_SUCCESS) {
gabor-mezei-arm56980482021-05-05 13:56:27 +02002938 return status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002939 }
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002940
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002941 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002942 key, &slot,
2943 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2944 PSA_KEY_USAGE_VERIFY_HASH,
2945 alg);
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002946
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002947 if (status != PSA_SUCCESS) {
2948 return status;
2949 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002950
2951 psa_key_attributes_t attributes = {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002952 .core = slot->attr
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002953 };
2954
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002955 if (input_is_message) {
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002956 status = psa_driver_wrapper_verify_message(
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002957 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002958 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002959 signature, signature_length);
2960 } else {
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002961 status = psa_driver_wrapper_verify_hash(
2962 &attributes, slot->key.data, slot->key.bytes,
2963 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002964 signature, signature_length);
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002965 }
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002966
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002967 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arme8efa392021-04-14 21:14:28 +02002968
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002969 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02002970
2971}
2972
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02002973psa_status_t psa_sign_message_builtin(
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002974 const psa_key_attributes_t *attributes,
2975 const uint8_t *key_buffer,
2976 size_t key_buffer_size,
2977 psa_algorithm_t alg,
2978 const uint8_t *input,
2979 size_t input_length,
2980 uint8_t *signature,
2981 size_t signature_size,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002982 size_t *signature_length)
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002983{
2984 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002985
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002986 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002987 size_t hash_length;
2988 uint8_t hash[PSA_HASH_MAX_SIZE];
2989
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002990 status = psa_driver_wrapper_hash_compute(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002991 PSA_ALG_SIGN_GET_HASH(alg),
2992 input, input_length,
2993 hash, sizeof(hash), &hash_length);
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02002994
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002995 if (status != PSA_SUCCESS) {
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02002996 return status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002997 }
gabor-mezei-arm9719a842021-05-03 16:26:20 +02002998
2999 return psa_driver_wrapper_sign_hash(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003000 attributes, key_buffer, key_buffer_size,
3001 alg, hash, hash_length,
3002 signature, signature_size, signature_length);
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02003003 }
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003004
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003005 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003006}
3007
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003008psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3009 psa_algorithm_t alg,
3010 const uint8_t *input,
3011 size_t input_length,
3012 uint8_t *signature,
3013 size_t signature_size,
3014 size_t *signature_length)
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003015{
3016 return psa_sign_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02003017 key, 1, alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003018 signature, signature_size, signature_length);
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003019}
3020
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02003021psa_status_t psa_verify_message_builtin(
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003022 const psa_key_attributes_t *attributes,
3023 const uint8_t *key_buffer,
3024 size_t key_buffer_size,
3025 psa_algorithm_t alg,
3026 const uint8_t *input,
3027 size_t input_length,
3028 const uint8_t *signature,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003029 size_t signature_length)
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003030{
3031 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003032
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003033 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-arm9719a842021-05-03 16:26:20 +02003034 size_t hash_length;
3035 uint8_t hash[PSA_HASH_MAX_SIZE];
3036
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02003037 status = psa_driver_wrapper_hash_compute(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003038 PSA_ALG_SIGN_GET_HASH(alg),
3039 input, input_length,
3040 hash, sizeof(hash), &hash_length);
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003041
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003042 if (status != PSA_SUCCESS) {
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02003043 return status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003044 }
gabor-mezei-arm9719a842021-05-03 16:26:20 +02003045
3046 return psa_driver_wrapper_verify_hash(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003047 attributes, key_buffer, key_buffer_size,
3048 alg, hash, hash_length,
3049 signature, signature_length);
gabor-mezei-armbfbe4652021-04-29 16:48:44 +02003050 }
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003051
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003052 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-armc53f4f62021-04-22 11:32:19 +02003053}
3054
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003055psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3056 psa_algorithm_t alg,
3057 const uint8_t *input,
3058 size_t input_length,
3059 const uint8_t *signature,
3060 size_t signature_length)
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003061{
3062 return psa_verify_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02003063 key, 1, alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003064 signature, signature_length);
gabor-mezei-arme8efa392021-04-14 21:14:28 +02003065}
3066
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02003067psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003068 const psa_key_attributes_t *attributes,
3069 const uint8_t *key_buffer, size_t key_buffer_size,
3070 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003071 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskine20035e32018-02-03 22:44:14 +01003072{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003073 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3074 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3075 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003076#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003077 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3078 return mbedtls_psa_rsa_sign_hash(
3079 attributes,
3080 key_buffer, key_buffer_size,
3081 alg, hash, hash_length,
3082 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003083#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3084 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003085 } else {
3086 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003087 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003088 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3089 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003090#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003091 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3092 return mbedtls_psa_ecdsa_sign_hash(
3093 attributes,
3094 key_buffer, key_buffer_size,
3095 alg, hash, hash_length,
3096 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003097#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3098 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003099 } else {
3100 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003101 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003102 }
Ronald Cron4501c982021-03-19 20:09:32 +01003103
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003104 (void) key_buffer;
3105 (void) key_buffer_size;
3106 (void) hash;
3107 (void) hash_length;
3108 (void) signature;
3109 (void) signature_size;
3110 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003111
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003112 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003113}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003114
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003115psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3116 psa_algorithm_t alg,
3117 const uint8_t *hash,
3118 size_t hash_length,
3119 uint8_t *signature,
3120 size_t signature_size,
3121 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003122{
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003123 return psa_sign_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02003124 key, 0, alg, hash, hash_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003125 signature, signature_size, signature_length);
itayzafrir5c753392018-05-08 11:18:38 +03003126}
3127
gabor-mezei-armf3c5c862021-05-05 14:18:36 +02003128psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003129 const psa_key_attributes_t *attributes,
3130 const uint8_t *key_buffer, size_t key_buffer_size,
3131 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003132 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003133{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003134 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3135 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3136 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003137#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003138 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3139 return mbedtls_psa_rsa_verify_hash(
3140 attributes,
3141 key_buffer, key_buffer_size,
3142 alg, hash, hash_length,
3143 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003144#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3145 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003146 } else {
3147 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003148 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003149 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3150 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003151#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003152 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3153 return mbedtls_psa_ecdsa_verify_hash(
3154 attributes,
3155 key_buffer, key_buffer_size,
3156 alg, hash, hash_length,
3157 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003158#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3159 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003160 } else {
3161 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003162 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003163 }
Ronald Cron4501c982021-03-19 20:09:32 +01003164
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003165 (void) key_buffer;
3166 (void) key_buffer_size;
3167 (void) hash;
3168 (void) hash_length;
3169 (void) signature;
3170 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003171
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003172 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003173}
3174
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003175psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3176 psa_algorithm_t alg,
3177 const uint8_t *hash,
3178 size_t hash_length,
3179 const uint8_t *signature,
3180 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003181{
gabor-mezei-armbc0088b2021-04-20 12:11:35 +02003182 return psa_verify_internal(
gabor-mezei-arm56980482021-05-05 13:56:27 +02003183 key, 0, alg, hash, hash_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003184 signature, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003185}
3186
John Durkop0e005192020-10-31 22:06:54 -07003187#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003188static void psa_rsa_oaep_set_padding_mode(psa_algorithm_t alg,
3189 mbedtls_rsa_context *rsa)
Gilles Peskine072ac562018-06-30 00:21:29 +02003190{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003191 psa_algorithm_t hash_alg = PSA_ALG_RSA_OAEP_GET_HASH(alg);
3192 const mbedtls_md_info_t *md_info = mbedtls_md_info_from_psa(hash_alg);
3193 mbedtls_md_type_t md_alg = mbedtls_md_get_type(md_info);
3194 mbedtls_rsa_set_padding(rsa, MBEDTLS_RSA_PKCS_V21, md_alg);
Gilles Peskine072ac562018-06-30 00:21:29 +02003195}
John Durkop0e005192020-10-31 22:06:54 -07003196#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine072ac562018-06-30 00:21:29 +02003197
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003198psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3199 psa_algorithm_t alg,
3200 const uint8_t *input,
3201 size_t input_length,
3202 const uint8_t *salt,
3203 size_t salt_length,
3204 uint8_t *output,
3205 size_t output_size,
3206 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003207{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003208 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003209 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003210 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003211
Darryl Green5cc689a2018-07-24 15:34:10 +01003212 (void) input;
3213 (void) input_length;
3214 (void) salt;
3215 (void) output;
3216 (void) output_size;
3217
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003218 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003219
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003220 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3221 return PSA_ERROR_INVALID_ARGUMENT;
3222 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003223
Ronald Cron5c522922020-11-14 16:35:34 +01003224 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003225 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3226 if (status != PSA_SUCCESS) {
3227 return status;
3228 }
3229 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3230 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003231 status = PSA_ERROR_INVALID_ARGUMENT;
3232 goto exit;
3233 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003234
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003235 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Ronald Cron7207d572021-09-08 14:28:35 +02003236#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003237 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooremana2371e52020-07-28 14:30:39 +02003238 mbedtls_rsa_context *rsa = NULL;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003239 status = mbedtls_psa_rsa_load_representation(slot->attr.type,
3240 slot->key.data,
3241 slot->key.bytes,
3242 &rsa);
3243 if (status != PSA_SUCCESS) {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003244 goto rsa_exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003245 }
Steven Cooremana2371e52020-07-28 14:30:39 +02003246
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003247 if (output_size < mbedtls_rsa_get_len(rsa)) {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003248 status = PSA_ERROR_BUFFER_TOO_SMALL;
3249 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003250 }
Ronald Cron7207d572021-09-08 14:28:35 +02003251#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3252 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003253 if (alg == PSA_ALG_RSA_PKCS1V15_CRYPT) {
Ronald Cron7207d572021-09-08 14:28:35 +02003254#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003255 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003256 mbedtls_rsa_pkcs1_encrypt(rsa,
3257 mbedtls_psa_get_random,
3258 MBEDTLS_PSA_RANDOM_STATE,
3259 MBEDTLS_RSA_PUBLIC,
3260 input_length,
3261 input,
3262 output));
Ronald Cron7207d572021-09-08 14:28:35 +02003263#else
3264 status = PSA_ERROR_NOT_SUPPORTED;
3265#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003266 } else
3267 if (PSA_ALG_IS_RSA_OAEP(alg)) {
Ronald Cron7207d572021-09-08 14:28:35 +02003268#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003269 psa_rsa_oaep_set_padding_mode(alg, rsa);
Steven Cooreman4fed4552020-08-03 14:46:03 +02003270 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003271 mbedtls_rsa_rsaes_oaep_encrypt(rsa,
3272 mbedtls_psa_get_random,
3273 MBEDTLS_PSA_RANDOM_STATE,
3274 MBEDTLS_RSA_PUBLIC,
3275 salt, salt_length,
3276 input_length,
3277 input,
3278 output));
Ronald Cron7207d572021-09-08 14:28:35 +02003279#else
3280 status = PSA_ERROR_NOT_SUPPORTED;
3281#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003282 } else {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003283 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003284 }
Ronald Cron7207d572021-09-08 14:28:35 +02003285#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003286 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003287rsa_exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003288 if (status == PSA_SUCCESS) {
3289 *output_length = mbedtls_rsa_get_len(rsa);
3290 }
Steven Cooremana01795d2020-07-24 22:48:15 +02003291
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003292 mbedtls_rsa_free(rsa);
3293 mbedtls_free(rsa);
John Durkop9814fa22020-11-04 12:28:15 -08003294#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
John Durkop6ba40d12020-11-10 08:50:04 -08003295 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003296 } else {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003297 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003298 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003299
3300exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003301 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003302
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003303 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003304}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003305
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003306psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3307 psa_algorithm_t alg,
3308 const uint8_t *input,
3309 size_t input_length,
3310 const uint8_t *salt,
3311 size_t salt_length,
3312 uint8_t *output,
3313 size_t output_size,
3314 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003315{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003316 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003317 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003318 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003319
Darryl Green5cc689a2018-07-24 15:34:10 +01003320 (void) input;
3321 (void) input_length;
3322 (void) salt;
3323 (void) output;
3324 (void) output_size;
3325
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003326 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003327
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003328 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3329 return PSA_ERROR_INVALID_ARGUMENT;
3330 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003331
Ronald Cron5c522922020-11-14 16:35:34 +01003332 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003333 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3334 if (status != PSA_SUCCESS) {
3335 return status;
3336 }
3337 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003338 status = PSA_ERROR_INVALID_ARGUMENT;
3339 goto exit;
3340 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003341
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003342 if (slot->attr.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
Ronald Cron7207d572021-09-08 14:28:35 +02003343#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003344 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003345 mbedtls_rsa_context *rsa = NULL;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003346 status = mbedtls_psa_rsa_load_representation(slot->attr.type,
3347 slot->key.data,
3348 slot->key.bytes,
3349 &rsa);
3350 if (status != PSA_SUCCESS) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003351 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003352 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003353
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003354 if (input_length != mbedtls_rsa_get_len(rsa)) {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003355 status = PSA_ERROR_INVALID_ARGUMENT;
3356 goto rsa_exit;
Steven Cooremana01795d2020-07-24 22:48:15 +02003357 }
Ronald Cron7207d572021-09-08 14:28:35 +02003358#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3359 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003360
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003361 if (alg == PSA_ALG_RSA_PKCS1V15_CRYPT) {
Ronald Cron7207d572021-09-08 14:28:35 +02003362#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003363 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003364 mbedtls_rsa_pkcs1_decrypt(rsa,
3365 mbedtls_psa_get_random,
3366 MBEDTLS_PSA_RANDOM_STATE,
3367 MBEDTLS_RSA_PRIVATE,
3368 output_length,
3369 input,
3370 output,
3371 output_size));
Ronald Cron7207d572021-09-08 14:28:35 +02003372#else
3373 status = PSA_ERROR_NOT_SUPPORTED;
3374#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003375 } else
3376 if (PSA_ALG_IS_RSA_OAEP(alg)) {
Ronald Cron7207d572021-09-08 14:28:35 +02003377#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003378 psa_rsa_oaep_set_padding_mode(alg, rsa);
Steven Cooreman4fed4552020-08-03 14:46:03 +02003379 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003380 mbedtls_rsa_rsaes_oaep_decrypt(rsa,
3381 mbedtls_psa_get_random,
3382 MBEDTLS_PSA_RANDOM_STATE,
3383 MBEDTLS_RSA_PRIVATE,
3384 salt, salt_length,
3385 output_length,
3386 input,
3387 output,
3388 output_size));
Ronald Cron7207d572021-09-08 14:28:35 +02003389#else
3390 status = PSA_ERROR_NOT_SUPPORTED;
3391#endif /* MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003392 } else {
Steven Cooreman4fed4552020-08-03 14:46:03 +02003393 status = PSA_ERROR_INVALID_ARGUMENT;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003394 }
Nir Sonnenschein717a0402018-06-04 16:36:15 +03003395
Ronald Cron7207d572021-09-08 14:28:35 +02003396#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) || \
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003397 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP)
Steven Cooreman4fed4552020-08-03 14:46:03 +02003398rsa_exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003399 mbedtls_rsa_free(rsa);
3400 mbedtls_free(rsa);
John Durkop6ba40d12020-11-10 08:50:04 -08003401#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_CRYPT) ||
3402 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_OAEP) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003403 } else {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003404 status = PSA_ERROR_NOT_SUPPORTED;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003405 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003406
3407exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003408 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003409
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003410 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003411}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003412
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003413
3414
mohammad1603503973b2018-03-12 15:59:30 +02003415/****************************************************************/
3416/* Symmetric cryptography */
3417/****************************************************************/
3418
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003419static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
3420 mbedtls_svc_key_id_t key,
3421 psa_algorithm_t alg,
3422 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02003423{
3424 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3425 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003426 psa_key_attributes_t attributes;
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003427 psa_key_slot_t *slot = NULL;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003428 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
3429 PSA_KEY_USAGE_ENCRYPT :
3430 PSA_KEY_USAGE_DECRYPT);
Ronald Cronab99ac22020-10-01 16:38:28 +02003431
3432 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003433 if (operation->id != 0) {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003434 status = PSA_ERROR_BAD_STATE;
3435 goto exit;
3436 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003437
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003438 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgmancccb05d2021-06-24 11:52:47 +01003439 status = PSA_ERROR_INVALID_ARGUMENT;
3440 goto exit;
3441 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003442
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003443 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
3444 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003445 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003446 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003447
Ronald Cron49fafa92021-03-10 08:34:23 +01003448 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02003449 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01003450 * so we only set it (in the driver wrapper) after resources have been
3451 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02003452 operation->iv_set = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003453 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02003454 operation->iv_required = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003455 } else if (slot->attr.type == PSA_KEY_TYPE_ARC4) {
Gilles Peskine4a83c102022-04-20 17:00:22 +02003456 operation->iv_required = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003457 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02003458 operation->iv_required = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003459 }
3460 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02003461
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003462 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003463 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01003464 };
3465
Ronald Cronab99ac22020-10-01 16:38:28 +02003466 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003467 if (cipher_operation == MBEDTLS_ENCRYPT) {
3468 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
3469 &attributes,
3470 slot->key.data,
3471 slot->key.bytes,
3472 alg);
3473 } else {
3474 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
3475 &attributes,
3476 slot->key.data,
3477 slot->key.bytes,
3478 alg);
3479 }
Ronald Cronab99ac22020-10-01 16:38:28 +02003480
Gilles Peskine9ab61b62019-02-25 17:43:14 +01003481exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003482 if (status != PSA_SUCCESS) {
3483 psa_cipher_abort(operation);
3484 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02003485
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003486 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003487
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003488 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02003489}
3490
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003491psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
3492 mbedtls_svc_key_id_t key,
3493 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003494{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003495 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003496}
3497
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003498psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
3499 mbedtls_svc_key_id_t key,
3500 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02003501{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003502 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02003503}
3504
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003505psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
3506 uint8_t *iv,
3507 size_t iv_size,
3508 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02003509{
Ronald Cron6d051732020-10-01 14:10:20 +02003510 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc423acb2021-07-05 12:31:44 +02003511 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergey04eb7c02023-03-06 15:37:23 -07003512 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01003513
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003514 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003515 status = PSA_ERROR_BAD_STATE;
3516 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003517 }
3518
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003519 if (operation->iv_set || !operation->iv_required) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003520 status = PSA_ERROR_BAD_STATE;
3521 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003522 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003523
Ronald Cronc423acb2021-07-05 12:31:44 +02003524 default_iv_length = operation->default_iv_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003525 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01003526 status = PSA_ERROR_BUFFER_TOO_SMALL;
3527 goto exit;
3528 }
Gilles Peskinee553c652018-06-04 16:22:46 +02003529
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003530 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc423acb2021-07-05 12:31:44 +02003531 status = PSA_ERROR_GENERIC_ERROR;
3532 goto exit;
3533 }
3534
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003535 status = psa_generate_random(local_iv, default_iv_length);
3536 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01003537 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003538 }
Ronald Cron5618a392021-03-26 09:52:26 +01003539
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003540 status = psa_driver_wrapper_cipher_set_iv(operation,
3541 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01003542
3543exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003544 if (status == PSA_SUCCESS) {
3545 memcpy(iv, local_iv, default_iv_length);
Ronald Cronc423acb2021-07-05 12:31:44 +02003546 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02003547 operation->iv_set = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003548 } else {
Ronald Cronc423acb2021-07-05 12:31:44 +02003549 *iv_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003550 psa_cipher_abort(operation);
Ronald Cronc423acb2021-07-05 12:31:44 +02003551 }
Ronald Cron6d051732020-10-01 14:10:20 +02003552
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003553 return status;
mohammad1603503973b2018-03-12 15:59:30 +02003554}
3555
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003556psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
3557 const uint8_t *iv,
3558 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02003559{
Ronald Cron6d051732020-10-01 14:10:20 +02003560 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02003561
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003562 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003563 status = PSA_ERROR_BAD_STATE;
3564 goto exit;
3565 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02003566
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003567 if (operation->iv_set || !operation->iv_required) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003568 status = PSA_ERROR_BAD_STATE;
3569 goto exit;
3570 }
Ronald Crona0d68172021-03-26 10:15:08 +01003571
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003572 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003573 status = PSA_ERROR_INVALID_ARGUMENT;
3574 goto exit;
3575 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02003576
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003577 status = psa_driver_wrapper_cipher_set_iv(operation,
3578 iv,
3579 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02003580
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003581exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003582 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03003583 operation->iv_set = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003584 } else {
3585 psa_cipher_abort(operation);
3586 }
3587 return status;
mohammad1603503973b2018-03-12 15:59:30 +02003588}
3589
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003590psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
3591 const uint8_t *input,
3592 size_t input_length,
3593 uint8_t *output,
3594 size_t output_size,
3595 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02003596{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02003597 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02003598
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003599 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003600 status = PSA_ERROR_BAD_STATE;
3601 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003602 }
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003603
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003604 if (operation->iv_required && !operation->iv_set) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003605 status = PSA_ERROR_BAD_STATE;
3606 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003607 }
Jaeden Ameroab439972019-02-15 14:12:05 +00003608
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003609 status = psa_driver_wrapper_cipher_update(operation,
3610 input,
3611 input_length,
3612 output,
3613 output_size,
3614 output_length);
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003615
3616exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003617 if (status != PSA_SUCCESS) {
3618 psa_cipher_abort(operation);
3619 }
Ronald Cron6d051732020-10-01 14:10:20 +02003620
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003621 return status;
mohammad1603503973b2018-03-12 15:59:30 +02003622}
3623
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003624psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
3625 uint8_t *output,
3626 size_t output_size,
3627 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02003628{
David Saadab4ecc272019-02-14 13:48:10 +02003629 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02003630
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003631 if (operation->id == 0) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003632 status = PSA_ERROR_BAD_STATE;
3633 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003634 }
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003635
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003636 if (operation->iv_required && !operation->iv_set) {
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003637 status = PSA_ERROR_BAD_STATE;
3638 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02003639 }
Moran Pekerbed71a22018-04-22 20:19:20 +03003640
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003641 status = psa_driver_wrapper_cipher_finish(operation,
3642 output,
3643 output_size,
3644 output_length);
Dave Rodgmanc88b0a52021-06-23 11:38:39 +01003645
3646exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003647 if (status == PSA_SUCCESS) {
3648 return psa_cipher_abort(operation);
3649 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02003650 *output_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003651 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01003652
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003653 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02003654 }
mohammad1603503973b2018-03-12 15:59:30 +02003655}
3656
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003657psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02003658{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003659 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02003660 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02003661 * in use. It's ok to call abort on such an object, and there's
3662 * nothing to do. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003663 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02003664 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02003665
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003666 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02003667
Ronald Cron49fafa92021-03-10 08:34:23 +01003668 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003669 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03003670 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03003671
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003672 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02003673}
3674
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003675psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
3676 psa_algorithm_t alg,
David Horstmann926193a2023-12-13 15:55:25 +00003677 const uint8_t *input_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003678 size_t input_length,
David Horstmann926193a2023-12-13 15:55:25 +00003679 uint8_t *output_external,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003680 size_t output_size,
3681 size_t *output_length)
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003682{
3683 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003684 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003685 psa_key_attributes_t attributes;
Ronald Cron16377072021-07-08 19:00:07 +02003686 psa_key_slot_t *slot = NULL;
Ronald Cron4c224fe2021-07-09 18:44:58 +02003687 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
3688 size_t default_iv_length = 0;
gabor-mezei-arm52ae8712021-06-25 15:21:11 +02003689
David Horstmannb80e35a2023-12-14 18:12:47 +00003690 LOCAL_INPUT_DECLARE(input_external, input);
3691 LOCAL_OUTPUT_DECLARE(output_external, output);
3692
David Horstmann926193a2023-12-13 15:55:25 +00003693 LOCAL_INPUT_ALLOC(input_external, input_length, input);
David Horstmann926193a2023-12-13 15:55:25 +00003694 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmannd2ad8862023-11-27 17:43:05 +00003695
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003696 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron16377072021-07-08 19:00:07 +02003697 status = PSA_ERROR_INVALID_ARGUMENT;
3698 goto exit;
3699 }
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003700
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003701 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3702 PSA_KEY_USAGE_ENCRYPT,
3703 alg);
3704 if (status != PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003705 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003706 }
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003707
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003708 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003709 .core = slot->attr
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003710 };
3711
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003712 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
3713 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron4c224fe2021-07-09 18:44:58 +02003714 status = PSA_ERROR_GENERIC_ERROR;
3715 goto exit;
3716 }
3717
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003718 if (default_iv_length > 0) {
3719 if (output_size < default_iv_length) {
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003720 status = PSA_ERROR_BUFFER_TOO_SMALL;
3721 goto exit;
3722 }
3723
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003724 status = psa_generate_random(local_iv, default_iv_length);
3725 if (status != PSA_SUCCESS) {
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003726 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003727 }
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003728 }
3729
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003730 status = psa_driver_wrapper_cipher_encrypt(
3731 &attributes, slot->key.data, slot->key.bytes,
Ronald Cron4c224fe2021-07-09 18:44:58 +02003732 alg, local_iv, default_iv_length, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003733 mbedtls_buffer_offset(output, default_iv_length),
3734 output_size - default_iv_length, output_length);
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003735
3736exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003737 unlock_status = psa_unlock_key_slot(slot);
3738 if (status == PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003739 status = unlock_status;
Ronald Cron4c224fe2021-07-09 18:44:58 +02003740 }
Ronald Cron16377072021-07-08 19:00:07 +02003741
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003742 if (status == PSA_SUCCESS) {
3743 if (default_iv_length > 0) {
3744 memcpy(output, local_iv, default_iv_length);
3745 }
3746 *output_length += default_iv_length;
3747 } else {
3748 *output_length = 0;
3749 }
3750
David Horstmannb80e35a2023-12-14 18:12:47 +00003751 LOCAL_INPUT_FREE(input_external, input);
3752 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannd2ad8862023-11-27 17:43:05 +00003753
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003754 return status;
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003755}
3756
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003757psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
3758 psa_algorithm_t alg,
3759 const uint8_t *input,
3760 size_t input_length,
3761 uint8_t *output,
3762 size_t output_size,
3763 size_t *output_length)
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003764{
3765 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003766 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003767 psa_key_attributes_t attributes;
Ronald Cron16377072021-07-08 19:00:07 +02003768 psa_key_slot_t *slot = NULL;
gabor-mezei-arm52ae8712021-06-25 15:21:11 +02003769
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003770 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron16377072021-07-08 19:00:07 +02003771 status = PSA_ERROR_INVALID_ARGUMENT;
3772 goto exit;
3773 }
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003774
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003775 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3776 PSA_KEY_USAGE_DECRYPT,
3777 alg);
3778 if (status != PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003779 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003780 }
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003781
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01003782 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003783 .core = slot->attr
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003784 };
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003785
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003786 if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm3fd792d2021-06-25 15:25:38 +02003787 status = PSA_ERROR_INVALID_ARGUMENT;
3788 goto exit;
3789 }
3790
gabor-mezei-armfa990b52021-03-25 11:17:10 +01003791 status = psa_driver_wrapper_cipher_decrypt(
3792 &attributes, slot->key.data, slot->key.bytes,
3793 alg, input, input_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003794 output, output_size, output_length);
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003795
gabor-mezei-arm3fd792d2021-06-25 15:25:38 +02003796exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003797 unlock_status = psa_unlock_key_slot(slot);
3798 if (status == PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003799 status = unlock_status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003800 }
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003801
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003802 if (status != PSA_SUCCESS) {
Ronald Cron16377072021-07-08 19:00:07 +02003803 *output_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003804 }
Ronald Cron16377072021-07-08 19:00:07 +02003805
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003806 return status;
gabor-mezei-arm0ef3b852021-03-01 15:04:24 +01003807}
3808
3809
mohammad16035955c982018-04-26 00:53:03 +03003810/****************************************************************/
3811/* AEAD */
3812/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003813
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003814psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
3815 psa_algorithm_t alg,
3816 const uint8_t *nonce,
3817 size_t nonce_length,
3818 const uint8_t *additional_data,
3819 size_t additional_data_length,
3820 const uint8_t *plaintext,
3821 size_t plaintext_length,
3822 uint8_t *ciphertext,
3823 size_t ciphertext_size,
3824 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03003825{
Ronald Cron215633c2021-03-16 17:15:37 +01003826 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3827 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003828
mohammad1603f08a5502018-06-03 15:05:47 +03003829 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07003830
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003831 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
3832 return PSA_ERROR_NOT_SUPPORTED;
3833 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01003834
Ronald Cron9a986162021-03-26 12:40:07 +01003835 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003836 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3837 if (status != PSA_SUCCESS) {
3838 return status;
3839 }
mohammad16035955c982018-04-26 00:53:03 +03003840
Ronald Cron215633c2021-03-16 17:15:37 +01003841 psa_key_attributes_t attributes = {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003842 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01003843 };
mohammad16035955c982018-04-26 00:53:03 +03003844
Ronald Cronde822812021-03-17 16:08:20 +01003845 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003846 &attributes, slot->key.data, slot->key.bytes,
3847 alg,
3848 nonce, nonce_length,
3849 additional_data, additional_data_length,
3850 plaintext, plaintext_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003851 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02003852
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003853 if (status != PSA_SUCCESS && ciphertext_size != 0) {
3854 memset(ciphertext, 0, ciphertext_size);
3855 }
Gilles Peskine2d277862018-06-18 15:41:12 +02003856
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003857 psa_unlock_key_slot(slot);
mohammad16035955c982018-04-26 00:53:03 +03003858
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003859 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02003860}
3861
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003862psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
3863 psa_algorithm_t alg,
3864 const uint8_t *nonce,
3865 size_t nonce_length,
3866 const uint8_t *additional_data,
3867 size_t additional_data_length,
3868 const uint8_t *ciphertext,
3869 size_t ciphertext_length,
3870 uint8_t *plaintext,
3871 size_t plaintext_size,
3872 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03003873{
Ronald Cron215633c2021-03-16 17:15:37 +01003874 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3875 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02003876
Gilles Peskineee652a32018-06-01 19:23:52 +02003877 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03003878
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003879 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
3880 return PSA_ERROR_NOT_SUPPORTED;
3881 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01003882
Ronald Cron9a986162021-03-26 12:40:07 +01003883 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003884 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3885 if (status != PSA_SUCCESS) {
3886 return status;
3887 }
mohammad16035955c982018-04-26 00:53:03 +03003888
Ronald Cron215633c2021-03-16 17:15:37 +01003889 psa_key_attributes_t attributes = {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003890 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01003891 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02003892
Ronald Cronde822812021-03-17 16:08:20 +01003893 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01003894 &attributes, slot->key.data, slot->key.bytes,
3895 alg,
3896 nonce, nonce_length,
3897 additional_data, additional_data_length,
3898 ciphertext, ciphertext_length,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003899 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02003900
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003901 if (status != PSA_SUCCESS && plaintext_size != 0) {
3902 memset(plaintext, 0, plaintext_size);
3903 }
mohammad160360a64d02018-06-03 17:20:42 +03003904
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003905 psa_unlock_key_slot(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01003906
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003907 return status;
mohammad16035955c982018-04-26 00:53:03 +03003908}
3909
Gilles Peskinee59236f2018-01-27 23:32:46 +01003910/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02003911/* Generators */
3912/****************************************************************/
3913
John Durkop07cc04a2020-11-16 22:08:34 -08003914#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3915 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3916 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3917#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman9878a162021-05-06 17:58:36 +02003918#endif /* At least one builtin KDF */
3919
3920#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
3921 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3922 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
3923static psa_status_t psa_key_derivation_start_hmac(
3924 psa_mac_operation_t *operation,
3925 psa_algorithm_t hash_alg,
3926 const uint8_t *hmac_key,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003927 size_t hmac_key_length)
Steven Cooreman9878a162021-05-06 17:58:36 +02003928{
3929 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3930 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003931 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
3932 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
3933 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman9878a162021-05-06 17:58:36 +02003934
Steven Cooreman15f0d922021-05-07 14:14:37 +02003935 operation->is_sign = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003936 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman15f0d922021-05-07 14:14:37 +02003937
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003938 status = psa_driver_wrapper_mac_sign_setup(operation,
3939 &attributes,
3940 hmac_key, hmac_key_length,
3941 PSA_ALG_HMAC(hash_alg));
Steven Cooreman9878a162021-05-06 17:58:36 +02003942
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003943 psa_reset_key_attributes(&attributes);
3944 return status;
Steven Cooreman9878a162021-05-06 17:58:36 +02003945}
3946#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08003947
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01003948#define HKDF_STATE_INIT 0 /* no input yet */
3949#define HKDF_STATE_STARTED 1 /* got salt */
3950#define HKDF_STATE_KEYED 2 /* got key */
3951#define HKDF_STATE_OUTPUT 3 /* output started */
3952
Gilles Peskinecbe66502019-05-16 16:59:18 +02003953static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003954 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01003955{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003956 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
3957 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
3958 } else {
3959 return operation->alg;
3960 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01003961}
3962
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003963psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02003964{
3965 psa_status_t status = PSA_SUCCESS;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003966 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
3967 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02003968 /* The object has (apparently) been initialized but it is not
3969 * in use. It's ok to call abort on such an object, and there's
3970 * nothing to do. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003971 } else
John Durkopd0321952020-10-29 21:37:36 -07003972#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003973 if (PSA_ALG_IS_HKDF(kdf_alg)) {
3974 mbedtls_free(operation->ctx.hkdf.info);
3975 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
3976 } else
John Durkop07cc04a2020-11-16 22:08:34 -08003977#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF */
3978#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
3979 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003980 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
3981 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
3982 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
3983 if (operation->ctx.tls12_prf.secret != NULL) {
3984 mbedtls_platform_zeroize(operation->ctx.tls12_prf.secret,
3985 operation->ctx.tls12_prf.secret_length);
3986 mbedtls_free(operation->ctx.tls12_prf.secret);
Steven Cooreman22dea1d2021-04-29 19:32:25 +02003987 }
3988
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003989 if (operation->ctx.tls12_prf.seed != NULL) {
3990 mbedtls_platform_zeroize(operation->ctx.tls12_prf.seed,
3991 operation->ctx.tls12_prf.seed_length);
3992 mbedtls_free(operation->ctx.tls12_prf.seed);
Janos Follath6a1d2622019-06-11 10:37:28 +01003993 }
3994
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003995 if (operation->ctx.tls12_prf.label != NULL) {
3996 mbedtls_platform_zeroize(operation->ctx.tls12_prf.label,
3997 operation->ctx.tls12_prf.label_length);
3998 mbedtls_free(operation->ctx.tls12_prf.label);
Janos Follath6a1d2622019-06-11 10:37:28 +01003999 }
4000
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004001 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01004002
4003 /* We leave the fields Ai and output_block to be erased safely by the
4004 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004005 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004006#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4007 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004008 {
4009 status = PSA_ERROR_BAD_STATE;
4010 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004011 mbedtls_platform_zeroize(operation, sizeof(*operation));
4012 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004013}
4014
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004015psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004016 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02004017{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004018 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004019 /* This is a blank key derivation operation. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004020 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004021 }
4022
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004023 *capacity = operation->capacity;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004024 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004025}
4026
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004027psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
4028 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004029{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004030 if (operation->alg == 0) {
4031 return PSA_ERROR_BAD_STATE;
4032 }
4033 if (capacity > operation->capacity) {
4034 return PSA_ERROR_INVALID_ARGUMENT;
4035 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004036 operation->capacity = capacity;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004037 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004038}
4039
John Durkopd0321952020-10-29 21:37:36 -07004040#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004041/* Read some bytes from an HKDF-based operation. This performs a chunk
Gilles Peskinebef7f142018-07-12 17:22:21 +02004042 * of the expand phase of the HKDF algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004043static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
4044 psa_algorithm_t hash_alg,
4045 uint8_t *output,
4046 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02004047{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004048 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremanb27e3502021-04-29 19:11:25 +02004049 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004050 psa_status_t status;
4051
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004052 if (hkdf->state < HKDF_STATE_KEYED || !hkdf->info_set) {
4053 return PSA_ERROR_BAD_STATE;
4054 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004055 hkdf->state = HKDF_STATE_OUTPUT;
4056
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004057 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02004058 /* Copy what remains of the current block */
4059 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004060 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02004061 n = (uint8_t) output_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004062 }
4063 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02004064 output += n;
4065 output_length -= n;
4066 hkdf->offset_in_block += n;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004067 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02004068 break;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004069 }
Gilles Peskined54931c2018-07-17 21:06:59 +02004070 /* We can't be wanting more output after block 0xff, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02004071 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004072 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02004073 * object was corrupted or if this function is called directly
4074 * inside the library. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004075 if (hkdf->block_number == 0xff) {
4076 return PSA_ERROR_BAD_STATE;
4077 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004078
4079 /* We need a new block */
4080 ++hkdf->block_number;
4081 hkdf->offset_in_block = 0;
Steven Cooremanb27e3502021-04-29 19:11:25 +02004082
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004083 status = psa_key_derivation_start_hmac(&hkdf->hmac,
4084 hash_alg,
4085 hkdf->prk,
4086 hash_length);
4087 if (status != PSA_SUCCESS) {
4088 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004089 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004090
4091 if (hkdf->block_number != 1) {
4092 status = psa_mac_update(&hkdf->hmac,
4093 hkdf->output_block,
4094 hash_length);
4095 if (status != PSA_SUCCESS) {
4096 return status;
4097 }
4098 }
4099 status = psa_mac_update(&hkdf->hmac,
4100 hkdf->info,
4101 hkdf->info_length);
4102 if (status != PSA_SUCCESS) {
4103 return status;
4104 }
4105 status = psa_mac_update(&hkdf->hmac,
4106 &hkdf->block_number, 1);
4107 if (status != PSA_SUCCESS) {
4108 return status;
4109 }
4110 status = psa_mac_sign_finish(&hkdf->hmac,
4111 hkdf->output_block,
4112 sizeof(hkdf->output_block),
4113 &hmac_output_length);
4114 if (status != PSA_SUCCESS) {
4115 return status;
4116 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02004117 }
4118
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004119 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02004120}
John Durkop07cc04a2020-11-16 22:08:34 -08004121#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004122
John Durkop07cc04a2020-11-16 22:08:34 -08004123#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4124 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01004125static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
4126 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004127 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01004128{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004129 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
4130 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004131 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
4132 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01004133 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004134
Janos Follath7742fee2019-06-17 12:58:10 +01004135 /* We can't be wanting more output after block 0xff, otherwise
4136 * the capacity check in psa_key_derivation_output_bytes() would have
4137 * prevented this call. It could happen only if the operation
4138 * object was corrupted or if this function is called directly
4139 * inside the library. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004140 if (tls12_prf->block_number == 0xff) {
4141 return PSA_ERROR_CORRUPTION_DETECTED;
4142 }
Janos Follath7742fee2019-06-17 12:58:10 +01004143
4144 /* We need a new block */
4145 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01004146 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01004147
4148 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
4149 *
4150 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
4151 *
4152 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
4153 * HMAC_hash(secret, A(2) + seed) +
4154 * HMAC_hash(secret, A(3) + seed) + ...
4155 *
4156 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01004157 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01004158 *
Janos Follathea29bfb2019-06-19 12:21:20 +01004159 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01004160 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01004161 * is currently extracted as `output_block` and where i is
4162 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01004163 */
4164
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004165 status = psa_key_derivation_start_hmac(&hmac,
4166 hash_alg,
4167 tls12_prf->secret,
4168 tls12_prf->secret_length);
4169 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004170 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004171 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004172
4173 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004174 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004175 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
4176 * the variable seed and in this instance means it in the context of the
4177 * P_hash function, where seed = label + seed.) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004178 status = psa_mac_update(&hmac,
4179 tls12_prf->label,
4180 tls12_prf->label_length);
4181 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004182 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004183 }
4184 status = psa_mac_update(&hmac,
4185 tls12_prf->seed,
4186 tls12_prf->seed_length);
4187 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004188 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004189 }
4190 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01004191 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004192 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
4193 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004194 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004195 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004196 }
4197
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004198 status = psa_mac_sign_finish(&hmac,
4199 tls12_prf->Ai, hash_length,
4200 &hmac_output_length);
4201 if (hmac_output_length != hash_length) {
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004202 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004203 }
4204 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004205 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004206 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004207
4208 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004209 status = psa_key_derivation_start_hmac(&hmac,
4210 hash_alg,
4211 tls12_prf->secret,
4212 tls12_prf->secret_length);
4213 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004214 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004215 }
4216 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
4217 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004218 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004219 }
4220 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
4221 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004222 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004223 }
4224 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
4225 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004226 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004227 }
4228 status = psa_mac_sign_finish(&hmac,
4229 tls12_prf->output_block, hash_length,
4230 &hmac_output_length);
4231 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004232 goto cleanup;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004233 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004234
Janos Follath7742fee2019-06-17 12:58:10 +01004235
4236cleanup:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004237 cleanup_status = psa_mac_abort(&hmac);
4238 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01004239 status = cleanup_status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004240 }
Janos Follathea29bfb2019-06-19 12:21:20 +01004241
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004242 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01004243}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01004244
Janos Follath844eb0e2019-06-19 12:10:49 +01004245static psa_status_t psa_key_derivation_tls12_prf_read(
4246 psa_tls12_prf_key_derivation_t *tls12_prf,
4247 psa_algorithm_t alg,
4248 uint8_t *output,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004249 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01004250{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004251 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
4252 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01004253 psa_status_t status;
4254 uint8_t offset, length;
4255
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004256 switch (tls12_prf->state) {
Gilles Peskinef216f0d2021-06-11 22:41:46 +02004257 case PSA_TLS12_PRF_STATE_LABEL_SET:
4258 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
4259 break;
4260 case PSA_TLS12_PRF_STATE_OUTPUT:
4261 break;
4262 default:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004263 return PSA_ERROR_BAD_STATE;
Gilles Peskinef216f0d2021-06-11 22:41:46 +02004264 }
4265
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004266 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01004267 /* Check if we have fully processed the current block. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004268 if (tls12_prf->left_in_block == 0) {
4269 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
4270 alg);
4271 if (status != PSA_SUCCESS) {
4272 return status;
4273 }
Janos Follath844eb0e2019-06-19 12:10:49 +01004274
4275 continue;
4276 }
4277
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004278 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01004279 length = (uint8_t) output_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004280 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01004281 length = tls12_prf->left_in_block;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004282 }
Janos Follath844eb0e2019-06-19 12:10:49 +01004283
4284 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004285 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01004286 output += length;
4287 output_length -= length;
4288 tls12_prf->left_in_block -= length;
4289 }
4290
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004291 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01004292}
John Durkop07cc04a2020-11-16 22:08:34 -08004293#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4294 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02004295
Janos Follath6c6c8fc2019-06-17 12:38:20 +01004296psa_status_t psa_key_derivation_output_bytes(
4297 psa_key_derivation_operation_t *operation,
4298 uint8_t *output,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004299 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02004300{
4301 psa_status_t status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004302 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02004303
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004304 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004305 /* This is a blank operation. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004306 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004307 }
4308
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004309 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004310 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004311 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004312 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02004313 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004314 goto exit;
4315 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004316 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004317 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004318 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02004319 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
4320 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004321 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02004322 * output_length > 0. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004323 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004324 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004325 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004326
John Durkopd0321952020-10-29 21:37:36 -07004327#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004328 if (PSA_ALG_IS_HKDF(kdf_alg)) {
4329 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
4330 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, hash_alg,
4331 output, output_length);
4332 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004333#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4334#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4335 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004336 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
4337 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
4338 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
4339 kdf_alg, output,
4340 output_length);
4341 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004342#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
4343 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineeab56e42018-07-12 17:12:33 +02004344 {
Steven Cooreman74afe472021-02-10 17:19:22 +01004345 (void) kdf_alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004346 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004347 }
4348
4349exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004350 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00004351 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004352 * This allows us to differentiate between exhausted operations and
4353 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
4354 * operations. */
4355 psa_algorithm_t alg = operation->alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004356 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004357 operation->alg = alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004358 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02004359 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004360 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004361}
4362
David Brown7807bf72021-02-09 16:28:23 -07004363#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004364static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02004365{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004366 if (data_size >= 8) {
4367 mbedtls_des_key_set_parity(data);
4368 }
4369 if (data_size >= 16) {
4370 mbedtls_des_key_set_parity(data + 8);
4371 }
4372 if (data_size >= 24) {
4373 mbedtls_des_key_set_parity(data + 16);
4374 }
Gilles Peskine08542d82018-07-19 17:05:42 +02004375}
David Brown7807bf72021-02-09 16:28:23 -07004376#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02004377
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01004378static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004379 psa_key_slot_t *slot,
4380 size_t bits,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004381 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02004382{
4383 uint8_t *data = NULL;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004384 size_t bytes = PSA_BITS_TO_BYTES(bits);
Gilles Peskineeab56e42018-07-12 17:12:33 +02004385 psa_status_t status;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01004386 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004387
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004388 if (!key_type_is_raw_bytes(slot->attr.type)) {
4389 return PSA_ERROR_INVALID_ARGUMENT;
4390 }
4391 if (bits % 8 != 0) {
4392 return PSA_ERROR_INVALID_ARGUMENT;
4393 }
4394 data = mbedtls_calloc(1, bytes);
4395 if (data == NULL) {
4396 return PSA_ERROR_INSUFFICIENT_MEMORY;
4397 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02004398
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004399 status = psa_key_derivation_output_bytes(operation, data, bytes);
4400 if (status != PSA_SUCCESS) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02004401 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004402 }
David Brown12ca5032021-02-11 11:02:00 -07004403#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004404 if (slot->attr.type == PSA_KEY_TYPE_DES) {
4405 psa_des_set_key_parity(data, bytes);
4406 }
David Brown8107e312021-02-12 08:08:46 -07004407#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Ronald Crondd04d422020-11-28 15:14:42 +01004408
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004409 status = psa_allocate_buffer_to_slot(slot, bytes);
4410 if (status != PSA_SUCCESS) {
Paul Elliottda3e7db2021-02-09 18:58:20 +00004411 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004412 }
Ronald Crondd04d422020-11-28 15:14:42 +01004413
Ronald Cronbf33c932020-11-28 18:06:53 +01004414 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01004415 attributes = (psa_key_attributes_t) {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004416 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01004417 };
4418
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004419 status = psa_driver_wrapper_import_key(&attributes,
4420 data, bytes,
4421 slot->key.data,
4422 slot->key.bytes,
4423 &slot->key.bytes, &bits);
4424 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01004425 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004426 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02004427
4428exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004429 mbedtls_free(data);
4430 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02004431}
4432
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004433psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
4434 psa_key_derivation_operation_t *operation,
4435 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004436{
4437 psa_status_t status;
4438 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02004439 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02004440
Ronald Cron81709fc2020-11-14 12:10:32 +01004441 *key = MBEDTLS_SVC_KEY_ID_INIT;
4442
Gilles Peskine0f84d622019-09-12 19:03:13 +02004443 /* Reject any attempt to create a zero-length key so that we don't
4444 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004445 if (psa_get_key_bits(attributes) == 0) {
4446 return PSA_ERROR_INVALID_ARGUMENT;
4447 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02004448
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004449 if (operation->alg == PSA_ALG_NONE) {
4450 return PSA_ERROR_BAD_STATE;
4451 }
Dave Rodgman021e7242021-11-16 10:32:48 +00004452
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004453 if (!operation->can_output_key) {
4454 return PSA_ERROR_NOT_PERMITTED;
4455 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004456
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004457 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
4458 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004459#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004460 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02004461 /* Deriving a key in a secure element is not implemented yet. */
4462 status = PSA_ERROR_NOT_SUPPORTED;
4463 }
4464#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004465 if (status == PSA_SUCCESS) {
4466 status = psa_generate_derived_key_internal(slot,
4467 attributes->core.bits,
4468 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004469 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004470 if (status == PSA_SUCCESS) {
4471 status = psa_finish_key_creation(slot, driver, key);
4472 }
4473 if (status != PSA_SUCCESS) {
4474 psa_fail_key_creation(slot, driver);
4475 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004476
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004477 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02004478}
4479
Gilles Peskineeab56e42018-07-12 17:12:33 +02004480
4481
4482/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02004483/* Key derivation */
4484/****************************************************************/
4485
Steven Cooreman932ffb72021-02-15 12:14:32 +01004486#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004487static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskinecdacf042021-04-29 21:10:00 +02004488{
4489#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004490 if (PSA_ALG_IS_HKDF(kdf_alg)) {
4491 return 1;
4492 }
Gilles Peskinecdacf042021-04-29 21:10:00 +02004493#endif
4494#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004495 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
4496 return 1;
4497 }
Gilles Peskinecdacf042021-04-29 21:10:00 +02004498#endif
4499#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004500 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
4501 return 1;
4502 }
Gilles Peskinecdacf042021-04-29 21:10:00 +02004503#endif
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004504 return 0;
Gilles Peskinecdacf042021-04-29 21:10:00 +02004505}
4506
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004507static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004508{
4509 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004510 psa_status_t status = psa_hash_setup(&operation, alg);
4511 psa_hash_abort(&operation);
4512 return status;
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004513}
4514
Gilles Peskine969c5d62019-01-16 15:53:06 +01004515static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004516 psa_key_derivation_operation_t *operation,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004517 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004518{
Janos Follath5fe19732019-06-20 15:09:30 +01004519 /* Make sure that operation->ctx is properly zero-initialised. (Macro
4520 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004521 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01004522
Gilles Peskine969c5d62019-01-16 15:53:06 +01004523 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004524 if (!is_kdf_alg_supported(kdf_alg)) {
4525 return PSA_ERROR_NOT_SUPPORTED;
4526 }
John Durkop07cc04a2020-11-16 22:08:34 -08004527
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004528 /* All currently supported key derivation algorithms are based on a
4529 * hash algorithm. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004530 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
4531 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
4532 if (hash_size == 0) {
4533 return PSA_ERROR_NOT_SUPPORTED;
4534 }
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004535
4536 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
4537 * we might fail later, which is somewhat unfriendly and potentially
4538 * risk-prone. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004539 psa_status_t status = psa_hash_try_support(hash_alg);
4540 if (status != PSA_SUCCESS) {
4541 return status;
4542 }
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004543
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004544 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
4545 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
4546 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
4547 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004548 }
Gilles Peskineea0d95e2021-04-29 21:18:14 +02004549
Gilles Peskinecdacf042021-04-29 21:10:00 +02004550 operation->capacity = 255 * hash_size;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004551 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004552}
Gilles Peskine739c98c2021-04-29 21:34:33 +02004553
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004554static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine739c98c2021-04-29 21:34:33 +02004555{
4556#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004557 if (alg == PSA_ALG_ECDH) {
4558 return PSA_SUCCESS;
4559 }
Gilles Peskine739c98c2021-04-29 21:34:33 +02004560#endif
4561 (void) alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004562 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine739c98c2021-04-29 21:34:33 +02004563}
John Durkop07cc04a2020-11-16 22:08:34 -08004564#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01004565
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004566psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
4567 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01004568{
4569 psa_status_t status;
4570
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004571 if (operation->alg != 0) {
4572 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01004573 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01004574
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004575 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
4576 return PSA_ERROR_INVALID_ARGUMENT;
4577 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
4578#if defined(AT_LEAST_ONE_BUILTIN_KDF)
4579 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
4580 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
4581 status = psa_key_agreement_try_support(ka_alg);
4582 if (status != PSA_SUCCESS) {
4583 return status;
4584 }
4585 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
4586#else
4587 return PSA_ERROR_NOT_SUPPORTED;
4588#endif /* AT_LEAST_ONE_BUILTIN_KDF */
4589 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
4590#if defined(AT_LEAST_ONE_BUILTIN_KDF)
4591 status = psa_key_derivation_setup_kdf(operation, alg);
4592#else
4593 return PSA_ERROR_NOT_SUPPORTED;
4594#endif /* AT_LEAST_ONE_BUILTIN_KDF */
4595 } else {
4596 return PSA_ERROR_INVALID_ARGUMENT;
4597 }
4598
4599 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004600 operation->alg = alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004601 }
4602 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004603}
4604
John Durkopd0321952020-10-29 21:37:36 -07004605#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004606static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
4607 psa_algorithm_t hash_alg,
4608 psa_key_derivation_step_t step,
4609 const uint8_t *data,
4610 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004611{
4612 psa_status_t status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004613 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02004614 case PSA_KEY_DERIVATION_INPUT_SALT:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004615 if (hkdf->state != HKDF_STATE_INIT) {
4616 return PSA_ERROR_BAD_STATE;
4617 } else {
4618 status = psa_key_derivation_start_hmac(&hkdf->hmac,
4619 hash_alg,
4620 data, data_length);
4621 if (status != PSA_SUCCESS) {
4622 return status;
4623 }
Steven Cooremanb27e3502021-04-29 19:11:25 +02004624 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004625 return PSA_SUCCESS;
Steven Cooremanb27e3502021-04-29 19:11:25 +02004626 }
Gilles Peskine03410b52019-05-16 16:05:19 +02004627 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004628 /* If no salt was provided, use an empty salt. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004629 if (hkdf->state == HKDF_STATE_INIT) {
4630 status = psa_key_derivation_start_hmac(&hkdf->hmac,
4631 hash_alg,
4632 NULL, 0);
4633 if (status != PSA_SUCCESS) {
4634 return status;
4635 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004636 hkdf->state = HKDF_STATE_STARTED;
4637 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004638 if (hkdf->state != HKDF_STATE_STARTED) {
4639 return PSA_ERROR_BAD_STATE;
4640 }
4641 status = psa_mac_update(&hkdf->hmac,
4642 data, data_length);
4643 if (status != PSA_SUCCESS) {
4644 return status;
4645 }
4646 status = psa_mac_sign_finish(&hkdf->hmac,
4647 hkdf->prk,
4648 sizeof(hkdf->prk),
4649 &data_length);
4650 if (status != PSA_SUCCESS) {
4651 return status;
4652 }
4653 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Gilles Peskine2b522db2019-04-12 15:11:49 +02004654 hkdf->block_number = 0;
4655 hkdf->state = HKDF_STATE_KEYED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004656 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02004657 case PSA_KEY_DERIVATION_INPUT_INFO:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004658 if (hkdf->state == HKDF_STATE_OUTPUT) {
4659 return PSA_ERROR_BAD_STATE;
4660 }
4661 if (hkdf->info_set) {
4662 return PSA_ERROR_BAD_STATE;
4663 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004664 hkdf->info_length = data_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004665 if (data_length != 0) {
4666 hkdf->info = mbedtls_calloc(1, data_length);
4667 if (hkdf->info == NULL) {
4668 return PSA_ERROR_INSUFFICIENT_MEMORY;
4669 }
4670 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004671 }
4672 hkdf->info_set = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004673 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004674 default:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004675 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004676 }
4677}
John Durkop07cc04a2020-11-16 22:08:34 -08004678#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01004679
John Durkop07cc04a2020-11-16 22:08:34 -08004680#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
4681 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004682static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
4683 const uint8_t *data,
4684 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01004685{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004686 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
4687 return PSA_ERROR_BAD_STATE;
4688 }
Janos Follathf08e2652019-06-13 09:05:41 +01004689
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004690 if (data_length != 0) {
4691 prf->seed = mbedtls_calloc(1, data_length);
4692 if (prf->seed == NULL) {
4693 return PSA_ERROR_INSUFFICIENT_MEMORY;
4694 }
Janos Follathf08e2652019-06-13 09:05:41 +01004695
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004696 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01004697 prf->seed_length = data_length;
4698 }
Janos Follathf08e2652019-06-13 09:05:41 +01004699
Gilles Peskine43f958b2020-12-13 14:55:14 +01004700 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01004701
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004702 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01004703}
4704
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004705static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
4706 const uint8_t *data,
4707 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01004708{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004709 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
4710 return PSA_ERROR_BAD_STATE;
4711 }
Janos Follath81550542019-06-13 14:26:34 +01004712
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004713 if (data_length != 0) {
4714 prf->secret = mbedtls_calloc(1, data_length);
4715 if (prf->secret == NULL) {
4716 return PSA_ERROR_INSUFFICIENT_MEMORY;
4717 }
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004718
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004719 memcpy(prf->secret, data, data_length);
Steven Cooreman22dea1d2021-04-29 19:32:25 +02004720 prf->secret_length = data_length;
4721 }
Janos Follath81550542019-06-13 14:26:34 +01004722
Gilles Peskine43f958b2020-12-13 14:55:14 +01004723 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01004724
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004725 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01004726}
4727
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004728static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
4729 const uint8_t *data,
4730 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01004731{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004732 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
4733 return PSA_ERROR_BAD_STATE;
4734 }
Janos Follath63028dd2019-06-13 09:15:47 +01004735
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004736 if (data_length != 0) {
4737 prf->label = mbedtls_calloc(1, data_length);
4738 if (prf->label == NULL) {
4739 return PSA_ERROR_INSUFFICIENT_MEMORY;
4740 }
Janos Follath63028dd2019-06-13 09:15:47 +01004741
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004742 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01004743 prf->label_length = data_length;
4744 }
Janos Follath63028dd2019-06-13 09:15:47 +01004745
Gilles Peskine43f958b2020-12-13 14:55:14 +01004746 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01004747
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004748 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01004749}
4750
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004751static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
4752 psa_key_derivation_step_t step,
4753 const uint8_t *data,
4754 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01004755{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004756 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01004757 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004758 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01004759 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004760 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01004761 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004762 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01004763 default:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004764 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01004765 }
4766}
John Durkop07cc04a2020-11-16 22:08:34 -08004767#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
4768 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
4769
4770#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
4771static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
4772 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08004773 const uint8_t *data,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004774 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08004775{
4776 psa_status_t status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004777 uint8_t pms[4 + 2 * PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE];
John Durkop07cc04a2020-11-16 22:08:34 -08004778 uint8_t *cur = pms;
4779
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004780 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
4781 return PSA_ERROR_INVALID_ARGUMENT;
4782 }
John Durkop07cc04a2020-11-16 22:08:34 -08004783
4784 /* Quoting RFC 4279, Section 2:
4785 *
4786 * The premaster secret is formed as follows: if the PSK is N octets
4787 * long, concatenate a uint16 with the value N, N zero octets, a second
4788 * uint16 with the value N, and the PSK itself.
4789 */
4790
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004791 *cur++ = MBEDTLS_BYTE_1(data_length);
4792 *cur++ = MBEDTLS_BYTE_0(data_length);
4793 memset(cur, 0, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08004794 cur += data_length;
4795 *cur++ = pms[0];
4796 *cur++ = pms[1];
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004797 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08004798 cur += data_length;
4799
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004800 status = psa_tls12_prf_set_key(prf, pms, cur - pms);
John Durkop07cc04a2020-11-16 22:08:34 -08004801
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004802 mbedtls_platform_zeroize(pms, sizeof(pms));
4803 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08004804}
Janos Follath6660f0e2019-06-17 08:44:03 +01004805
4806static psa_status_t psa_tls12_prf_psk_to_ms_input(
4807 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01004808 psa_key_derivation_step_t step,
4809 const uint8_t *data,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004810 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01004811{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004812 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
4813 return psa_tls12_prf_psk_to_ms_set_key(prf,
4814 data, data_length);
Janos Follath0c1ed842019-06-28 13:35:36 +01004815 }
Janos Follath6660f0e2019-06-17 08:44:03 +01004816
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004817 return psa_tls12_prf_input(prf, step, data, data_length);
Janos Follath6660f0e2019-06-17 08:44:03 +01004818}
John Durkop07cc04a2020-11-16 22:08:34 -08004819#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004820
Gilles Peskineb8965192019-09-24 16:21:10 +02004821/** Check whether the given key type is acceptable for the given
4822 * input step of a key derivation.
4823 *
4824 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
4825 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
4826 * Both secret and non-secret inputs can alternatively have the type
4827 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
4828 * that the input was passed as a buffer rather than via a key object.
4829 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02004830static int psa_key_derivation_check_input_type(
4831 psa_key_derivation_step_t step,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004832 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02004833{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004834 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02004835 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004836 if (key_type == PSA_KEY_TYPE_DERIVE) {
4837 return PSA_SUCCESS;
4838 }
4839 if (key_type == PSA_KEY_TYPE_NONE) {
4840 return PSA_SUCCESS;
4841 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02004842 break;
4843 case PSA_KEY_DERIVATION_INPUT_LABEL:
4844 case PSA_KEY_DERIVATION_INPUT_SALT:
4845 case PSA_KEY_DERIVATION_INPUT_INFO:
4846 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004847 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
4848 return PSA_SUCCESS;
4849 }
4850 if (key_type == PSA_KEY_TYPE_NONE) {
4851 return PSA_SUCCESS;
4852 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02004853 break;
4854 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004855 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02004856}
4857
Janos Follathb80a94e2019-06-12 15:54:46 +01004858static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004859 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004860 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02004861 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004862 const uint8_t *data,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004863 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004864{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004865 psa_status_t status;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004866 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02004867
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004868 status = psa_key_derivation_check_input_type(step, key_type);
4869 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02004870 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004871 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02004872
John Durkopd0321952020-10-29 21:37:36 -07004873#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004874 if (PSA_ALG_IS_HKDF(kdf_alg)) {
4875 status = psa_hkdf_input(&operation->ctx.hkdf,
4876 PSA_ALG_HKDF_GET_HASH(kdf_alg),
4877 step, data, data_length);
4878 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004879#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF */
4880#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004881 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
4882 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
4883 step, data, data_length);
4884 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004885#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
4886#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004887 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
4888 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
4889 step, data, data_length);
4890 } else
John Durkop07cc04a2020-11-16 22:08:34 -08004891#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004892 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02004893 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01004894 (void) data;
4895 (void) data_length;
4896 (void) kdf_alg;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004897 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004898 }
4899
Gilles Peskine224b0d62019-09-23 18:13:17 +02004900exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004901 if (status != PSA_SUCCESS) {
4902 psa_key_derivation_abort(operation);
4903 }
4904 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004905}
4906
Janos Follath51f4a0f2019-06-14 11:35:55 +01004907psa_status_t psa_key_derivation_input_bytes(
4908 psa_key_derivation_operation_t *operation,
4909 psa_key_derivation_step_t step,
4910 const uint8_t *data,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004911 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004912{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004913 return psa_key_derivation_input_internal(operation, step,
4914 PSA_KEY_TYPE_NONE,
4915 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01004916}
4917
Janos Follath51f4a0f2019-06-14 11:35:55 +01004918psa_status_t psa_key_derivation_input_key(
4919 psa_key_derivation_operation_t *operation,
4920 psa_key_derivation_step_t step,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004921 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004922{
Ronald Cronf95a2b12020-10-22 15:24:49 +02004923 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01004924 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004925 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004926
Ronald Cron5c522922020-11-14 16:35:34 +01004927 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004928 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
4929 if (status != PSA_SUCCESS) {
4930 psa_key_derivation_abort(operation);
4931 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02004932 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004933
4934 /* Passing a key object as a SECRET input unlocks the permission
4935 * to output to a key object. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004936 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004937 operation->can_output_key = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004938 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02004939
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004940 status = psa_key_derivation_input_internal(operation,
4941 step, slot->attr.type,
4942 slot->key.data,
4943 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004944
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004945 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004946
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004947 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01004948}
Gilles Peskineea0fb492018-07-12 17:17:20 +02004949
4950
4951
4952/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02004953/* Key agreement */
4954/****************************************************************/
4955
John Durkop6ba40d12020-11-10 08:50:04 -08004956#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004957static psa_status_t psa_key_agreement_ecdh(const uint8_t *peer_key,
4958 size_t peer_key_length,
4959 const mbedtls_ecp_keypair *our_key,
4960 uint8_t *shared_secret,
4961 size_t shared_secret_size,
4962 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004963{
Steven Cooremand4867872020-08-05 16:31:39 +02004964 mbedtls_ecp_keypair *their_key = NULL;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004965 mbedtls_ecdh_context ecdh;
Jaeden Amero97271b32019-01-10 19:38:51 +00004966 psa_status_t status;
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004967 size_t bits = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004968 psa_ecc_family_t curve = mbedtls_ecc_group_to_psa(our_key->grp.id, &bits);
4969 mbedtls_ecdh_init(&ecdh);
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004970
Ronald Cron90857082020-11-25 14:58:33 +01004971 status = mbedtls_psa_ecp_load_representation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004972 PSA_KEY_TYPE_ECC_PUBLIC_KEY(curve),
4973 bits,
4974 peer_key,
4975 peer_key_length,
4976 &their_key);
4977 if (status != PSA_SUCCESS) {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004978 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004979 }
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004980
Jaeden Amero97271b32019-01-10 19:38:51 +00004981 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004982 mbedtls_ecdh_get_params(&ecdh, their_key, MBEDTLS_ECDH_THEIRS));
4983 if (status != PSA_SUCCESS) {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004984 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004985 }
Jaeden Amero97271b32019-01-10 19:38:51 +00004986 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004987 mbedtls_ecdh_get_params(&ecdh, our_key, MBEDTLS_ECDH_OURS));
4988 if (status != PSA_SUCCESS) {
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004989 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004990 }
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02004991
Jaeden Amero97271b32019-01-10 19:38:51 +00004992 status = mbedtls_to_psa_error(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004993 mbedtls_ecdh_calc_secret(&ecdh,
4994 shared_secret_length,
4995 shared_secret, shared_secret_size,
4996 mbedtls_psa_get_random,
4997 MBEDTLS_PSA_RANDOM_STATE));
4998 if (status != PSA_SUCCESS) {
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01004999 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005000 }
5001 if (PSA_BITS_TO_BYTES(bits) != *shared_secret_length) {
Gilles Peskinec7ef5b32019-12-12 16:58:00 +01005002 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005003 }
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005004
5005exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005006 if (status != PSA_SUCCESS) {
5007 mbedtls_platform_zeroize(shared_secret, shared_secret_size);
5008 }
5009 mbedtls_ecdh_free(&ecdh);
5010 mbedtls_ecp_keypair_free(their_key);
5011 mbedtls_free(their_key);
Steven Cooremana2371e52020-07-28 14:30:39 +02005012
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005013 return status;
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005014}
John Durkop6ba40d12020-11-10 08:50:04 -08005015#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02005016
Gilles Peskine01d718c2018-09-18 12:01:02 +02005017#define PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE MBEDTLS_ECP_MAX_BYTES
5018
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005019static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
5020 psa_key_slot_t *private_key,
5021 const uint8_t *peer_key,
5022 size_t peer_key_length,
5023 uint8_t *shared_secret,
5024 size_t shared_secret_size,
5025 size_t *shared_secret_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02005026{
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01005027 mbedtls_ecp_keypair *ecp = NULL;
5028 psa_status_t status;
Agathiyan Bragadeeshe7eb8052023-07-31 16:16:38 +01005029
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005030 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08005031#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005032 case PSA_ALG_ECDH:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005033 if (!PSA_KEY_TYPE_IS_ECC_KEY_PAIR(private_key->attr.type)) {
5034 return PSA_ERROR_INVALID_ARGUMENT;
5035 }
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01005036 status = mbedtls_psa_ecp_load_representation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005037 private_key->attr.type,
5038 private_key->attr.bits,
5039 private_key->key.data,
5040 private_key->key.bytes,
5041 &ecp);
5042 if (status != PSA_SUCCESS) {
5043 return status;
5044 }
5045 status = psa_key_agreement_ecdh(peer_key, peer_key_length,
5046 ecp,
5047 shared_secret, shared_secret_size,
5048 shared_secret_length);
5049 mbedtls_ecp_keypair_free(ecp);
5050 mbedtls_free(ecp);
5051 return status;
John Durkop6ba40d12020-11-10 08:50:04 -08005052#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Gilles Peskine01d718c2018-09-18 12:01:02 +02005053 default:
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01005054 (void) ecp;
5055 (void) status;
Gilles Peskine93f85002018-11-16 16:43:31 +01005056 (void) private_key;
5057 (void) peer_key;
5058 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005059 (void) shared_secret;
5060 (void) shared_secret_size;
5061 (void) shared_secret_length;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005062 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02005063 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005064}
5065
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005066/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02005067 * to potentially free embedded data structures and wipe confidential data.
5068 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005069static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
5070 psa_key_derivation_step_t step,
5071 psa_key_slot_t *private_key,
5072 const uint8_t *peer_key,
5073 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02005074{
5075 psa_status_t status;
5076 uint8_t shared_secret[PSA_KEY_AGREEMENT_MAX_SHARED_SECRET_SIZE];
5077 size_t shared_secret_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005078 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02005079
5080 /* Step 1: run the secret agreement algorithm to generate the shared
5081 * secret. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005082 status = psa_key_agreement_raw_internal(ka_alg,
5083 private_key,
5084 peer_key, peer_key_length,
5085 shared_secret,
5086 sizeof(shared_secret),
5087 &shared_secret_length);
5088 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02005089 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005090 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02005091
Gilles Peskineb0b255c2018-07-06 17:01:38 +02005092 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02005093 * the shared secret. A shared secret is permitted wherever a key
5094 * of type DERIVE is permitted. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005095 status = psa_key_derivation_input_internal(operation, step,
5096 PSA_KEY_TYPE_DERIVE,
5097 shared_secret,
5098 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02005099exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005100 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
5101 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02005102}
5103
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005104psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
5105 psa_key_derivation_step_t step,
5106 mbedtls_svc_key_id_t private_key,
5107 const uint8_t *peer_key,
5108 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02005109{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005110 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005111 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01005112 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005113
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005114 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5115 return PSA_ERROR_INVALID_ARGUMENT;
5116 }
Ronald Cron5c522922020-11-14 16:35:34 +01005117 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005118 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
5119 if (status != PSA_SUCCESS) {
5120 return status;
5121 }
5122 status = psa_key_agreement_internal(operation, step,
5123 slot,
5124 peer_key, peer_key_length);
5125 if (status != PSA_SUCCESS) {
5126 psa_key_derivation_abort(operation);
5127 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005128 /* If a private key has been added as SECRET, we allow the derived
5129 * key material to be used as a key in PSA Crypto. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005130 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005131 operation->can_output_key = 1;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005132 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02005133 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005134
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005135 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02005136
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005137 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02005138}
5139
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005140psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
5141 mbedtls_svc_key_id_t private_key,
5142 const uint8_t *peer_key,
5143 size_t peer_key_length,
5144 uint8_t *output,
5145 size_t output_size,
5146 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02005147{
Ronald Cronf95a2b12020-10-22 15:24:49 +02005148 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01005149 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02005150 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01005151 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005152
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005153 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02005154 status = PSA_ERROR_INVALID_ARGUMENT;
5155 goto exit;
5156 }
Ronald Cron5c522922020-11-14 16:35:34 +01005157 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005158 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
5159 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02005160 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005161 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02005162
Gilles Peskine42313fb2022-04-14 00:17:15 +02005163 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
5164 * for the output size. The PSA specification only guarantees that this
5165 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
5166 * but it might be nice to allow smaller buffers if the output fits.
5167 * At the time of writing this comment, with only ECDH implemented,
5168 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
5169 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
5170 * be exact for it as well. */
Agathiyan Bragadeesh7b0ee1e2023-07-27 15:51:46 +01005171 expected_length =
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005172 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
5173 if (output_size < expected_length) {
Gilles Peskine42313fb2022-04-14 00:17:15 +02005174 status = PSA_ERROR_BUFFER_TOO_SMALL;
5175 goto exit;
5176 }
5177
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005178 status = psa_key_agreement_raw_internal(alg, slot,
5179 peer_key, peer_key_length,
5180 output, output_size,
5181 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02005182
5183exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005184 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02005185 /* If an error happens and is not handled properly, the output
5186 * may be used as a key to protect sensitive data. Arrange for such
5187 * a key to be random, which is likely to result in decryption or
5188 * verification errors. This is better than filling the buffer with
5189 * some constant data such as zeros, which would result in the data
5190 * being protected with a reproducible, easily knowable key.
5191 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005192 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02005193 *output_length = output_size;
5194 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005195
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005196 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02005197
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005198 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02005199}
Gilles Peskine86a440b2018-11-12 18:39:40 +01005200
5201
Gilles Peskine30524eb2020-11-13 17:02:26 +01005202
Gilles Peskine86a440b2018-11-12 18:39:40 +01005203/****************************************************************/
5204/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02005205/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02005206
Gilles Peskine9a9d5ee2023-04-28 21:00:28 +02005207#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
5208#include "mbedtls/entropy_poll.h"
5209#endif
5210
Gilles Peskine30524eb2020-11-13 17:02:26 +01005211/** Initialize the PSA random generator.
5212 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005213static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01005214{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005215#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005216 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005217#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5218
Gilles Peskine30524eb2020-11-13 17:02:26 +01005219 /* Set default configuration if
5220 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005221 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005222 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005223 }
5224 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01005225 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005226 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01005227
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005228 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01005229#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
5230 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
5231 /* The PSA entropy injection feature depends on using NV seed as an entropy
5232 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005233 mbedtls_entropy_add_source(&rng->entropy,
5234 mbedtls_nv_seed_poll, NULL,
5235 MBEDTLS_ENTROPY_BLOCK_SIZE,
5236 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01005237#endif
5238
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005239 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005240#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005241}
5242
5243/** Deinitialize the PSA random generator.
5244 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005245static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01005246{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005247#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005248 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005249#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005250 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
5251 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005252#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005253}
5254
5255/** Seed the PSA random generator.
5256 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005257static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01005258{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005259#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5260 /* Do nothing: the external RNG seeds itself. */
5261 (void) rng;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005262 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005263#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005264 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005265 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
5266 drbg_seed, sizeof(drbg_seed) - 1);
5267 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005268#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01005269}
5270
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005271psa_status_t psa_generate_random(uint8_t *output,
5272 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005273{
Gilles Peskinee59236f2018-01-27 23:32:46 +01005274 GUARD_MODULE_INITIALIZED;
5275
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005276#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5277
5278 size_t output_length = 0;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005279 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
5280 output, output_size,
5281 &output_length);
5282 if (status != PSA_SUCCESS) {
5283 return status;
5284 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005285 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove49f99bc2022-12-04 16:44:21 +00005286 * for the external RNG interface. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005287 if (output_length != output_size) {
5288 return PSA_ERROR_INSUFFICIENT_ENTROPY;
5289 }
5290 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005291
5292#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5293
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005294 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01005295 size_t request_size =
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005296 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
5297 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
5298 output_size);
5299 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
5300 output, request_size);
5301 if (ret != 0) {
5302 return mbedtls_to_psa_error(ret);
5303 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01005304 output_size -= request_size;
5305 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02005306 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005307 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005308#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005309}
5310
Gilles Peskine8814fc42020-12-14 15:33:44 +01005311/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005312 *
5313 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
5314 * `psa_generate_random(...)`. The state parameter is ignored since the
5315 * PSA API doesn't support passing an explicit state.
5316 *
5317 * In the non-external case, psa_generate_random() calls an
5318 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
5319 * and semantics as mbedtls_psa_get_random(). As an optimization,
5320 * instead of doing this back-and-forth between the PSA API and the
5321 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
5322 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01005323 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005324#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
5325int mbedtls_psa_get_random(void *p_rng,
5326 unsigned char *output,
5327 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01005328{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01005329 /* This function takes a pointer to the RNG state because that's what
5330 * classic mbedtls functions using an RNG expect. The PSA RNG manages
5331 * its own state internally and doesn't let the caller access that state.
5332 * So we just ignore the state parameter, and in practice we'll pass
5333 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01005334 (void) p_rng;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005335 psa_status_t status = psa_generate_random(output, output_size);
5336 if (status == PSA_SUCCESS) {
5337 return 0;
5338 } else {
5339 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
5340 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01005341}
5342#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
5343
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005344#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005345psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
5346 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005347{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005348 if (global_data.initialized) {
5349 return PSA_ERROR_NOT_PERMITTED;
5350 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005351
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005352 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
5353 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
5354 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
5355 return PSA_ERROR_INVALID_ARGUMENT;
5356 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02005357
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005358 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005359}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01005360#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02005361
Ronald Cron3772afe2021-02-08 16:10:05 +01005362/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02005363 *
Ronald Cron3772afe2021-02-08 16:10:05 +01005364 * \param type The key type
5365 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02005366 *
5367 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01005368 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02005369 * \retval #PSA_ERROR_INVALID_ARGUMENT
5370 * The size in bits of the key is not valid.
5371 * \retval #PSA_ERROR_NOT_SUPPORTED
5372 * The type and/or the size in bits of the key or the combination of
5373 * the two is not supported.
5374 */
Ronald Cron3772afe2021-02-08 16:10:05 +01005375static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005376 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005377{
Ronald Cronf3bb7612020-10-02 20:11:59 +02005378 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005379
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005380 if (key_type_is_raw_bytes(type)) {
5381 status = validate_unstructured_key_bit_size(type, bits);
5382 if (status != PSA_SUCCESS) {
5383 return status;
5384 }
5385 } else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005386#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005387 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
5388 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
5389 return PSA_ERROR_NOT_SUPPORTED;
5390 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005391
Ronald Cron01b2aba2020-10-05 09:42:02 +02005392 /* Accept only byte-aligned keys, for the same reasons as
5393 * in psa_import_rsa_key(). */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005394 if (bits % 8 != 0) {
5395 return PSA_ERROR_NOT_SUPPORTED;
5396 }
5397 } else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005398#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005399
Ronald Cron5c4d3862020-12-07 11:07:24 +01005400#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005401 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01005402 /* To avoid empty block, return successfully here. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005403 return PSA_SUCCESS;
5404 } else
Ronald Cron5c4d3862020-12-07 11:07:24 +01005405#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02005406 {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005407 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005408 }
5409
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005410 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005411}
5412
Ronald Cron55ed0592020-10-05 10:30:40 +02005413psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005414 const psa_key_attributes_t *attributes,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005415 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02005416{
5417 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02005418 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02005419
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005420 if ((attributes->domain_parameters == NULL) &&
5421 (attributes->domain_parameters_size != 0)) {
5422 return PSA_ERROR_INVALID_ARGUMENT;
5423 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02005424
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005425 if (key_type_is_raw_bytes(type)) {
5426 status = psa_generate_random(key_buffer, key_buffer_size);
5427 if (status != PSA_SUCCESS) {
5428 return status;
5429 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02005430
David Brown12ca5032021-02-11 11:02:00 -07005431#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005432 if (type == PSA_KEY_TYPE_DES) {
5433 psa_des_set_key_parity(key_buffer, key_buffer_size);
5434 }
David Brown8107e312021-02-12 08:08:46 -07005435#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005436 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01005437
Jaeden Ameroc17f2932021-05-14 08:34:32 +01005438#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR) && \
5439 defined(MBEDTLS_GENPRIME)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005440 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
5441 return mbedtls_psa_rsa_generate_key(attributes,
5442 key_buffer,
5443 key_buffer_size,
5444 key_buffer_length);
5445 } else
Jaeden Ameroc17f2932021-05-14 08:34:32 +01005446#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR)
5447 * defined(MBEDTLS_GENPRIME) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005448
John Durkop9814fa22020-11-04 12:28:15 -08005449#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005450 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
5451 return mbedtls_psa_ecp_generate_key(attributes,
5452 key_buffer,
5453 key_buffer_size,
5454 key_buffer_length);
5455 } else
John Durkop9814fa22020-11-04 12:28:15 -08005456#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR) */
Steven Cooreman29149862020-08-05 15:43:42 +02005457 {
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005458 (void) key_buffer_length;
5459 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02005460 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005461
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005462 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005463}
Darryl Green0c6575a2018-11-07 16:05:30 +00005464
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005465psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
5466 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02005467{
5468 psa_status_t status;
5469 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02005470 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02005471 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02005472
Ronald Cron81709fc2020-11-14 12:10:32 +01005473 *key = MBEDTLS_SVC_KEY_ID_INIT;
5474
Gilles Peskine0f84d622019-09-12 19:03:13 +02005475 /* Reject any attempt to create a zero-length key so that we don't
5476 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005477 if (psa_get_key_bits(attributes) == 0) {
5478 return PSA_ERROR_INVALID_ARGUMENT;
5479 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02005480
Przemyslaw Stekiel5b20a7e2021-10-07 11:08:56 +02005481 /* Reject any attempt to create a public key. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005482 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
5483 return PSA_ERROR_INVALID_ARGUMENT;
5484 }
Przemyslaw Stekiel5b20a7e2021-10-07 11:08:56 +02005485
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005486 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
5487 &slot, &driver);
5488 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02005489 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005490 }
Gilles Peskine11792082019-08-06 18:36:36 +02005491
Ronald Cron977c2472020-10-13 08:32:21 +02005492 /* In the case of a transparent key or an opaque key stored in local
5493 * storage (thus not in the case of generating a key in a secure element
5494 * or cryptoprocessor with storage), we have to allocate a buffer to
5495 * hold the generated key material. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005496 if (slot->key.data == NULL) {
5497 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
5498 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01005499 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005500 attributes->core.type, attributes->core.bits);
5501 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01005502 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005503 }
Ronald Cron3772afe2021-02-08 16:10:05 +01005504
5505 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005506 attributes->core.type,
5507 attributes->core.bits);
5508 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02005509 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005510 attributes, &key_buffer_size);
5511 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01005512 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005513 }
Ronald Cron977c2472020-10-13 08:32:21 +02005514 }
Ronald Cron977c2472020-10-13 08:32:21 +02005515
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005516 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
5517 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02005518 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005519 }
Ronald Cron977c2472020-10-13 08:32:21 +02005520 }
5521
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005522 status = psa_driver_wrapper_generate_key(attributes,
5523 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02005524
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005525 if (status != PSA_SUCCESS) {
5526 psa_remove_key_data_from_memory(slot);
5527 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02005528
Gilles Peskine11792082019-08-06 18:36:36 +02005529exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005530 if (status == PSA_SUCCESS) {
5531 status = psa_finish_key_creation(slot, driver, key);
5532 }
5533 if (status != PSA_SUCCESS) {
5534 psa_fail_key_creation(slot, driver);
5535 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02005536
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005537 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005538}
5539
Gilles Peskinee59236f2018-01-27 23:32:46 +01005540/****************************************************************/
5541/* Module setup */
5542/****************************************************************/
5543
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005544#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01005545psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005546 void (* entropy_init)(mbedtls_entropy_context *ctx),
5547 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01005548{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005549 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
5550 return PSA_ERROR_BAD_STATE;
5551 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01005552 global_data.rng.entropy_init = entropy_init;
5553 global_data.rng.entropy_free = entropy_free;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005554 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01005555}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01005556#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01005557
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005558void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005559{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005560 psa_wipe_all_key_slots();
5561 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
5562 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01005563 }
5564 /* Wipe all remaining data, including configuration.
5565 * In particular, this sets all state indicator to the value
5566 * indicating "uninitialized". */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005567 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron088d5d02021-04-10 16:57:30 +02005568
5569 /* Terminate drivers */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005570 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01005571}
5572
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005573#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
5574/** Recover a transaction that was interrupted by a power failure.
5575 *
5576 * This function is called during initialization, before psa_crypto_init()
5577 * returns. If this function returns a failure status, the initialization
5578 * fails.
5579 */
5580static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005581 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005582{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005583 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005584 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
5585 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005586 /* TODO - fall through to the failure case until this
5587 * is implemented.
5588 * https://github.com/ARMmbed/mbed-crypto/issues/218
5589 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005590 default:
5591 /* We found an unsupported transaction in the storage.
5592 * We don't know what state the storage is in. Give up. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005593 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005594 }
5595}
5596#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
5597
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005598psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01005599{
Gilles Peskine66fb1262018-12-10 16:29:04 +01005600 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005601
Gilles Peskinec6b69072018-11-20 21:42:52 +01005602 /* Double initialization is explicitly allowed. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005603 if (global_data.initialized != 0) {
5604 return PSA_SUCCESS;
5605 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01005606
Gilles Peskine30524eb2020-11-13 17:02:26 +01005607 /* Initialize and seed the random generator. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005608 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01005609 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005610 status = mbedtls_psa_random_seed(&global_data.rng);
5611 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01005612 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005613 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01005614 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005615
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005616 status = psa_initialize_key_slots();
5617 if (status != PSA_SUCCESS) {
Gilles Peskine66fb1262018-12-10 16:29:04 +01005618 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005619 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01005620
Ronald Cron088d5d02021-04-10 16:57:30 +02005621 /* Init drivers */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005622 status = psa_driver_wrapper_init();
5623 if (status != PSA_SUCCESS) {
Gilles Peskined9348f22019-10-01 15:22:29 +02005624 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005625 }
Gilles Peskined9348f22019-10-01 15:22:29 +02005626
Gilles Peskine4b734222019-07-24 15:56:31 +02005627#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005628 status = psa_crypto_load_transaction();
5629 if (status == PSA_SUCCESS) {
5630 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
5631 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02005632 goto exit;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005633 }
5634 status = psa_crypto_stop_transaction();
5635 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02005636 /* There's no transaction to complete. It's all good. */
5637 status = PSA_SUCCESS;
5638 }
Gilles Peskine4b734222019-07-24 15:56:31 +02005639#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02005640
Gilles Peskinec6b69072018-11-20 21:42:52 +01005641 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01005642 global_data.initialized = 1;
5643
5644exit:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01005645 if (status != PSA_SUCCESS) {
5646 mbedtls_psa_crypto_free();
5647 }
5648 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01005649}
5650
David Horstmann114d8242023-12-07 18:39:17 +00005651/* Memory copying test hooks. These are called before input copy, after input
5652 * copy, before output copy and after output copy, respectively.
5653 * They are used by memory-poisoning tests to temporarily unpoison buffers
5654 * while they are copied. */
David Horstmann63f82f72023-11-28 15:21:56 +00005655#if defined(MBEDTLS_TEST_HOOKS)
5656void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
5657void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
5658void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
5659void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
5660#endif
5661
David Horstmanndf493552023-11-15 15:18:30 +00005662/** Copy from an input buffer to a local copy.
5663 *
5664 * \param[in] input Pointer to input buffer.
5665 * \param[in] input_len Length of the input buffer.
5666 * \param[out] input_copy Pointer to a local copy in which to store the input data.
5667 * \param[out] input_copy_len Length of the local copy buffer.
5668 * \return #PSA_SUCCESS, if the buffer was successfully
5669 * copied.
5670 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
5671 * copy is too small to hold contents of the
5672 * input buffer.
5673 */
5674MBEDTLS_STATIC_TESTABLE
David Horstmann957f9802023-10-30 20:29:43 +00005675psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
5676 uint8_t *input_copy, size_t input_copy_len)
5677{
5678 if (input_len > input_copy_len) {
David Horstmann8684ad52023-11-03 19:51:40 +00005679 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmann957f9802023-10-30 20:29:43 +00005680 }
5681
David Horstmann0760b152023-11-24 16:21:04 +00005682#if defined(MBEDTLS_TEST_HOOKS)
David Horstmann63f82f72023-11-28 15:21:56 +00005683 if (psa_input_pre_copy_hook != NULL) {
5684 psa_input_pre_copy_hook(input, input_len);
5685 }
David Horstmann0760b152023-11-24 16:21:04 +00005686#endif
5687
David Horstmann660027f2023-11-15 17:33:47 +00005688 if (input_len > 0) {
5689 memcpy(input_copy, input, input_len);
5690 }
David Horstmann957f9802023-10-30 20:29:43 +00005691
David Horstmann0760b152023-11-24 16:21:04 +00005692#if defined(MBEDTLS_TEST_HOOKS)
David Horstmann63f82f72023-11-28 15:21:56 +00005693 if (psa_input_post_copy_hook != NULL) {
5694 psa_input_post_copy_hook(input, input_len);
5695 }
David Horstmann0760b152023-11-24 16:21:04 +00005696#endif
5697
David Horstmann957f9802023-10-30 20:29:43 +00005698 return PSA_SUCCESS;
5699}
5700
David Horstmanndf493552023-11-15 15:18:30 +00005701/** Copy from a local output buffer into a user-supplied one.
5702 *
5703 * \param[in] output_copy Pointer to a local buffer containing the output.
5704 * \param[in] output_copy_len Length of the local buffer.
5705 * \param[out] output Pointer to user-supplied output buffer.
5706 * \param[out] output_len Length of the user-supplied output buffer.
5707 * \return #PSA_SUCCESS, if the buffer was successfully
5708 * copied.
David Horstmann232ab252023-11-20 12:39:38 +00005709 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmanndf493552023-11-15 15:18:30 +00005710 * user-supplied output buffer is too small to
5711 * hold the contents of the local buffer.
5712 */
5713MBEDTLS_STATIC_TESTABLE
David Horstmann2bd296e2023-10-30 20:37:12 +00005714psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
5715 uint8_t *output, size_t output_len)
5716{
5717 if (output_len < output_copy_len) {
David Horstmann232ab252023-11-20 12:39:38 +00005718 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann2bd296e2023-10-30 20:37:12 +00005719 }
David Horstmann660027f2023-11-15 17:33:47 +00005720
David Horstmann0760b152023-11-24 16:21:04 +00005721#if defined(MBEDTLS_TEST_HOOKS)
David Horstmann63f82f72023-11-28 15:21:56 +00005722 if (psa_output_pre_copy_hook != NULL) {
5723 psa_output_pre_copy_hook(output, output_len);
5724 }
David Horstmann0760b152023-11-24 16:21:04 +00005725#endif
5726
David Horstmann660027f2023-11-15 17:33:47 +00005727 if (output_copy_len > 0) {
5728 memcpy(output, output_copy, output_copy_len);
5729 }
5730
David Horstmann0760b152023-11-24 16:21:04 +00005731#if defined(MBEDTLS_TEST_HOOKS)
David Horstmann63f82f72023-11-28 15:21:56 +00005732 if (psa_output_post_copy_hook != NULL) {
5733 psa_output_post_copy_hook(output, output_len);
5734 }
David Horstmann0760b152023-11-24 16:21:04 +00005735#endif
5736
David Horstmann2bd296e2023-10-30 20:37:12 +00005737 return PSA_SUCCESS;
5738}
5739
David Horstmann81a0d572023-11-20 17:15:32 +00005740psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
5741 psa_crypto_local_input_t *local_input)
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005742{
5743 psa_status_t status;
5744
David Horstmann0d52c712023-11-23 15:50:37 +00005745 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005746
David Horstmann726bf052023-11-15 18:11:26 +00005747 if (input_len == 0) {
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005748 return PSA_SUCCESS;
5749 }
5750
David Horstmann81a0d572023-11-20 17:15:32 +00005751 local_input->buffer = mbedtls_calloc(input_len, 1);
5752 if (local_input->buffer == NULL) {
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005753 /* Since we dealt with the zero-length case above, we know that
5754 * a NULL return value means a failure of allocation. */
5755 return PSA_ERROR_INSUFFICIENT_MEMORY;
5756 }
David Horstmann81a0d572023-11-20 17:15:32 +00005757 /* From now on, we must free local_input->buffer on error. */
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005758
David Horstmann81a0d572023-11-20 17:15:32 +00005759 local_input->length = input_len;
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005760
5761 status = psa_crypto_copy_input(input, input_len,
David Horstmann81a0d572023-11-20 17:15:32 +00005762 local_input->buffer, local_input->length);
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005763 if (status != PSA_SUCCESS) {
5764 goto error;
5765 }
5766
5767 return PSA_SUCCESS;
5768
5769error:
David Horstmann81a0d572023-11-20 17:15:32 +00005770 mbedtls_free(local_input->buffer);
5771 local_input->buffer = NULL;
5772 local_input->length = 0;
David Horstmann8d9d4fe2023-11-07 16:36:48 +00005773 return status;
5774}
5775
David Horstmann81a0d572023-11-20 17:15:32 +00005776void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmannfa2d75d2023-11-07 18:00:41 +00005777{
David Horstmann81a0d572023-11-20 17:15:32 +00005778 mbedtls_free(local_input->buffer);
5779 local_input->buffer = NULL;
5780 local_input->length = 0;
David Horstmannfa2d75d2023-11-07 18:00:41 +00005781}
5782
David Horstmann1a76ab12023-11-20 12:54:09 +00005783psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
5784 psa_crypto_local_output_t *local_output)
David Horstmann953cd5b2023-11-08 15:19:43 +00005785{
David Horstmann0d52c712023-11-23 15:50:37 +00005786 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmann953cd5b2023-11-08 15:19:43 +00005787
David Horstmann726bf052023-11-15 18:11:26 +00005788 if (output_len == 0) {
David Horstmann953cd5b2023-11-08 15:19:43 +00005789 return PSA_SUCCESS;
5790 }
David Horstmann1a76ab12023-11-20 12:54:09 +00005791 local_output->buffer = mbedtls_calloc(output_len, 1);
5792 if (local_output->buffer == NULL) {
David Horstmann953cd5b2023-11-08 15:19:43 +00005793 /* Since we dealt with the zero-length case above, we know that
5794 * a NULL return value means a failure of allocation. */
5795 return PSA_ERROR_INSUFFICIENT_MEMORY;
5796 }
David Horstmann1a76ab12023-11-20 12:54:09 +00005797 local_output->length = output_len;
5798 local_output->original = output;
David Horstmann953cd5b2023-11-08 15:19:43 +00005799
5800 return PSA_SUCCESS;
5801}
5802
Gabor Mezei3b0c3712024-01-24 13:07:17 +01005803psa_status_t psa_crypto_local_output_alloc_with_copy(uint8_t *output, size_t output_len,
5804 psa_crypto_local_output_t *local_output)
5805{
5806 psa_status_t status;
5807 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
5808
5809 if (output_len == 0) {
5810 return PSA_SUCCESS;
5811 }
5812 local_output->buffer = mbedtls_calloc(output_len, 1);
5813 if (local_output->buffer == NULL) {
5814 /* Since we dealt with the zero-length case above, we know that
5815 * a NULL return value means a failure of allocation. */
5816 return PSA_ERROR_INSUFFICIENT_MEMORY;
5817 }
5818 local_output->length = output_len;
5819 local_output->original = output;
5820
5821 status = psa_crypto_copy_input(output, output_len,
5822 local_output->buffer, local_output->length);
5823 if (status != PSA_SUCCESS) {
5824 goto error;
5825 }
5826
5827 return PSA_SUCCESS;
5828
5829error:
5830 mbedtls_free(local_output->buffer);
5831 local_output->buffer = NULL;
5832 local_output->length = 0;
5833 return status;
5834}
5835
David Horstmann1a76ab12023-11-20 12:54:09 +00005836psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmannaeeb2742023-11-08 17:44:18 +00005837{
David Horstmann761761f2023-11-15 15:57:32 +00005838 psa_status_t status;
5839
David Horstmann1a76ab12023-11-20 12:54:09 +00005840 if (local_output->buffer == NULL) {
5841 local_output->length = 0;
David Horstmannaeeb2742023-11-08 17:44:18 +00005842 return PSA_SUCCESS;
5843 }
David Horstmann1a76ab12023-11-20 12:54:09 +00005844 if (local_output->original == NULL) {
David Horstmannaeeb2742023-11-08 17:44:18 +00005845 /* We have an internal copy but nothing to copy back to. */
5846 return PSA_ERROR_CORRUPTION_DETECTED;
5847 }
5848
David Horstmann1a76ab12023-11-20 12:54:09 +00005849 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
5850 local_output->original, local_output->length);
David Horstmann761761f2023-11-15 15:57:32 +00005851 if (status != PSA_SUCCESS) {
5852 return status;
5853 }
David Horstmannaeeb2742023-11-08 17:44:18 +00005854
David Horstmann1a76ab12023-11-20 12:54:09 +00005855 mbedtls_free(local_output->buffer);
5856 local_output->buffer = NULL;
5857 local_output->length = 0;
David Horstmannaeeb2742023-11-08 17:44:18 +00005858
5859 return PSA_SUCCESS;
5860}
5861
Gilles Peskinee59236f2018-01-27 23:32:46 +01005862#endif /* MBEDTLS_PSA_CRYPTO_C */