blob: f0ccf3d80eb1a7690e104f8b519ed2ba6b442bfa [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 Rodgman16799db2023-11-02 19:47:20 +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"
Ronald Cronafbc7ed2023-01-24 16:02:04 +010010#include "psa_crypto_core_common.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010011
12#if defined(MBEDTLS_PSA_CRYPTO_C)
mohammad160327010052018-07-03 13:16:15 +030013
John Durkop07cc04a2020-11-16 22:08:34 -080014#if defined(MBEDTLS_PSA_CRYPTO_CONFIG)
15#include "check_crypto_config.h"
16#endif
17
Gilles Peskinee59236f2018-01-27 23:32:46 +010018#include "psa/crypto.h"
Przemyslaw Stekiel705fb0f2021-11-24 08:47:29 +010019#include "psa/crypto_values.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010020
Ronald Crond6d28882020-12-14 14:56:02 +010021#include "psa_crypto_cipher.h"
Gilles Peskine039b90c2018-12-07 18:24:41 +010022#include "psa_crypto_core.h"
Gilles Peskine5e769522018-11-20 21:59:56 +010023#include "psa_crypto_invasive.h"
Xiaokang Qiane9c39c42023-08-09 08:50:19 +000024#include "psa_crypto_driver_wrappers.h"
Xiaokang Qianfe9666b2023-09-11 10:36:20 +000025#include "psa_crypto_driver_wrappers_no_static.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010026#include "psa_crypto_ecp.h"
Przemek Stekiel359f4622022-12-05 14:11:55 +010027#include "psa_crypto_ffdh.h"
Steven Cooreman5f88e772021-03-15 11:07:12 +010028#include "psa_crypto_hash.h"
Steven Cooreman82c66b62021-03-19 17:39:17 +010029#include "psa_crypto_mac.h"
Ronald Cron00b7bfc2020-11-25 15:25:26 +010030#include "psa_crypto_rsa.h"
Ronald Cron7023db52020-11-20 18:17:42 +010031#include "psa_crypto_ecp.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020032#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined0890212019-06-24 14:34:43 +020033#include "psa_crypto_se.h"
Gilles Peskinea8ade162019-06-26 11:24:49 +020034#endif
Gilles Peskine961849f2018-11-30 18:54:54 +010035#include "psa_crypto_slot_management.h"
Darryl Greend49a4992018-06-18 17:27:26 +010036/* Include internal declarations that are useful for implementing persistently
37 * stored keys. */
38#include "psa_crypto_storage.h"
39
Gilles Peskineb2b64d32020-12-14 16:43:58 +010040#include "psa_crypto_random_impl.h"
Gilles Peskine90edc992020-11-13 15:39:19 +010041
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010042#include <stdlib.h>
43#include <string.h>
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010044#include "mbedtls/platform.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010045
Gilles Peskine1c49f1a2020-11-13 18:46:25 +010046#include "mbedtls/aes.h"
Gilles Peskine9a944802018-06-21 09:35:35 +020047#include "mbedtls/asn1.h"
Jaeden Amero25384a22019-01-10 10:23:21 +000048#include "mbedtls/asn1write.h"
Gilles Peskinea81d85b2018-06-26 16:10:23 +020049#include "mbedtls/bignum.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010050#include "mbedtls/camellia.h"
Gilles Peskine26869f22019-05-06 15:25:00 +020051#include "mbedtls/chacha20.h"
52#include "mbedtls/chachapoly.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010053#include "mbedtls/cipher.h"
54#include "mbedtls/ccm.h"
55#include "mbedtls/cmac.h"
Dave Rodgman78701152023-08-29 14:20:18 +010056#include "mbedtls/constant_time.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010057#include "mbedtls/des.h"
Gilles Peskineb7ecdf02018-09-18 12:11:27 +020058#include "mbedtls/ecdh.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010059#include "mbedtls/ecp.h"
Gilles Peskinee59236f2018-01-27 23:32:46 +010060#include "mbedtls/entropy.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010061#include "mbedtls/error.h"
62#include "mbedtls/gcm.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010063#include "mbedtls/md5.h"
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010064#include "mbedtls/pk.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000065#include "pk_wrap.h"
Gilles Peskine3f108122018-12-07 18:14:53 +010066#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000067#include "mbedtls/error.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010068#include "mbedtls/ripemd160.h"
Gilles Peskine969ac722018-01-28 18:16:59 +010069#include "mbedtls/rsa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010070#include "mbedtls/sha1.h"
71#include "mbedtls/sha256.h"
72#include "mbedtls/sha512.h"
Valerio Setti384fbde2024-01-02 13:26:40 +010073#include "mbedtls/psa_util.h"
Paul Elliott600472b2024-02-23 17:26:58 +000074#include "mbedtls/threading.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010075
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020076#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
77 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
78 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Przemek Stekiel69c46792022-06-10 12:59:51 +020079#define BUILTIN_ALG_ANY_HKDF 1
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020080#endif
81
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010082/****************************************************************/
83/* Global data, support functions and library management */
84/****************************************************************/
85
Gilles Peskine449bd832023-01-11 14:50:10 +010086static int key_type_is_raw_bytes(psa_key_type_t type)
Gilles Peskine48c0ea12018-06-21 14:15:31 +020087{
Gilles Peskine449bd832023-01-11 14:50:10 +010088 return PSA_KEY_TYPE_IS_UNSTRUCTURED(type);
Gilles Peskine48c0ea12018-06-21 14:15:31 +020089}
90
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010091/* Values for psa_global_data_t::rng_state */
92#define RNG_NOT_INITIALIZED 0
93#define RNG_INITIALIZED 1
94#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +010095
Paul Elliott0db6a902024-03-15 13:48:20 +000096/* IDs for PSA crypto subsystems. Starts at 1 to catch potential uninitialized
97 * variables as arguments. */
Paul Elliott47cee8e2024-03-08 21:38:02 +000098typedef enum {
Paul Elliott0db6a902024-03-15 13:48:20 +000099 PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS = 1,
Paul Elliott47cee8e2024-03-08 21:38:02 +0000100 PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS,
101 PSA_CRYPTO_SUBSYSTEM_RNG,
102 PSA_CRYPTO_SUBSYSTEM_TRANSACTION,
103} mbedtls_psa_crypto_subsystem;
104
Paul Elliottb24e36d2024-03-15 16:25:48 +0000105/* Initialization flags for global_data::initialized */
Paul Elliott47cee8e2024-03-08 21:38:02 +0000106#define PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS_INITIALIZED 0x01
107#define PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS_INITIALIZED 0x02
108#define PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED 0x04
109
110#define PSA_CRYPTO_SUBSYSTEM_ALL_INITIALISED ( \
111 PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS_INITIALIZED | \
112 PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS_INITIALIZED | \
113 PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED)
114
Gilles Peskine449bd832023-01-11 14:50:10 +0100115typedef struct {
Dave Rodgman864f5942023-08-16 18:04:44 +0100116 uint8_t initialized;
117 uint8_t rng_state;
Gilles Peskine2d8a1822021-11-08 22:20:03 +0100118 mbedtls_psa_random_context_t rng;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100119} psa_global_data_t;
120
121static psa_global_data_t global_data;
122
Paul Elliott600472b2024-02-23 17:26:58 +0000123static uint8_t psa_get_initialized(void)
124{
125 uint8_t initialized;
126
127#if defined(MBEDTLS_THREADING_C)
Paul Elliott47cee8e2024-03-08 21:38:02 +0000128 mbedtls_mutex_lock(&mbedtls_threading_psa_rngdata_mutex);
129#endif /* defined(MBEDTLS_THREADING_C) */
130
131 initialized = global_data.rng_state == RNG_SEEDED;
132
133#if defined(MBEDTLS_THREADING_C)
134 mbedtls_mutex_unlock(&mbedtls_threading_psa_rngdata_mutex);
135#endif /* defined(MBEDTLS_THREADING_C) */
136
137#if defined(MBEDTLS_THREADING_C)
Paul Elliott600472b2024-02-23 17:26:58 +0000138 mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex);
139#endif /* defined(MBEDTLS_THREADING_C) */
140
Paul Elliott47cee8e2024-03-08 21:38:02 +0000141 initialized =
142 (initialized && (global_data.initialized == PSA_CRYPTO_SUBSYSTEM_ALL_INITIALISED));
Paul Elliott600472b2024-02-23 17:26:58 +0000143
144#if defined(MBEDTLS_THREADING_C)
145 mbedtls_mutex_unlock(&mbedtls_threading_psa_globaldata_mutex);
146#endif /* defined(MBEDTLS_THREADING_C) */
147
148 return initialized;
149}
150
Paul Elliott35816522024-02-23 17:47:42 +0000151static uint8_t psa_get_drivers_initialized(void)
152{
153 uint8_t initialized;
154
155#if defined(MBEDTLS_THREADING_C)
156 mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex);
157#endif /* defined(MBEDTLS_THREADING_C) */
158
Paul Elliott47cee8e2024-03-08 21:38:02 +0000159 initialized = (global_data.initialized & PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS_INITIALIZED) != 0;
Paul Elliott35816522024-02-23 17:47:42 +0000160
161#if defined(MBEDTLS_THREADING_C)
162 mbedtls_mutex_unlock(&mbedtls_threading_psa_globaldata_mutex);
163#endif /* defined(MBEDTLS_THREADING_C) */
164
165 return initialized;
166}
167
itayzafrir0adf0fc2018-09-06 16:24:41 +0300168#define GUARD_MODULE_INITIALIZED \
Paul Elliott600472b2024-02-23 17:26:58 +0000169 if (psa_get_initialized() == 0) \
Gilles Peskine449bd832023-01-11 14:50:10 +0100170 return PSA_ERROR_BAD_STATE;
itayzafrir0adf0fc2018-09-06 16:24:41 +0300171
David Horstmann4a48bec2024-03-13 15:42:31 +0000172#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
David Horstmann36df4b22023-12-13 15:55:25 +0000173
David Horstmann62a56d92023-12-14 18:12:47 +0000174/* Declare a local copy of an input buffer and a variable that will be used
175 * to store a pointer to the start of the buffer.
David Horstmann36df4b22023-12-13 15:55:25 +0000176 *
177 * Note: This macro must be called before any operations which may jump to
178 * the exit label, so that the local input copy object is safe to be freed.
179 *
180 * Assumptions:
181 * - input is the name of a pointer to the buffer to be copied
182 * - The name LOCAL_INPUT_COPY_OF_input is unused in the current scope
David Horstmann62a56d92023-12-14 18:12:47 +0000183 * - input_copy_name is a name that is unused in the current scope
David Horstmann36df4b22023-12-13 15:55:25 +0000184 */
David Horstmann62a56d92023-12-14 18:12:47 +0000185#define LOCAL_INPUT_DECLARE(input, input_copy_name) \
186 psa_crypto_local_input_t LOCAL_INPUT_COPY_OF_##input = PSA_CRYPTO_LOCAL_INPUT_INIT; \
187 const uint8_t *input_copy_name = NULL;
David Horstmann36df4b22023-12-13 15:55:25 +0000188
David Horstmann62a56d92023-12-14 18:12:47 +0000189/* Allocate a copy of the buffer input and set the pointer input_copy to
190 * point to the start of the copy.
David Horstmann36df4b22023-12-13 15:55:25 +0000191 *
David Horstmanne9a88ab2023-11-29 17:07:13 +0000192 * Assumptions:
193 * - psa_status_t status exists
194 * - An exit label is declared
David Horstmann36df4b22023-12-13 15:55:25 +0000195 * - input is the name of a pointer to the buffer to be copied
David Horstmann62a56d92023-12-14 18:12:47 +0000196 * - LOCAL_INPUT_DECLARE(input, input_copy) has previously been called
David Horstmanne9a88ab2023-11-29 17:07:13 +0000197 */
David Horstmann62a56d92023-12-14 18:12:47 +0000198#define LOCAL_INPUT_ALLOC(input, length, input_copy) \
David Horstmann36df4b22023-12-13 15:55:25 +0000199 status = psa_crypto_local_input_alloc(input, length, \
200 &LOCAL_INPUT_COPY_OF_##input); \
David Horstmanne9a88ab2023-11-29 17:07:13 +0000201 if (status != PSA_SUCCESS) { \
202 goto exit; \
203 } \
David Horstmann62a56d92023-12-14 18:12:47 +0000204 input_copy = LOCAL_INPUT_COPY_OF_##input.buffer;
David Horstmanne9a88ab2023-11-29 17:07:13 +0000205
David Horstmann36df4b22023-12-13 15:55:25 +0000206/* Free the local input copy allocated previously by LOCAL_INPUT_ALLOC()
207 *
David Horstmann3e72db42023-12-08 14:08:18 +0000208 * Assumptions:
David Horstmann62a56d92023-12-14 18:12:47 +0000209 * - input_copy is the name of the input copy pointer set by LOCAL_INPUT_ALLOC()
David Horstmann36df4b22023-12-13 15:55:25 +0000210 * - input is the name of the original buffer that was copied
David Horstmann3e72db42023-12-08 14:08:18 +0000211 */
David Horstmann62a56d92023-12-14 18:12:47 +0000212#define LOCAL_INPUT_FREE(input, input_copy) \
213 input_copy = NULL; \
David Horstmann36df4b22023-12-13 15:55:25 +0000214 psa_crypto_local_input_free(&LOCAL_INPUT_COPY_OF_##input);
David Horstmanne9a88ab2023-11-29 17:07:13 +0000215
David Horstmann62a56d92023-12-14 18:12:47 +0000216/* Declare a local copy of an output buffer and a variable that will be used
217 * to store a pointer to the start of the buffer.
David Horstmann36df4b22023-12-13 15:55:25 +0000218 *
219 * Note: This macro must be called before any operations which may jump to
220 * the exit label, so that the local output copy object is safe to be freed.
221 *
222 * Assumptions:
223 * - output is the name of a pointer to the buffer to be copied
224 * - The name LOCAL_OUTPUT_COPY_OF_output is unused in the current scope
David Horstmann62a56d92023-12-14 18:12:47 +0000225 * - output_copy_name is a name that is unused in the current scope
David Horstmann36df4b22023-12-13 15:55:25 +0000226 */
David Horstmann62a56d92023-12-14 18:12:47 +0000227#define LOCAL_OUTPUT_DECLARE(output, output_copy_name) \
228 psa_crypto_local_output_t LOCAL_OUTPUT_COPY_OF_##output = PSA_CRYPTO_LOCAL_OUTPUT_INIT; \
229 uint8_t *output_copy_name = NULL;
David Horstmann36df4b22023-12-13 15:55:25 +0000230
David Horstmann62a56d92023-12-14 18:12:47 +0000231/* Allocate a copy of the buffer output and set the pointer output_copy to
232 * point to the start of the copy.
David Horstmann36df4b22023-12-13 15:55:25 +0000233 *
David Horstmanne9a88ab2023-11-29 17:07:13 +0000234 * Assumptions:
235 * - psa_status_t status exists
236 * - An exit label is declared
David Horstmann36df4b22023-12-13 15:55:25 +0000237 * - output is the name of a pointer to the buffer to be copied
David Horstmann62a56d92023-12-14 18:12:47 +0000238 * - LOCAL_OUTPUT_DECLARE(output, output_copy) has previously been called
David Horstmanne9a88ab2023-11-29 17:07:13 +0000239 */
David Horstmann62a56d92023-12-14 18:12:47 +0000240#define LOCAL_OUTPUT_ALLOC(output, length, output_copy) \
David Horstmann36df4b22023-12-13 15:55:25 +0000241 status = psa_crypto_local_output_alloc(output, length, \
242 &LOCAL_OUTPUT_COPY_OF_##output); \
David Horstmanne9a88ab2023-11-29 17:07:13 +0000243 if (status != PSA_SUCCESS) { \
244 goto exit; \
245 } \
David Horstmann62a56d92023-12-14 18:12:47 +0000246 output_copy = LOCAL_OUTPUT_COPY_OF_##output.buffer;
David Horstmanne9a88ab2023-11-29 17:07:13 +0000247
David Horstmann62a56d92023-12-14 18:12:47 +0000248/* Free the local output copy allocated previously by LOCAL_OUTPUT_ALLOC()
David Horstmann3e72db42023-12-08 14:08:18 +0000249 * after first copying back its contents to the original buffer.
David Horstmann36df4b22023-12-13 15:55:25 +0000250 *
David Horstmann3e72db42023-12-08 14:08:18 +0000251 * Assumptions:
David Horstmann3e72db42023-12-08 14:08:18 +0000252 * - psa_status_t status exists
David Horstmann62a56d92023-12-14 18:12:47 +0000253 * - output_copy is the name of the output copy pointer set by LOCAL_OUTPUT_ALLOC()
254 * - output is the name of the original buffer that was copied
David Horstmann3e72db42023-12-08 14:08:18 +0000255 */
David Horstmann62a56d92023-12-14 18:12:47 +0000256#define LOCAL_OUTPUT_FREE(output, output_copy) \
257 output_copy = NULL; \
David Horstmann5a945f52023-12-13 14:09:08 +0000258 do { \
259 psa_status_t local_output_status; \
David Horstmann36df4b22023-12-13 15:55:25 +0000260 local_output_status = psa_crypto_local_output_free(&LOCAL_OUTPUT_COPY_OF_##output); \
David Horstmann5a945f52023-12-13 14:09:08 +0000261 if (local_output_status != PSA_SUCCESS) { \
262 /* Since this error case is an internal error, it's more serious than \
263 * any existing error code and so it's fine to overwrite the existing \
264 * status. */ \
265 status = local_output_status; \
266 } \
267 } while (0)
David Horstmann4a48bec2024-03-13 15:42:31 +0000268#else /* !MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS */
David Horstmann62a56d92023-12-14 18:12:47 +0000269#define LOCAL_INPUT_DECLARE(input, input_copy_name) \
270 const uint8_t *input_copy_name = NULL;
271#define LOCAL_INPUT_ALLOC(input, length, input_copy) \
272 input_copy = input;
273#define LOCAL_INPUT_FREE(input, input_copy) \
274 input_copy = NULL;
275#define LOCAL_OUTPUT_DECLARE(output, output_copy_name) \
276 uint8_t *output_copy_name = NULL;
277#define LOCAL_OUTPUT_ALLOC(output, length, output_copy) \
278 output_copy = output;
279#define LOCAL_OUTPUT_FREE(output, output_copy) \
280 output_copy = NULL;
David Horstmann4a48bec2024-03-13 15:42:31 +0000281#endif /* !MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS */
David Horstmanne9a88ab2023-11-29 17:07:13 +0000282
283
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100284int psa_can_do_hash(psa_algorithm_t hash_alg)
285{
286 (void) hash_alg;
Paul Elliott35816522024-02-23 17:47:42 +0000287 return psa_get_drivers_initialized();
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100288}
Valerio Settic6f004f2023-12-12 11:27:36 +0100289
Valerio Setti1fff4f22023-12-28 14:19:34 +0100290int psa_can_do_cipher(psa_key_type_t key_type, psa_algorithm_t cipher_alg)
Valerio Settic6f004f2023-12-12 11:27:36 +0100291{
Valerio Setti1fff4f22023-12-28 14:19:34 +0100292 (void) key_type;
Valerio Settic6f004f2023-12-12 11:27:36 +0100293 (void) cipher_alg;
Paul Elliott35816522024-02-23 17:47:42 +0000294 return psa_get_drivers_initialized();
Valerio Settic6f004f2023-12-12 11:27:36 +0100295}
296
297
Valerio Settia55f0422023-07-10 15:34:41 +0200298#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel53410502023-04-28 13:18:43 +0200299 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) || \
Valerio Settia55f0422023-07-10 15:34:41 +0200300 defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekiel134cc2e2023-05-05 10:13:37 +0200301static int psa_is_dh_key_size_valid(size_t bits)
302{
Valerio Setti504a1022024-01-17 15:19:30 +0100303 switch (bits) {
304#if defined(PSA_WANT_DH_RFC7919_2048)
305 case 2048:
306 return 1;
307#endif /* PSA_WANT_DH_RFC7919_2048 */
308#if defined(PSA_WANT_DH_RFC7919_3072)
309 case 3072:
310 return 1;
311#endif /* PSA_WANT_DH_RFC7919_3072 */
312#if defined(PSA_WANT_DH_RFC7919_4096)
313 case 4096:
314 return 1;
315#endif /* PSA_WANT_DH_RFC7919_4096 */
316#if defined(PSA_WANT_DH_RFC7919_6144)
317 case 6144:
318 return 1;
319#endif /* PSA_WANT_DH_RFC7919_6144 */
320#if defined(PSA_WANT_DH_RFC7919_8192)
321 case 8192:
322 return 1;
323#endif /* PSA_WANT_DH_RFC7919_8192 */
324 default:
325 return 0;
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200326 }
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200327}
Valerio Settia55f0422023-07-10 15:34:41 +0200328#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT ||
Przemek Stekiel53410502023-04-28 13:18:43 +0200329 MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY ||
Valerio Settia55f0422023-07-10 15:34:41 +0200330 PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE */
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100331
Gilles Peskine449bd832023-01-11 14:50:10 +0100332psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100333{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100334 /* Mbed TLS error codes can combine a high-level error code and a
335 * low-level error code. The low-level error usually reflects the
336 * root cause better, so dispatch on that preferably. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 int low_level_ret = -(-ret & 0x007f);
338 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100339 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100340 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100341
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100342#if defined(MBEDTLS_AES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100343 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
344 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100345 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman09a9e582023-08-31 11:05:22 +0100346 case MBEDTLS_ERR_AES_BAD_INPUT_DATA:
347 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100348#endif
349
350#if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_ASN1_WRITE_C)
Gilles Peskine9a944802018-06-21 09:35:35 +0200351 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
352 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
353 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
354 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
355 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100356 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200357 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100358 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200359 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100360 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100361#endif
Gilles Peskine9a944802018-06-21 09:35:35 +0200362
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100363#if defined(MBEDTLS_CAMELLIA_C)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000364 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Gilles Peskinea5905292018-02-07 20:59:33 +0100365 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100367#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100368
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100369#if defined(MBEDTLS_CCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100370 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100371 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100372 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100373 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100374#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100375
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100376#if defined(MBEDTLS_CHACHA20_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200377 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100378 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100379#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200380
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100381#if defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200382 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100383 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200384 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100385 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100386#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200387
Dave Rodgman509b5672023-08-16 19:26:23 +0100388#if defined(MBEDTLS_CIPHER_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100389 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100390 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100391 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100392 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100393 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100394 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100395 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100396 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100397 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100398 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100399 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100400 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100401 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100402 return PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100403#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100404
Gilles Peskine449bd832023-01-11 14:50:10 +0100405#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
406 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100407 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
408 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100409 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100410 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100411 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
412 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100413 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100414 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100415 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100416#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100417
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100418#if defined(MBEDTLS_DES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100419 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100421#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100422
Gilles Peskinee59236f2018-01-27 23:32:46 +0100423 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
424 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
425 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100426 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100427
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100428#if defined(MBEDTLS_GCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100429 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100430 return PSA_ERROR_INVALID_SIGNATURE;
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200431 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100432 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100433 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100434 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100435#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100436
Gilles Peskine82e57d12020-11-13 21:31:17 +0100437#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100438 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100439 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
440 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100441 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100442 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100443 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
444 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100445 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100446 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100447 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100448#endif
449
Dave Rodgmandea266f2023-08-31 11:52:43 +0100450#if defined(MBEDTLS_MD_LIGHT)
Gilles Peskinea5905292018-02-07 20:59:33 +0100451 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100452 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100453 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100454 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100455 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100456 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100457#if defined(MBEDTLS_FS_IO)
Gilles Peskinea5905292018-02-07 20:59:33 +0100458 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100459 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100460#endif
461#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100462
Dave Rodgman509b5672023-08-16 19:26:23 +0100463#if defined(MBEDTLS_BIGNUM_C)
464#if defined(MBEDTLS_FS_IO)
Gilles Peskinef76aa772018-10-29 19:24:33 +0100465 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100466 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100467#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100468 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100469 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100470 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
Gilles Peskine449bd832023-01-11 14:50:10 +0100471 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100472 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100473 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100474 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100476 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100477 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100478 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100480 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100481 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100482#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100483
Dave Rodgman509b5672023-08-16 19:26:23 +0100484#if defined(MBEDTLS_PK_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100485 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100486 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100487 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
488 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100489 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100490#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) || defined(MBEDTLS_FS_IO) || \
491 defined(MBEDTLS_PSA_ITS_FILE_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100492 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100493 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100494#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100495 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
496 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100497 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100498 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100499 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100500 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
501 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100502 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100503 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100504 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100505 case MBEDTLS_ERR_PK_INVALID_ALG:
506 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
507 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100508 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100509 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200511 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100512 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100513#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100514
Gilles Peskineff2d2002019-05-06 15:26:23 +0200515 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100516 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200517 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100518 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200519
Dave Rodgman509b5672023-08-16 19:26:23 +0100520#if defined(MBEDTLS_RSA_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100521 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100523 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100524 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100525 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100526 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100527 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100529 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
530 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100531 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100532 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100533 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100534 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100535 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100536 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100538#endif
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200539
Dave Rodgman1dab4452023-09-01 09:59:51 +0100540#if defined(MBEDTLS_ECP_LIGHT)
itayzafrir5c753392018-05-08 11:18:38 +0300541 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300542 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300544 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100545 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300546 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300548 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
549 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100550 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300551 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100553 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100554 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100555
Dave Rodgman509b5672023-08-16 19:26:23 +0100556#if defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +0000557 case MBEDTLS_ERR_ECP_IN_PROGRESS:
558 return PSA_OPERATION_INCOMPLETE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100559#endif
560#endif
Paul Elliott588f8ed2022-12-02 18:10:26 +0000561
Janos Follatha13b9052019-11-22 12:48:59 +0000562 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100563 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300564
Gilles Peskinee59236f2018-01-27 23:32:46 +0100565 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100566 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100567 }
568}
569
Paul Elliottdc42ca82023-02-24 18:11:59 +0000570/**
571 * \brief For output buffers which contain "tags"
572 * (outputs that may be checked for validity like
573 * hashes, MACs and signatures), fill the unused
574 * part of the output buffer (the whole buffer on
575 * error, the trailing part on success) with
576 * something that isn't a valid tag (barring an
577 * attack on the tag and deliberately-crafted
578 * input), in case the caller doesn't check the
579 * return status properly.
580 *
581 * \param output_buffer Pointer to buffer to wipe. May not be NULL
582 * unless \p output_buffer_size is zero.
583 * \param status Status of function called to generate
584 * output_buffer originally
585 * \param output_buffer_size Size of output buffer. If zero, \p output_buffer
586 * could be NULL.
587 * \param output_buffer_length Length of data written to output_buffer, must be
588 * less than \p output_buffer_size
589 */
590static void psa_wipe_tag_output_buffer(uint8_t *output_buffer, psa_status_t status,
Paul Elliott7118d172023-02-26 16:57:05 +0000591 size_t output_buffer_size, size_t output_buffer_length)
592{
Paul Elliottdc42ca82023-02-24 18:11:59 +0000593 size_t offset = 0;
594
595 if (output_buffer_size == 0) {
596 /* If output_buffer_size is 0 then we have nothing to do. We must not
597 call memset because output_buffer may be NULL in this case */
598 return;
599 }
600
601 if (status == PSA_SUCCESS) {
602 offset = output_buffer_length;
603 }
604
605 memset(output_buffer + offset, '!', output_buffer_size - offset);
606}
607
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200608
Gilles Peskine449bd832023-01-11 14:50:10 +0100609psa_status_t psa_validate_unstructured_key_bit_size(psa_key_type_t type,
610 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200611{
612 /* Check that the bit size is acceptable for the key type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100613 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200614 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200615 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200616 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200617 case PSA_KEY_TYPE_PASSWORD:
618 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200619 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100620#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200621 case PSA_KEY_TYPE_AES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100622 if (bits != 128 && bits != 192 && bits != 256) {
623 return PSA_ERROR_INVALID_ARGUMENT;
624 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200625 break;
626#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200627#if defined(PSA_WANT_KEY_TYPE_ARIA)
628 case PSA_KEY_TYPE_ARIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100629 if (bits != 128 && bits != 192 && bits != 256) {
630 return PSA_ERROR_INVALID_ARGUMENT;
631 }
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200632 break;
633#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100634#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200635 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100636 if (bits != 128 && bits != 192 && bits != 256) {
637 return PSA_ERROR_INVALID_ARGUMENT;
638 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200639 break;
640#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100641#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200642 case PSA_KEY_TYPE_DES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100643 if (bits != 64 && bits != 128 && bits != 192) {
644 return PSA_ERROR_INVALID_ARGUMENT;
645 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200646 break;
647#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100648#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200649 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine449bd832023-01-11 14:50:10 +0100650 if (bits != 256) {
651 return PSA_ERROR_INVALID_ARGUMENT;
652 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200653 break;
654#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200655 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100656 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200657 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100658 if (bits % 8 != 0) {
659 return PSA_ERROR_INVALID_ARGUMENT;
660 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200661
Gilles Peskine449bd832023-01-11 14:50:10 +0100662 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200663}
664
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100665/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100666 *
Steven Cooremancd640932021-03-08 12:00:27 +0100667 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
668 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100669 *
670 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100671 * \param[in] key_type The key type of the key to be used with the
672 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100673 *
674 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100675 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100676 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100677 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100678 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100679MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100680 psa_algorithm_t algorithm,
Gilles Peskine449bd832023-01-11 14:50:10 +0100681 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100682{
Gilles Peskine449bd832023-01-11 14:50:10 +0100683 if (PSA_ALG_IS_HMAC(algorithm)) {
684 if (key_type == PSA_KEY_TYPE_HMAC) {
685 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100686 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100687 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100688
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
690 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
691 * key. */
692 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
693 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
694 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
695 * the block length (larger than 1) for block ciphers. */
696 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
697 return PSA_SUCCESS;
698 }
699 }
700 }
701
702 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100703}
704
Gilles Peskine449bd832023-01-11 14:50:10 +0100705psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
706 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200707{
Valerio Setti8d4f1502024-06-14 07:49:05 +0200708#if defined(MBEDTLS_PSA_STATIC_KEY_SLOTS)
Valerio Setti8d4f1502024-06-14 07:49:05 +0200709 if (buffer_length > ((size_t) MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE)) {
710 return PSA_ERROR_NOT_SUPPORTED;
711 }
Valerio Setti8d4f1502024-06-14 07:49:05 +0200712#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 if (slot->key.data != NULL) {
714 return PSA_ERROR_ALREADY_EXISTS;
715 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200716
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 slot->key.data = mbedtls_calloc(1, buffer_length);
718 if (slot->key.data == NULL) {
719 return PSA_ERROR_INSUFFICIENT_MEMORY;
720 }
Valerio Setti8d4f1502024-06-14 07:49:05 +0200721#endif
Steven Cooreman75b74362020-07-28 14:30:13 +0200722
Ronald Cronea0f8a62020-11-25 17:52:23 +0100723 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100724 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200725}
726
Gilles Peskine449bd832023-01-11 14:50:10 +0100727psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
728 const uint8_t *data,
729 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200730{
Gilles Peskine449bd832023-01-11 14:50:10 +0100731 psa_status_t status = psa_allocate_buffer_to_slot(slot,
732 data_length);
733 if (status != PSA_SUCCESS) {
734 return status;
735 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200736
Gilles Peskine449bd832023-01-11 14:50:10 +0100737 memcpy(slot->key.data, data, data_length);
738 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200739}
740
Ronald Crona0fe59f2020-11-29 11:14:53 +0100741psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100742 const psa_key_attributes_t *attributes,
743 const uint8_t *data, size_t data_length,
744 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100745 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100746{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100747 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f107ae2024-02-28 01:26:46 +0100748 psa_key_type_t type = attributes->type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100749
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200750 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100751 if (data_length == 0) {
752 return PSA_ERROR_NOT_SUPPORTED;
753 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200754
Gilles Peskine449bd832023-01-11 14:50:10 +0100755 if (key_type_is_raw_bytes(type)) {
756 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200757
Gilles Peskine2f107ae2024-02-28 01:26:46 +0100758 status = psa_validate_unstructured_key_bit_size(attributes->type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100759 *bits);
760 if (status != PSA_SUCCESS) {
761 return status;
762 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200763
Ronald Crondd04d422020-11-28 15:14:42 +0100764 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100765 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100766 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100767 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200768
Gilles Peskine449bd832023-01-11 14:50:10 +0100769 return PSA_SUCCESS;
770 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +0200771#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200772 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100773 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200774 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Valerio Setti504a1022024-01-17 15:19:30 +0100775 return PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100776 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200777 return mbedtls_psa_ffdh_import_key(attributes,
778 data, data_length,
779 key_buffer, key_buffer_size,
780 key_buffer_length,
781 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100782 }
Valerio Settia55f0422023-07-10 15:34:41 +0200783#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200784 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti27c501a2023-06-27 16:58:52 +0200785#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100786 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
787 if (PSA_KEY_TYPE_IS_ECC(type)) {
788 return mbedtls_psa_ecp_import_key(attributes,
789 data, data_length,
790 key_buffer, key_buffer_size,
791 key_buffer_length,
792 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100793 }
Valerio Setti27c501a2023-06-27 16:58:52 +0200794#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800795 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settife478902023-07-25 12:27:19 +0200796#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
797 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100798 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
799 if (PSA_KEY_TYPE_IS_RSA(type)) {
800 return mbedtls_psa_rsa_import_key(attributes,
801 data, data_length,
802 key_buffer, key_buffer_size,
803 key_buffer_length,
804 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200805 }
Valerio Settife478902023-07-25 12:27:19 +0200806#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
807 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -0800808 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100809 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100810
Gilles Peskine449bd832023-01-11 14:50:10 +0100811 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100812}
813
Gilles Peskinef603c712019-01-19 13:40:11 +0100814/** Calculate the intersection of two algorithm usage policies.
815 *
816 * Return 0 (which allows no operation) on incompatibility.
817 */
818static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100819 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100820 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100821 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100822{
Gilles Peskine549ea862019-05-22 11:45:59 +0200823 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100824 if (alg1 == alg2) {
825 return alg1;
826 }
Steven Cooreman03488022021-02-18 12:07:20 +0100827 /* If the policies are from the same hash-and-sign family, check
828 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100829 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
830 PSA_ALG_IS_SIGN_HASH(alg2) &&
831 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
832 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
833 return alg2;
834 }
835 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
836 return alg1;
837 }
Steven Cooreman03488022021-02-18 12:07:20 +0100838 }
839 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100840 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100841 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100842 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
843 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
844 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
845 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
846 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100847 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100848
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100849 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100850 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
851 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
852 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
853 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100854 }
855 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100856 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
857 (alg1_len <= alg2_len)) {
858 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100859 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100860 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
861 (alg2_len <= alg1_len)) {
862 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100863 }
864 }
865 /* If the policies are from the same MAC family, check whether one
866 * of them is a minimum-MAC-length policy. Calculate the most
867 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100868 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
869 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
870 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100871 /* Validate the combination of key type and algorithm. Since the base
872 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100873 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
874 return 0;
875 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100876
Steven Cooreman31a876d2021-03-03 20:47:40 +0100877 /* Get the (exact or at-least) output lengths for both sides of the
878 * requested intersection. None of the currently supported algorithms
879 * have an output length dependent on the actual key size, so setting it
880 * to a bogus value of 0 is currently OK.
881 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100882 * Note that for at-least-this-length wildcard algorithms, the output
883 * length is set to the shortest allowed length, which allows us to
884 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100885 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
886 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100887 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100888
Steven Cooremana1d83222021-02-25 10:20:29 +0100889 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100890 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
891 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
892 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100893 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100894
895 /* If only one is an at-least-this-length policy, the intersection would
896 * be the other (fixed-length) policy as long as said fixed length is
897 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100898 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
899 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100900 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100901 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
902 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100903 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100904
Steven Cooremancd640932021-03-08 12:00:27 +0100905 /* If none of them are wildcards, check whether they define the same tag
906 * length. This is still possible here when one is default-length and
907 * the other specific-length. Ensure to always return the
908 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100909 if (alg1_len == alg2_len) {
910 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
911 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100912 }
913 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100914 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100915}
916
Gilles Peskine449bd832023-01-11 14:50:10 +0100917static int psa_key_algorithm_permits(psa_key_type_t key_type,
918 psa_algorithm_t policy_alg,
919 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200920{
Gilles Peskine549ea862019-05-22 11:45:59 +0200921 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100922 if (requested_alg == policy_alg) {
923 return 1;
924 }
Steven Cooreman03488022021-02-18 12:07:20 +0100925 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
926 * and requested_alg is the same hash-and-sign family with any hash,
927 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100928 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
929 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
930 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
931 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100932 }
933 /* If policy_alg is a wildcard AEAD algorithm of the same base as
934 * the requested algorithm, check the requested tag length to be
935 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100936 if (PSA_ALG_IS_AEAD(policy_alg) &&
937 PSA_ALG_IS_AEAD(requested_alg) &&
938 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
939 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
940 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
941 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
942 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100943 }
Steven Cooremancd640932021-03-08 12:00:27 +0100944 /* If policy_alg is a MAC algorithm of the same base as the requested
945 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100946 if (PSA_ALG_IS_MAC(policy_alg) &&
947 PSA_ALG_IS_MAC(requested_alg) &&
948 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
949 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100950 /* Validate the combination of key type and algorithm. Since the policy
951 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100952 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
953 return 0;
954 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100955
Steven Cooreman31a876d2021-03-03 20:47:40 +0100956 /* Get both the requested output length for the algorithm which is to be
957 * verified, and the default output length for the base algorithm.
958 * Note that none of the currently supported algorithms have an output
959 * length dependent on actual key size, so setting it to a bogus value
960 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100961 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100962 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100963 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100964 key_type, 0,
965 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100966
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100967 /* If the policy is default-length, only allow an algorithm with
968 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100969 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
970 return requested_output_length == default_output_length;
971 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100972
973 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100974 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100975 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
976 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
977 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100978 }
979
Steven Cooremancd640932021-03-08 12:00:27 +0100980 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
981 * check for the requested MAC length to be equal to or longer than the
982 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100983 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
984 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
985 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100986 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200987 }
Steven Cooremance48e852020-10-05 16:02:45 +0200988 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200989 * a key derivation with that key agreement should also be allowed. This
990 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100991 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
992 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
993 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
994 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +0200995 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100996 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100997 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200998}
999
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001000/** Test whether a policy permits an algorithm.
1001 *
1002 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +01001003 *
Steven Cooreman5a172672021-03-02 21:27:42 +01001004 * \note This function requires providing the key type for which the policy is
1005 * being validated, since some algorithm policy definitions (e.g. MAC)
1006 * have different properties depending on what kind of cipher it is
1007 * combined with.
1008 *
Steven Cooreman7e39f052021-02-23 14:18:32 +01001009 * \retval PSA_SUCCESS When \p alg is a specific algorithm
1010 * allowed by the \p policy.
1011 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
1012 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
1013 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001014 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001015static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
1016 psa_key_type_t key_type,
1017 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001018{
Steven Cooremand788fab2021-02-25 11:29:17 +01001019 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01001020 if (alg == 0) {
1021 return PSA_ERROR_INVALID_ARGUMENT;
1022 }
Steven Cooremand788fab2021-02-25 11:29:17 +01001023
Steven Cooreman7e39f052021-02-23 14:18:32 +01001024 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001025 if (PSA_ALG_IS_WILDCARD(alg)) {
1026 return PSA_ERROR_INVALID_ARGUMENT;
1027 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001028
Gilles Peskine449bd832023-01-11 14:50:10 +01001029 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
1030 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
1031 return PSA_SUCCESS;
1032 } else {
1033 return PSA_ERROR_NOT_PERMITTED;
1034 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001035}
1036
Gilles Peskinef603c712019-01-19 13:40:11 +01001037/** Restrict a key policy based on a constraint.
1038 *
Steven Cooreman5a172672021-03-02 21:27:42 +01001039 * \note This function requires providing the key type for which the policy is
1040 * being restricted, since some algorithm policy definitions (e.g. MAC)
1041 * have different properties depending on what kind of cipher it is
1042 * combined with.
1043 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001044 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +01001045 * \param[in,out] policy The policy to restrict.
1046 * \param[in] constraint The policy constraint to apply.
1047 *
1048 * \retval #PSA_SUCCESS
1049 * \c *policy contains the intersection of the original value of
1050 * \c *policy and \c *constraint.
1051 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001052 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +01001053 * \c *policy is unchanged.
1054 */
1055static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001056 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +01001057 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +01001059{
1060 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 psa_key_policy_algorithm_intersection(key_type, policy->alg,
1062 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +02001063 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
1065 constraint->alg2);
1066 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
1067 return PSA_ERROR_INVALID_ARGUMENT;
1068 }
1069 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
1070 return PSA_ERROR_INVALID_ARGUMENT;
1071 }
Gilles Peskinef603c712019-01-19 13:40:11 +01001072 policy->usage &= constraint->usage;
1073 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001074 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +01001076}
1077
Przemek Stekiel061f6942022-11-30 10:51:35 +01001078/** Get the description of a key given its identifier and policy constraints
1079 * and lock it.
1080 *
1081 * The key must have allow all the usage flags set in \p usage. If \p alg is
1082 * nonzero, the key must allow operations with this algorithm. If \p alg is
1083 * zero, the algorithm is not checked.
1084 *
1085 * In case of a persistent key, the function loads the description of the key
1086 * into a key slot if not already done.
1087 *
Ryan Everett098c6652024-01-03 13:03:36 +00001088 * On success, the returned key slot has been registered for reading.
Ryan Everett93cea572024-02-20 18:01:29 +00001089 * It is the responsibility of the caller to then unregister
1090 * once they have finished reading the contents of the slot.
1091 * The caller unregisters by calling psa_unregister_read() or
1092 * psa_unregister_read_under_mutex(). psa_unregister_read() must be called
1093 * if and only if the caller already holds the global key slot mutex
1094 * (when mutexes are enabled). psa_unregister_read_under_mutex() encapsulates
1095 * the unregister with mutex lock and unlock operations.
Przemek Stekiel061f6942022-11-30 10:51:35 +01001096 */
1097static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01001098 mbedtls_svc_key_id_t key,
1099 psa_key_slot_t **p_slot,
1100 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +01001102{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001103 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01001104 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001105
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 status = psa_get_and_lock_key_slot(key, p_slot);
1107 if (status != PSA_SUCCESS) {
1108 return status;
1109 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001110 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001111
1112 /* Enforce that usage policy for the key slot contains all the flags
1113 * required by the usage parameter. There is one exception: public
1114 * keys can always be exported, so we treat public key objects as
1115 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001116 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +01001117 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001118 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001119
Gilles Peskine449bd832023-01-11 14:50:10 +01001120 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +01001121 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001122 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001123 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001124
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001125 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 if (alg != 0) {
1127 status = psa_key_policy_permits(&slot->attr.policy,
1128 slot->attr.type,
1129 alg);
1130 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +01001131 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001133 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001134
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001136
1137error:
1138 *p_slot = NULL;
Ryan Everettfb792ca2024-01-31 13:40:05 +00001139 psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001140
Gilles Peskine449bd832023-01-11 14:50:10 +01001141 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +01001142}
Darryl Green940d72c2018-07-13 13:18:51 +01001143
Ronald Cron5c522922020-11-14 16:35:34 +01001144/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001145 *
1146 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +02001147 * available, as opposed to a key in a secure element and/or to be used
1148 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001149 *
Ronald Cronddae0f52021-08-24 15:39:44 +02001150 * This is a temporary function that may be used instead of
1151 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
1152 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001153 *
Ryan Everett098c6652024-01-03 13:03:36 +00001154 * On success, the returned key slot has been registered for reading.
Ryan Everett93cea572024-02-20 18:01:29 +00001155 * It is the responsibility of the caller to then unregister
1156 * once they have finished reading the contents of the slot.
1157 * The caller unregisters by calling psa_unregister_read() or
1158 * psa_unregister_read_under_mutex(). psa_unregister_read() must be called
1159 * if and only if the caller already holds the global key slot mutex
1160 * (when mutexes are enabled). psa_unregister_read_under_mutex() encapsulates
1161 * psa_unregister_read() with mutex lock and unlock operations.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001162 */
Ronald Cron5c522922020-11-14 16:35:34 +01001163static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1164 mbedtls_svc_key_id_t key,
1165 psa_key_slot_t **p_slot,
1166 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001167 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +02001168{
Gilles Peskine449bd832023-01-11 14:50:10 +01001169 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
1170 usage, alg);
1171 if (status != PSA_SUCCESS) {
1172 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001173 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001174
Gilles Peskine449bd832023-01-11 14:50:10 +01001175 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
Ryan Everettfb792ca2024-01-31 13:40:05 +00001176 psa_unregister_read_under_mutex(*p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001177 *p_slot = NULL;
1178 return PSA_ERROR_NOT_SUPPORTED;
1179 }
1180
1181 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001182}
Gilles Peskine28f8f302019-07-24 13:30:31 +02001183
Gilles Peskine449bd832023-01-11 14:50:10 +01001184psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +00001185{
Valerio Settidbfb2ab2024-08-16 12:52:19 +02001186#if defined(MBEDTLS_PSA_STATIC_KEY_SLOTS)
1187 if (slot->key.bytes > 0) {
1188 mbedtls_platform_zeroize(slot->key.data, MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE);
1189 }
1190#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001191 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +01001192 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01001193 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001194
Ronald Cronea0f8a62020-11-25 17:52:23 +01001195 slot->key.data = NULL;
Valerio Setti8d4f1502024-06-14 07:49:05 +02001196#endif /* MBEDTLS_PSA_STATIC_KEY_SLOTS */
1197
Ronald Cronea0f8a62020-11-25 17:52:23 +01001198 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001199
Gilles Peskine449bd832023-01-11 14:50:10 +01001200 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001201}
1202
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001203/** Completely wipe a slot in memory, including its policy.
1204 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001205psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001206{
Gilles Peskine449bd832023-01-11 14:50:10 +01001207 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001208
Gilles Peskine449bd832023-01-11 14:50:10 +01001209 /*
1210 * As the return error code may not be handled in case of multiple errors,
Ryan Everett7ed542e2024-01-17 11:39:09 +00001211 * do our best to report an unexpected amount of registered readers or
1212 * an unexpected state.
1213 * Assert with MBEDTLS_TEST_HOOK_TEST_ASSERT that the slot is valid for
1214 * wiping.
Gilles Peskine449bd832023-01-11 14:50:10 +01001215 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1216 * function is called as part of the execution of a test suite, the
1217 * execution of the test suite is stopped in error if the assertion fails.
1218 */
Ryan Everett7ed542e2024-01-17 11:39:09 +00001219 switch (slot->state) {
1220 case PSA_SLOT_FULL:
1221 /* In this state psa_wipe_key_slot() must only be called if the
1222 * caller is the last reader. */
1223 case PSA_SLOT_PENDING_DELETION:
1224 /* In this state psa_wipe_key_slot() must only be called if the
1225 * caller is the last reader. */
Gilles Peskine47ad2f72024-06-10 11:42:41 +02001226 if (slot->var.occupied.registered_readers != 1) {
1227 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->var.occupied.registered_readers == 1);
Ryan Everett7ed542e2024-01-17 11:39:09 +00001228 status = PSA_ERROR_CORRUPTION_DETECTED;
1229 }
1230 break;
1231 case PSA_SLOT_FILLING:
1232 /* In this state registered_readers must be 0. */
Gilles Peskine47ad2f72024-06-10 11:42:41 +02001233 if (slot->var.occupied.registered_readers != 0) {
1234 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->var.occupied.registered_readers == 0);
Ryan Everett7ed542e2024-01-17 11:39:09 +00001235 status = PSA_ERROR_CORRUPTION_DETECTED;
1236 }
1237 break;
1238 case PSA_SLOT_EMPTY:
1239 /* The slot is already empty, it cannot be wiped. */
1240 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->state != PSA_SLOT_EMPTY);
1241 status = PSA_ERROR_CORRUPTION_DETECTED;
1242 break;
1243 default:
1244 /* The slot's state is invalid. */
1245 status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronddd3d052020-10-30 14:07:07 +01001246 }
1247
Gilles Peskinee8199f52024-06-10 11:53:33 +02001248#if defined(MBEDTLS_PSA_KEY_STORE_DYNAMIC)
1249 size_t slice_index = slot->slice_index;
1250#endif /* MBEDTLS_PSA_KEY_STORE_DYNAMIC */
1251
1252
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001253 /* Multipart operations may still be using the key. This is safe
1254 * because all multipart operation objects are independent from
1255 * the key slot: if they need to access the key after the setup
1256 * phase, they have a copy of the key. Note that this means that
1257 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001258 /* At this point, key material and other type-specific content has
1259 * been wiped. Clear remaining metadata. We can call memset and not
Ryan Everettaa33c512023-12-21 17:32:07 +00001260 * zeroize because the metadata is not particularly sensitive.
1261 * This memset also sets the slot's state to PSA_SLOT_EMPTY. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001262 memset(slot, 0, sizeof(*slot));
Gilles Peskinee8199f52024-06-10 11:53:33 +02001263
1264#if defined(MBEDTLS_PSA_KEY_STORE_DYNAMIC)
1265 /* If the slot is already corrupted, something went deeply wrong,
1266 * like a thread still using the slot or a stray pointer leading
1267 * to the slot's memory being used for another object. Let the slot
1268 * leak rather than make the corruption worse. */
1269 if (status == PSA_SUCCESS) {
1270 status = psa_free_key_slot(slice_index, slot);
1271 }
1272#endif /* MBEDTLS_PSA_KEY_STORE_DYNAMIC */
1273
Gilles Peskine449bd832023-01-11 14:50:10 +01001274 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001275}
1276
Gilles Peskine449bd832023-01-11 14:50:10 +01001277psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001278{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001279 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001280 psa_status_t status; /* status of the last operation */
1281 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001282#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1283 psa_se_drv_table_entry_t *driver;
1284#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001285
Gilles Peskine449bd832023-01-11 14:50:10 +01001286 if (mbedtls_svc_key_id_is_null(key)) {
1287 return PSA_SUCCESS;
1288 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001289
Ronald Cronf2911112020-10-29 17:51:10 +01001290 /*
Ryan Everett7ed542e2024-01-17 11:39:09 +00001291 * Get the description of the key in a key slot, and register to read it.
1292 * In the case of a persistent key, this will load the key description
1293 * from persistent memory if not done yet.
1294 * We cannot avoid this loading as without it we don't know if
Ronald Cronf2911112020-10-29 17:51:10 +01001295 * the key is operated by an SE or not and this information is needed by
Ryan Everett7ed542e2024-01-17 11:39:09 +00001296 * the current implementation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001297 status = psa_get_and_lock_key_slot(key, &slot);
1298 if (status != PSA_SUCCESS) {
1299 return status;
1300 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001301
Ryan Everettc053d962024-01-25 17:56:32 +00001302#if defined(MBEDTLS_THREADING_C)
Ryan Everett763971f2024-01-29 17:13:36 +00001303 /* We cannot unlock between setting the state to PENDING_DELETION
1304 * and destroying the key in storage, as otherwise another thread
1305 * could load the key into a new slot and the key will not be
1306 * fully destroyed. */
Ryan Everettc053d962024-01-25 17:56:32 +00001307 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(
1308 &mbedtls_threading_key_slot_mutex));
Ryan Everettd868b742024-03-08 18:35:09 +00001309
1310 if (slot->state == PSA_SLOT_PENDING_DELETION) {
1311 /* Another thread has destroyed the key between us locking the slot
1312 * and us gaining the mutex. Unregister from the slot,
1313 * and report that the key does not exist. */
1314 status = psa_unregister_read(slot);
1315
1316 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1317 &mbedtls_threading_key_slot_mutex));
1318 return (status == PSA_SUCCESS) ? PSA_ERROR_INVALID_HANDLE : status;
1319 }
Ryan Everettc053d962024-01-25 17:56:32 +00001320#endif
Ryan Everett7ed542e2024-01-17 11:39:09 +00001321 /* Set the key slot containing the key description's state to
1322 * PENDING_DELETION. This stops new operations from registering
1323 * to read the slot. Current readers can safely continue to access
1324 * the key within the slot; the last registered reader will
1325 * automatically wipe the slot when they call psa_unregister_read().
1326 * If the key is persistent, we can now delete the copy of the key
1327 * from memory. If the key is opaque, we require the driver to
1328 * deal with the deletion. */
Ryan Everettd868b742024-03-08 18:35:09 +00001329 overall_status = psa_key_slot_state_transition(slot, PSA_SLOT_FULL,
1330 PSA_SLOT_PENDING_DELETION);
Ryan Everettc053d962024-01-25 17:56:32 +00001331
Ryan Everettd868b742024-03-08 18:35:09 +00001332 if (overall_status != PSA_SUCCESS) {
Ryan Everettc053d962024-01-25 17:56:32 +00001333 goto exit;
1334 }
Ronald Cronf2911112020-10-29 17:51:10 +01001335
Gilles Peskine449bd832023-01-11 14:50:10 +01001336 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001337 /* Refuse the destruction of a read-only key (which may or may not work
1338 * if we attempt it, depending on whether the key is merely read-only
1339 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001340 * Just do the best we can, which is to wipe the copy in memory
1341 * (done in this function's cleanup code). */
1342 overall_status = PSA_ERROR_NOT_PERMITTED;
1343 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001344 }
1345
Gilles Peskine354f7672019-07-12 23:46:38 +02001346#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001347 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1348 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001349 /* For a key in a secure element, we need to do three things:
1350 * remove the key file in internal storage, destroy the
1351 * key inside the secure element, and update the driver's
1352 * persistent data. Start a transaction that will encompass these
1353 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001354 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001355 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001356 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001357 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001358 status = psa_crypto_save_transaction();
1359 if (status != PSA_SUCCESS) {
1360 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001361 /* We should still try to destroy the key in the secure
1362 * element and the key metadata in storage. This is especially
1363 * important if the error is that the storage is full.
1364 * But how to do it exactly without risking an inconsistent
1365 * state after a reset?
1366 * https://github.com/ARMmbed/mbed-crypto/issues/215
1367 */
1368 overall_status = status;
1369 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001370 }
1371
Gilles Peskine449bd832023-01-11 14:50:10 +01001372 status = psa_destroy_se_key(driver,
1373 psa_key_slot_get_slot_number(slot));
1374 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001375 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001376 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001377 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001378#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1379
Darryl Greend49a4992018-06-18 17:27:26 +01001380#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001381 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ryan Everett4a0ba802024-01-17 14:12:33 +00001382 /* Destroy the copy of the persistent key from storage.
Ryan Everett7ed542e2024-01-17 11:39:09 +00001383 * The slot will still hold a copy of the key until the last reader
1384 * unregisters. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001385 status = psa_destroy_persistent_key(slot->attr.id);
1386 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001387 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001388 }
Darryl Greend49a4992018-06-18 17:27:26 +01001389 }
1390#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001391
Gilles Peskinefc762652019-07-22 19:30:34 +02001392#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001393 if (driver != NULL) {
1394 status = psa_save_se_persistent_data(driver);
1395 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001396 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001397 }
1398 status = psa_crypto_stop_transaction();
1399 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001400 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001402 }
1403#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1404
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001405exit:
Ryan Everett7ed542e2024-01-17 11:39:09 +00001406 /* Unregister from reading the slot. If we are the last active reader
1407 * then this will wipe the slot. */
1408 status = psa_unregister_read(slot);
1409 /* Prioritize CORRUPTION_DETECTED from unregistering over
1410 * a storage error. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001411 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001412 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 }
Ryan Everettc053d962024-01-25 17:56:32 +00001414
1415#if defined(MBEDTLS_THREADING_C)
Ryan Everett7fee4f72024-02-09 14:11:27 +00001416 /* Don't overwrite existing errors if the unlock fails. */
1417 status = overall_status;
Ryan Everettc053d962024-01-25 17:56:32 +00001418 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1419 &mbedtls_threading_key_slot_mutex));
1420#endif
1421
Gilles Peskine449bd832023-01-11 14:50:10 +01001422 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001423}
1424
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001425/** Retrieve all the publicly-accessible attributes of a key.
1426 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001427psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1428 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001429{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001430 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001431 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001432
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001434
Gilles Peskine449bd832023-01-11 14:50:10 +01001435 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1436 if (status != PSA_SUCCESS) {
1437 return status;
1438 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001439
Gilles Peskine7fad3ef2024-02-28 01:08:27 +01001440 *attributes = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001441
1442#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001443 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1444 psa_set_key_slot_number(attributes,
1445 psa_key_slot_get_slot_number(slot));
1446 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001447#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001448
Gilles Peskine97c0b2f2024-02-16 00:49:46 +01001449 return psa_unregister_read_under_mutex(slot);
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001450}
1451
Gilles Peskinec8000c02019-08-02 20:15:51 +02001452#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1453psa_status_t psa_get_key_slot_number(
1454 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001455 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001456{
Gilles Peskine972539c2024-02-28 01:49:45 +01001457 if (attributes->has_slot_number) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001458 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001459 return PSA_SUCCESS;
1460 } else {
1461 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001462 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001463}
1464#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1465
Gilles Peskine449bd832023-01-11 14:50:10 +01001466static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1467 size_t key_buffer_size,
1468 uint8_t *data,
1469 size_t data_size,
1470 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001471{
Gilles Peskine449bd832023-01-11 14:50:10 +01001472 if (key_buffer_size > data_size) {
1473 return PSA_ERROR_BUFFER_TOO_SMALL;
1474 }
1475 memcpy(data, key_buffer, key_buffer_size);
1476 memset(data + key_buffer_size, 0,
1477 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001478 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001479 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001480}
1481
Ronald Cron7285cda2020-11-26 14:46:37 +01001482psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001483 const psa_key_attributes_t *attributes,
1484 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001485 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001486{
Gilles Peskine2f107ae2024-02-28 01:26:46 +01001487 psa_key_type_t type = attributes->type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001488
Gilles Peskine449bd832023-01-11 14:50:10 +01001489 if (key_type_is_raw_bytes(type) ||
1490 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001491 PSA_KEY_TYPE_IS_ECC(type) ||
1492 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001493 return psa_export_key_buffer_internal(
1494 key_buffer, key_buffer_size,
1495 data, data_size, data_length);
1496 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001497 /* This shouldn't happen in the reference implementation, but
1498 it is valid for a special-purpose implementation to omit
1499 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001500 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001501 }
1502}
1503
Gilles Peskine449bd832023-01-11 14:50:10 +01001504psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
Ryan Everett45ac5262024-01-08 17:15:19 +00001505 uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01001506 size_t data_size,
1507 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001508{
1509 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1510 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1511 psa_key_slot_t *slot;
Ryan Everett45ac5262024-01-08 17:15:19 +00001512 LOCAL_OUTPUT_DECLARE(data_external, data);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001513
Ronald Crone907e552021-01-18 13:22:38 +01001514 /* Reject a zero-length output buffer now, since this can never be a
1515 * valid key representation. This way we know that data must be a valid
1516 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001517 if (data_size == 0) {
1518 return PSA_ERROR_BUFFER_TOO_SMALL;
1519 }
Ronald Crone907e552021-01-18 13:22:38 +01001520
Ronald Cron9486f9d2020-11-26 13:36:23 +01001521 /* Set the key to empty now, so that even when there are errors, we always
1522 * set data_length to a value between 0 and data_size. On error, setting
1523 * the key to empty is a good choice because an empty key representation is
1524 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001525 *data_length = 0;
1526
Ronald Cron9486f9d2020-11-26 13:36:23 +01001527 /* Export requires the EXPORT flag. There is an exception for public keys,
1528 * which don't require any flag, but
1529 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1530 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001531 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1532 PSA_KEY_USAGE_EXPORT, 0);
1533 if (status != PSA_SUCCESS) {
1534 return status;
1535 }
mohammad160306e79202018-03-28 13:17:44 +03001536
Ryan Everett45ac5262024-01-08 17:15:19 +00001537 LOCAL_OUTPUT_ALLOC(data_external, data_size, data);
1538
Gilles Peskine7a5d9202024-02-28 01:18:23 +01001539 status = psa_driver_wrapper_export_key(&slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01001540 slot->key.data, slot->key.bytes,
1541 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001542
David Horstmann4a48bec2024-03-13 15:42:31 +00001543#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Ryan Everett45ac5262024-01-08 17:15:19 +00001544exit:
Ryan Everett35f68532024-01-25 12:02:03 +00001545#endif
Ryan Everetta103ec92024-01-31 13:59:57 +00001546 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001547
Ryan Everett45ac5262024-01-08 17:15:19 +00001548 LOCAL_OUTPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01001549 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001550}
1551
Ronald Cron7285cda2020-11-26 14:46:37 +01001552psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001553 const psa_key_attributes_t *attributes,
1554 const uint8_t *key_buffer,
1555 size_t key_buffer_size,
1556 uint8_t *data,
1557 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001558 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001559{
Gilles Peskine2f107ae2024-02-28 01:26:46 +01001560 psa_key_type_t type = attributes->type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001561
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001562 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001563 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1564 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001565 /* Exporting public -> public */
1566 return psa_export_key_buffer_internal(
1567 key_buffer, key_buffer_size,
1568 data, data_size, data_length);
1569 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001570#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001571 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1572 return mbedtls_psa_rsa_export_public_key(attributes,
1573 key_buffer,
1574 key_buffer_size,
1575 data,
1576 data_size,
1577 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001578#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001579 /* We don't know how to convert a private RSA key to public. */
1580 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001581#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001582 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001583 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001584#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001585 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1586 return mbedtls_psa_ecp_export_public_key(attributes,
1587 key_buffer,
1588 key_buffer_size,
1589 data,
1590 data_size,
1591 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001592#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001593 /* We don't know how to convert a private ECC key to public */
1594 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001595#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001596 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001597 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001598#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001599 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001600 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001601 key_buffer,
1602 key_buffer_size,
1603 data, data_size,
1604 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001605#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001606 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001607#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001608 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001609 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001610 (void) key_buffer;
1611 (void) key_buffer_size;
1612 (void) data;
1613 (void) data_size;
1614 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001615 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001616 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001617}
Ronald Crond18b5f82020-11-25 16:46:05 +01001618
Gilles Peskine449bd832023-01-11 14:50:10 +01001619psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
Ryan Everettb1d2c672024-01-08 17:19:30 +00001620 uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01001621 size_t data_size,
1622 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001623{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001624 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001625 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001626 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001627
Ryan Everettb1d2c672024-01-08 17:19:30 +00001628 LOCAL_OUTPUT_DECLARE(data_external, data);
Darryl Greendd8fb772018-11-07 16:00:44 +00001629
Ronald Crone907e552021-01-18 13:22:38 +01001630 /* Reject a zero-length output buffer now, since this can never be a
1631 * valid key representation. This way we know that data must be a valid
1632 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001633 if (data_size == 0) {
1634 return PSA_ERROR_BUFFER_TOO_SMALL;
1635 }
Ronald Crone907e552021-01-18 13:22:38 +01001636
Darryl Greendd8fb772018-11-07 16:00:44 +00001637 /* Set the key to empty now, so that even when there are errors, we always
1638 * set data_length to a value between 0 and data_size. On error, setting
1639 * the key to empty is a good choice because an empty key representation is
1640 * unlikely to be accepted anywhere. */
1641 *data_length = 0;
1642
1643 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001644 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1645 if (status != PSA_SUCCESS) {
1646 return status;
1647 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001648
Ryan Everettb1d2c672024-01-08 17:19:30 +00001649 LOCAL_OUTPUT_ALLOC(data_external, data_size, data);
1650
Gilles Peskine449bd832023-01-11 14:50:10 +01001651 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1652 status = PSA_ERROR_INVALID_ARGUMENT;
1653 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001654 }
1655
Ronald Cron67227982020-11-26 15:16:05 +01001656 status = psa_driver_wrapper_export_public_key(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01001657 &slot->attr, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001658 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001659
1660exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00001661 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001662
Ryan Everettb1d2c672024-01-08 17:19:30 +00001663 LOCAL_OUTPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01001664 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001665}
1666
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001667/** Validate that a key policy is internally well-formed.
1668 *
1669 * This function only rejects invalid policies. It does not validate the
1670 * consistency of the policy with respect to other attributes of the key
1671 * such as the key type.
1672 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001673static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001674{
Gilles Peskine449bd832023-01-11 14:50:10 +01001675 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1676 PSA_KEY_USAGE_COPY |
1677 PSA_KEY_USAGE_ENCRYPT |
1678 PSA_KEY_USAGE_DECRYPT |
1679 PSA_KEY_USAGE_SIGN_MESSAGE |
1680 PSA_KEY_USAGE_VERIFY_MESSAGE |
1681 PSA_KEY_USAGE_SIGN_HASH |
1682 PSA_KEY_USAGE_VERIFY_HASH |
1683 PSA_KEY_USAGE_VERIFY_DERIVATION |
1684 PSA_KEY_USAGE_DERIVE)) != 0) {
1685 return PSA_ERROR_INVALID_ARGUMENT;
1686 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001687
Gilles Peskine449bd832023-01-11 14:50:10 +01001688 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001689}
1690
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001691/** Validate the internal consistency of key attributes.
1692 *
1693 * This function only rejects invalid attribute values. If does not
1694 * validate the consistency of the attributes with any key data that may
1695 * be involved in the creation of the key.
1696 *
1697 * Call this function early in the key creation process.
1698 *
1699 * \param[in] attributes Key attributes for the new key.
1700 * \param[out] p_drv On any return, the driver for the key, if any.
1701 * NULL for a transparent key.
1702 *
1703 */
1704static psa_status_t psa_validate_key_attributes(
1705 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001706 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001707{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001708 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001709 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1710 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001711
Gilles Peskine449bd832023-01-11 14:50:10 +01001712 status = psa_validate_key_location(lifetime, p_drv);
1713 if (status != PSA_SUCCESS) {
1714 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001715 }
1716
Gilles Peskine449bd832023-01-11 14:50:10 +01001717 status = psa_validate_key_persistence(lifetime);
1718 if (status != PSA_SUCCESS) {
1719 return status;
1720 }
1721
1722 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1723 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1724 return PSA_ERROR_INVALID_ARGUMENT;
1725 }
1726 } else {
1727 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1728 return PSA_ERROR_INVALID_ARGUMENT;
1729 }
1730 }
1731
Gilles Peskine2f107ae2024-02-28 01:26:46 +01001732 status = psa_validate_key_policy(&attributes->policy);
Gilles Peskine449bd832023-01-11 14:50:10 +01001733 if (status != PSA_SUCCESS) {
1734 return status;
1735 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001736
1737 /* Refuse to create overly large keys.
1738 * Note that this doesn't trigger on import if the attributes don't
1739 * explicitly specify a size (so psa_get_key_bits returns 0), so
1740 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1742 return PSA_ERROR_NOT_SUPPORTED;
1743 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001744
Gilles Peskine449bd832023-01-11 14:50:10 +01001745 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001746}
1747
Gilles Peskine4747d192019-04-17 15:05:45 +02001748/** Prepare a key slot to receive key material.
1749 *
1750 * This function allocates a key slot and sets its metadata.
1751 *
1752 * If this function fails, call psa_fail_key_creation().
1753 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001754 * This function is intended to be used as follows:
1755 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001756 * it with the specified attributes, and in case of a volatile key assign it
1757 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001758 * -# Populate the slot with the key material.
1759 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1760 * In case of failure at any step, stop the sequence and call
1761 * psa_fail_key_creation().
1762 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001763 * On success, the key slot's state is PSA_SLOT_FILLING.
1764 * It is the responsibility of the caller to change the slot's state to
1765 * PSA_SLOT_EMPTY/FULL once key creation has finished.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001766 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001767 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001768 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001769 * \param[out] p_slot On success, a pointer to the prepared slot.
1770 * \param[out] p_drv On any return, the driver for the key, if any.
1771 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001772 *
1773 * \retval #PSA_SUCCESS
1774 * The key slot is ready to receive key material.
1775 * \return If this function fails, the key slot is an invalid state.
1776 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001777 */
1778static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001779 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001780 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001781 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001782 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001783{
1784 psa_status_t status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001785
Gilles Peskinedf179142019-07-15 22:02:14 +02001786 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001787 *p_drv = NULL;
1788
Gilles Peskine449bd832023-01-11 14:50:10 +01001789 status = psa_validate_key_attributes(attributes, p_drv);
1790 if (status != PSA_SUCCESS) {
1791 return status;
1792 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001793
Gilles Peskinee8199f52024-06-10 11:53:33 +02001794 int key_is_volatile = PSA_KEY_LIFETIME_IS_VOLATILE(attributes->lifetime);
1795 psa_key_id_t volatile_key_id;
1796
Ryan Everett3d8118d2024-01-30 16:58:47 +00001797#if defined(MBEDTLS_THREADING_C)
1798 PSA_THREADING_CHK_RET(mbedtls_mutex_lock(
1799 &mbedtls_threading_key_slot_mutex));
1800#endif
Gilles Peskinee8199f52024-06-10 11:53:33 +02001801 status = psa_reserve_free_key_slot(
1802 key_is_volatile ? &volatile_key_id : NULL,
1803 p_slot);
Ryan Everett3d8118d2024-01-30 16:58:47 +00001804#if defined(MBEDTLS_THREADING_C)
1805 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1806 &mbedtls_threading_key_slot_mutex));
1807#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001808 if (status != PSA_SUCCESS) {
1809 return status;
1810 }
Gilles Peskinee8199f52024-06-10 11:53:33 +02001811 psa_key_slot_t *slot = *p_slot;
Gilles Peskine4747d192019-04-17 15:05:45 +02001812
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001813 /* We're storing the declared bit-size of the key. It's up to each
1814 * creation mechanism to verify that this information is correct.
1815 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001816 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001817 * is optional (import, copy). In case of a volatile key, assign it the
1818 * volatile key identifier associated to the slot returned to contain its
1819 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001820
Gilles Peskine7fad3ef2024-02-28 01:08:27 +01001821 slot->attr = *attributes;
Gilles Peskinee8199f52024-06-10 11:53:33 +02001822 if (key_is_volatile) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001823#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1824 slot->attr.id = volatile_key_id;
1825#else
1826 slot->attr.id.key_id = volatile_key_id;
1827#endif
1828 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001829
Gilles Peskinecbaff462019-07-12 23:46:04 +02001830#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001831 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001832 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001833 * create the key file in internal storage, create the
1834 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001835 * persistent data. This is done by starting a transaction that will
1836 * encompass these three actions.
1837 * For registering a volatile key, we just need to find an appropriate
1838 * slot number inside the SE. Since the key is designated volatile, creating
1839 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001840 /* The first thing to do is to find a slot number for the new key.
1841 * We save the slot number in persistent storage as part of the
1842 * transaction data. It will be needed to recover if the power
1843 * fails during the key creation process, to clean up on the secure
1844 * element side after restarting. Obtaining a slot number from the
1845 * secure element driver updates its persistent state, but we do not yet
1846 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001847 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001849 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001850 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1851 &slot_number);
1852 if (status != PSA_SUCCESS) {
1853 return status;
1854 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001855
Gilles Peskine2f107ae2024-02-28 01:26:46 +01001856 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->lifetime)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001858 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001859 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001860 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001861 status = psa_crypto_save_transaction();
1862 if (status != PSA_SUCCESS) {
1863 (void) psa_crypto_stop_transaction();
1864 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001865 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001866 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001867
1868 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001869 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Ryan Everettb5a20d32023-11-15 16:26:01 +00001870 if (status != PSA_SUCCESS) {
1871 return status;
1872 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001873 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001874
Gilles Peskine449bd832023-01-11 14:50:10 +01001875 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001876 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001877 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001878 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001879#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1880
Gilles Peskine449bd832023-01-11 14:50:10 +01001881 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001882}
Gilles Peskine4747d192019-04-17 15:05:45 +02001883
1884/** Finalize the creation of a key once its key material has been set.
1885 *
1886 * This entails writing the key to persistent storage.
1887 *
1888 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001889 * See the documentation of psa_start_key_creation() for the intended use
1890 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001891 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001892 * If the finalization succeeds, the function sets the key slot's state to
1893 * PSA_SLOT_FULL, and the key slot can no longer be accessed as part of the
1894 * key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001895 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001896 * \param[in,out] slot Pointer to the slot with key material.
1897 * \param[in] driver The secure element driver for the key,
1898 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001899 * \param[out] key On success, identifier of the key. Note that the
1900 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001901 *
1902 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001903 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001904 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1905 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1906 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1907 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1908 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1909 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001910 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001911 * \return If this function fails, the key slot is an invalid state.
1912 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001913 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001914static psa_status_t psa_finish_key_creation(
1915 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001916 psa_se_drv_table_entry_t *driver,
1917 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001918{
1919 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001920 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001921 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001922
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001923#if defined(MBEDTLS_THREADING_C)
1924 PSA_THREADING_CHK_RET(mbedtls_mutex_lock(
1925 &mbedtls_threading_key_slot_mutex));
1926#endif
1927
Gilles Peskine4747d192019-04-17 15:05:45 +02001928#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001929 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001930#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001931 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001932 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001933 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001934 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001935
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001936 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1937 sizeof(data.slot_number),
1938 "Slot number size does not match psa_se_key_data_storage_t");
1939
Gilles Peskine449bd832023-01-11 14:50:10 +01001940 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1941 status = psa_save_persistent_key(&slot->attr,
1942 (uint8_t *) &data,
1943 sizeof(data));
1944 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001945#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1946 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001947 /* Key material is saved in export representation in the slot, so
1948 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 status = psa_save_persistent_key(&slot->attr,
1950 slot->key.data,
1951 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001952 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001953 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001954#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1955
Gilles Peskinecbaff462019-07-12 23:46:04 +02001956#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001957 /* Finish the transaction for a key creation. This does not
1958 * happen when registering an existing key. Detect this case
1959 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001960 * creation of a persistent key in a secure element requires a transaction,
1961 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 if (driver != NULL &&
1963 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1964 status = psa_save_se_persistent_data(driver);
1965 if (status != PSA_SUCCESS) {
1966 psa_destroy_persistent_key(slot->attr.id);
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001967
1968#if defined(MBEDTLS_THREADING_C)
1969 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1970 &mbedtls_threading_key_slot_mutex));
1971#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001973 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001974 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001975 }
1976#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1977
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001979 *key = slot->attr.id;
Ryan Everettb69118e2024-01-02 15:54:32 +00001980 status = psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1981 PSA_SLOT_FULL);
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001983 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001985 }
Ronald Cron50972942020-11-14 11:28:25 +01001986
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001987#if defined(MBEDTLS_THREADING_C)
1988 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1989 &mbedtls_threading_key_slot_mutex));
1990#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001992}
1993
1994/** Abort the creation of a key.
1995 *
1996 * You may call this function after calling psa_start_key_creation(),
1997 * or after psa_finish_key_creation() fails. In other circumstances, this
1998 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001999 * See the documentation of psa_start_key_creation() for the intended use
Ryan Everettb69118e2024-01-02 15:54:32 +00002000 * of this function. Sets the slot's state to PSA_SLOT_EMPTY.
Gilles Peskine4747d192019-04-17 15:05:45 +02002001 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002002 * \param[in,out] slot Pointer to the slot with key material.
2003 * \param[in] driver The secure element driver for the key,
2004 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02002005 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002006static void psa_fail_key_creation(psa_key_slot_t *slot,
2007 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02002008{
Gilles Peskine011e4282019-06-26 18:34:38 +02002009 (void) driver;
2010
Gilles Peskine449bd832023-01-11 14:50:10 +01002011 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02002012 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 }
Gilles Peskine011e4282019-06-26 18:34:38 +02002014
Ryan Everettb7101442024-01-23 20:09:49 +00002015#if defined(MBEDTLS_THREADING_C)
Ryan Everett73feaf22024-02-14 11:36:41 +00002016 /* If the lock operation fails we still wipe the slot.
2017 * Operations will no longer work after a failed lock,
2018 * but we still need to wipe the slot of confidential data. */
Ryan Everettb7101442024-01-23 20:09:49 +00002019 mbedtls_mutex_lock(&mbedtls_threading_key_slot_mutex);
2020#endif
2021
Gilles Peskine011e4282019-06-26 18:34:38 +02002022#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01002023 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02002024 * element, and the failure happened later (when saving metadata
2025 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02002026 * element.
2027 * https://github.com/ARMmbed/mbed-crypto/issues/217
2028 */
Gilles Peskinefc762652019-07-22 19:30:34 +02002029
Gilles Peskined7729582019-08-05 15:55:54 +02002030 /* Abort the ongoing transaction if any (there may not be one if
2031 * the creation process failed before starting one, or if the
2032 * key creation is a registration of a key in a secure element).
2033 * Earlier functions must already have done what it takes to undo any
2034 * partial creation. All that's left is to update the transaction data
2035 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02002037#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2038
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 psa_wipe_key_slot(slot);
Ryan Everettb7101442024-01-23 20:09:49 +00002040
2041#if defined(MBEDTLS_THREADING_C)
2042 mbedtls_mutex_unlock(&mbedtls_threading_key_slot_mutex);
2043#endif
Gilles Peskine4747d192019-04-17 15:05:45 +02002044}
2045
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002046/** Validate optional attributes during key creation.
2047 *
2048 * Some key attributes are optional during key creation. If they are
2049 * specified in the attributes structure, check that they are consistent
2050 * with the data in the slot.
2051 *
2052 * This function should be called near the end of key creation, after
2053 * the slot in memory is fully populated but before saving persistent data.
2054 */
2055static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002056 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01002057 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002058{
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002059 if (attributes->type != 0) {
2060 if (attributes->type != slot->attr.type) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002061 return PSA_ERROR_INVALID_ARGUMENT;
2062 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002063 }
2064
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002065 if (attributes->bits != 0) {
2066 if (attributes->bits != slot->attr.bits) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002067 return PSA_ERROR_INVALID_ARGUMENT;
2068 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002069 }
2070
Gilles Peskine449bd832023-01-11 14:50:10 +01002071 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002072}
2073
Gilles Peskine449bd832023-01-11 14:50:10 +01002074psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
Ryan Everettf028fe12024-01-08 17:14:44 +00002075 const uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 size_t data_length,
2077 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002078{
2079 psa_status_t status;
Ryan Everettf028fe12024-01-08 17:14:44 +00002080 LOCAL_INPUT_DECLARE(data_external, data);
Gilles Peskine4747d192019-04-17 15:05:45 +02002081 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002082 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002083 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302084 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002085
Ronald Cron81709fc2020-11-14 12:10:32 +01002086 *key = MBEDTLS_SVC_KEY_ID_INIT;
2087
Gilles Peskine0f84d622019-09-12 19:03:13 +02002088 /* Reject zero-length symmetric keys (including raw data key objects).
2089 * This also rejects any key which might be encoded as an empty string,
2090 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002091 if (data_length == 0) {
2092 return PSA_ERROR_INVALID_ARGUMENT;
2093 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002094
Archana449608b2021-09-08 15:36:05 +05302095 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002096 if (data_length > SIZE_MAX / 8) {
2097 return PSA_ERROR_NOT_SUPPORTED;
2098 }
Archana6ed4bda2021-08-04 10:47:15 +05302099
Ryan Everettf028fe12024-01-08 17:14:44 +00002100 LOCAL_INPUT_ALLOC(data_external, data_length, data);
2101
Gilles Peskine449bd832023-01-11 14:50:10 +01002102 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2103 &slot, &driver);
2104 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002105 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002107
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002108 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302109 * storage ( thus not in the case of importing a key in a secure element
2110 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2111 * buffer to hold the imported key material. */
Valerio Setti70fa89c2024-08-14 05:12:45 +02002112 if (slot->key.bytes == 0) {
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002113 if (psa_key_lifetime_is_external(attributes->lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302114 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002115 attributes, data, data_length, &storage_size);
2116 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302117 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 }
Archanad8a83dc2021-06-14 10:04:16 +05302119 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 status = psa_allocate_buffer_to_slot(slot, storage_size);
2121 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002122 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002124 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002125
2126 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 status = psa_driver_wrapper_import_key(attributes,
2128 data, data_length,
2129 slot->key.data,
2130 slot->key.bytes,
2131 &slot->key.bytes, &bits);
2132 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002133 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002135
Gilles Peskine449bd832023-01-11 14:50:10 +01002136 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002137 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002138 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002139 status = PSA_ERROR_INVALID_ARGUMENT;
2140 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002141 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002142
Archana6ed4bda2021-08-04 10:47:15 +05302143 /* Enforce a size limit, and in particular ensure that the bit
2144 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002145 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302146 status = PSA_ERROR_NOT_SUPPORTED;
2147 goto exit;
2148 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 status = psa_validate_optional_attributes(slot, attributes);
2150 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002151 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002153
Gilles Peskine449bd832023-01-11 14:50:10 +01002154 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002155exit:
Ryan Everettf028fe12024-01-08 17:14:44 +00002156 LOCAL_INPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 if (status != PSA_SUCCESS) {
2158 psa_fail_key_creation(slot, driver);
2159 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002160
Gilles Peskine449bd832023-01-11 14:50:10 +01002161 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002162}
2163
Gilles Peskined7729582019-08-05 15:55:54 +02002164#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2165psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002167{
2168 psa_status_t status;
2169 psa_key_slot_t *slot = NULL;
2170 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002171 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002172
2173 /* Leaving attributes unspecified is not currently supported.
2174 * It could make sense to query the key type and size from the
2175 * secure element, but not all secure elements support this
2176 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2178 return PSA_ERROR_NOT_SUPPORTED;
2179 }
2180 if (psa_get_key_bits(attributes) == 0) {
2181 return PSA_ERROR_NOT_SUPPORTED;
2182 }
Gilles Peskined7729582019-08-05 15:55:54 +02002183
Gilles Peskined72ad732024-06-13 16:06:45 +02002184 /* Not usable with volatile keys, even with an appropriate location,
2185 * due to the API design.
2186 * https://github.com/Mbed-TLS/mbedtls/issues/9253
2187 */
2188 if (PSA_KEY_LIFETIME_IS_VOLATILE(psa_get_key_lifetime(attributes))) {
2189 return PSA_ERROR_INVALID_ARGUMENT;
2190 }
2191
Gilles Peskine449bd832023-01-11 14:50:10 +01002192 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2193 &slot, &driver);
2194 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002195 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 }
Gilles Peskined7729582019-08-05 15:55:54 +02002197
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002199
2200exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 if (status != PSA_SUCCESS) {
2202 psa_fail_key_creation(slot, driver);
2203 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002204
Gilles Peskined7729582019-08-05 15:55:54 +02002205 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 psa_close_key(key);
2207 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002208}
2209#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2210
Gilles Peskine449bd832023-01-11 14:50:10 +01002211psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2212 const psa_key_attributes_t *specified_attributes,
2213 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002214{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002215 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002216 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002217 psa_key_slot_t *source_slot = NULL;
2218 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002219 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002220 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302221 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002222
Ronald Cron81709fc2020-11-14 12:10:32 +01002223 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2224
Archana8a180362021-07-05 02:18:48 +05302225 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002226 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2227 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002228 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002229 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002230
Gilles Peskine449bd832023-01-11 14:50:10 +01002231 status = psa_validate_optional_attributes(source_slot,
2232 specified_attributes);
2233 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002234 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002236
Archana9d17bf42021-09-10 06:22:44 +05302237 /* The target key type and number of bits have been validated by
2238 * psa_validate_optional_attributes() to be either equal to zero or
2239 * equal to the ones of the source key. So it is safe to inherit
2240 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302241 * */
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002242 actual_attributes.bits = source_slot->attr.bits;
2243 actual_attributes.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302244
2245
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 status = psa_restrict_key_policy(source_slot->attr.type,
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002247 &actual_attributes.policy,
Gilles Peskine449bd832023-01-11 14:50:10 +01002248 &source_slot->attr.policy);
2249 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002250 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002251 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002252
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2254 &target_slot, &driver);
2255 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002256 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002257 }
2258 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2259 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302260 /*
Archana9d17bf42021-09-10 06:22:44 +05302261 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302262 * the source key would need to be exported as plaintext and re-imported
2263 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302264 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302265 * appropriate API invocations from the application, if needed.
2266 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002267 status = PSA_ERROR_NOT_SUPPORTED;
2268 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002269 }
Archana8a180362021-07-05 02:18:48 +05302270 /*
2271 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302272 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302273 * - For opaque keys this translates to an invocation of the drivers'
2274 * copy_key entry point through the dispatch layer.
2275 * */
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002276 if (psa_key_lifetime_is_external(actual_attributes.lifetime)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002277 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2278 &storage_size);
2279 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302280 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002281 }
Archana374fe5b2021-09-08 15:50:28 +05302282
Gilles Peskine449bd832023-01-11 14:50:10 +01002283 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2284 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302285 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 }
Archana374fe5b2021-09-08 15:50:28 +05302287
Gilles Peskine449bd832023-01-11 14:50:10 +01002288 status = psa_driver_wrapper_copy_key(&actual_attributes,
2289 source_slot->key.data,
2290 source_slot->key.bytes,
2291 target_slot->key.data,
2292 target_slot->key.bytes,
2293 &target_slot->key.bytes);
2294 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302295 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 }
2297 } else {
2298 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302299 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 source_slot->key.bytes);
2301 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302302 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 }
Archana8a180362021-07-05 02:18:48 +05302304 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002306exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002307 if (status != PSA_SUCCESS) {
2308 psa_fail_key_creation(target_slot, driver);
2309 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002310
Ryan Everetta103ec92024-01-31 13:59:57 +00002311 unlock_status = psa_unregister_read_under_mutex(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002312
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002314}
2315
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002316
2317
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002318/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002319/* Message digests */
2320/****************************************************************/
2321
Gilles Peskine449bd832023-01-11 14:50:10 +01002322psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002323{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002324 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002325 if (operation->id == 0) {
2326 return PSA_SUCCESS;
2327 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002328
Gilles Peskine449bd832023-01-11 14:50:10 +01002329 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002330 operation->id = 0;
2331
Gilles Peskine449bd832023-01-11 14:50:10 +01002332 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002333}
2334
Gilles Peskine449bd832023-01-11 14:50:10 +01002335psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2336 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002337{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002338 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002339
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002340 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002341 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002342 status = PSA_ERROR_BAD_STATE;
2343 goto exit;
2344 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002345
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002347 status = PSA_ERROR_INVALID_ARGUMENT;
2348 goto exit;
2349 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002350
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002351 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2352 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002354
Gilles Peskine449bd832023-01-11 14:50:10 +01002355 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002356
2357exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 if (status != PSA_SUCCESS) {
2359 psa_hash_abort(operation);
2360 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002361
2362 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002363}
2364
Gilles Peskine449bd832023-01-11 14:50:10 +01002365psa_status_t psa_hash_update(psa_hash_operation_t *operation,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002366 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002367 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002368{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002369 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002370 LOCAL_INPUT_DECLARE(input_external, input);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002371
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002373 status = PSA_ERROR_BAD_STATE;
2374 goto exit;
2375 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002376
Steven Cooremanc8288352021-03-04 14:02:19 +01002377 /* Don't require hash implementations to behave correctly on a
2378 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 if (input_length == 0) {
2380 return PSA_SUCCESS;
2381 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002382
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002383 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002384 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002385
2386exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 if (status != PSA_SUCCESS) {
2388 psa_hash_abort(operation);
2389 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002390
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002391 LOCAL_INPUT_FREE(input_external, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002393}
2394
Thomas Daubney31d8c0b2024-01-18 15:26:59 +00002395static psa_status_t psa_hash_finish_internal(psa_hash_operation_t *operation,
Thomas Daubneyd2411562024-01-25 17:25:07 +00002396 uint8_t *hash,
2397 size_t hash_size,
2398 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002399{
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002400 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2401
Steven Cooremanfbe09282021-03-08 18:41:12 +01002402 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 if (operation->id == 0) {
2404 return PSA_ERROR_BAD_STATE;
2405 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002406
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002407 status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 operation, hash, hash_size, hash_length);
2409 psa_hash_abort(operation);
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002410
2411 return status;
2412}
2413
2414psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2415 uint8_t *hash_external,
2416 size_t hash_size,
2417 size_t *hash_length)
2418{
2419 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2420 LOCAL_OUTPUT_DECLARE(hash_external, hash);
2421
2422 LOCAL_OUTPUT_ALLOC(hash_external, hash_size, hash);
2423 status = psa_hash_finish_internal(operation, hash, hash_size, hash_length);
2424
David Horstmann4a48bec2024-03-13 15:42:31 +00002425#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002426exit:
Thomas Daubneydedd1002024-01-25 16:52:50 +00002427#endif
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002428 LOCAL_OUTPUT_FREE(hash_external, hash);
Gilles Peskine449bd832023-01-11 14:50:10 +01002429 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002430}
2431
Gilles Peskine449bd832023-01-11 14:50:10 +01002432psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002433 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002435{
Ronald Cron69a63422021-10-18 09:47:58 +02002436 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002437 size_t actual_hash_length;
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002438 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2439 LOCAL_INPUT_DECLARE(hash_external, hash);
2440
2441 status = psa_hash_finish_internal(
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 operation,
2443 actual_hash, sizeof(actual_hash),
2444 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002445
Gilles Peskine449bd832023-01-11 14:50:10 +01002446 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002447 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002448 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002449
Gilles Peskine449bd832023-01-11 14:50:10 +01002450 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002451 status = PSA_ERROR_INVALID_SIGNATURE;
2452 goto exit;
2453 }
2454
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002455 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
Dave Rodgman78701152023-08-29 14:20:18 +01002456 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002457 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002459
2460exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002461 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2462 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002463 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 }
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002465 LOCAL_INPUT_FREE(hash_external, hash);
Gilles Peskine449bd832023-01-11 14:50:10 +01002466 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002467}
2468
Gilles Peskine449bd832023-01-11 14:50:10 +01002469psa_status_t psa_hash_compute(psa_algorithm_t alg,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002470 const uint8_t *input_external, size_t input_length,
2471 uint8_t *hash_external, size_t hash_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002472 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002473{
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002474 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2475 LOCAL_INPUT_DECLARE(input_external, input);
2476 LOCAL_OUTPUT_DECLARE(hash_external, hash);
2477
Steven Cooremanfbe09282021-03-08 18:41:12 +01002478 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002479 if (!PSA_ALG_IS_HASH(alg)) {
2480 return PSA_ERROR_INVALID_ARGUMENT;
2481 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002482
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002483 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2484 LOCAL_OUTPUT_ALLOC(hash_external, hash_size, hash);
2485 status = psa_driver_wrapper_hash_compute(alg, input, input_length,
Thomas Daubneyd2411562024-01-25 17:25:07 +00002486 hash, hash_size, hash_length);
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002487
David Horstmann4a48bec2024-03-13 15:42:31 +00002488#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002489exit:
Thomas Daubneydedd1002024-01-25 16:52:50 +00002490#endif
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002491 LOCAL_INPUT_FREE(input_external, input);
2492 LOCAL_OUTPUT_FREE(hash_external, hash);
2493 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002494}
2495
Gilles Peskine449bd832023-01-11 14:50:10 +01002496psa_status_t psa_hash_compare(psa_algorithm_t alg,
Thomas Daubney51ffac92024-01-18 15:46:26 +00002497 const uint8_t *input_external, size_t input_length,
2498 const uint8_t *hash_external, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002499{
Ronald Cron69a63422021-10-18 09:47:58 +02002500 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002501 size_t actual_hash_length;
Thomas Daubney51ffac92024-01-18 15:46:26 +00002502 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2503
2504 LOCAL_INPUT_DECLARE(input_external, input);
2505 LOCAL_INPUT_DECLARE(hash_external, hash);
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002506
Gilles Peskine449bd832023-01-11 14:50:10 +01002507 if (!PSA_ALG_IS_HASH(alg)) {
Thomas Daubney51ffac92024-01-18 15:46:26 +00002508 status = PSA_ERROR_INVALID_ARGUMENT;
2509 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002510 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002511
Thomas Daubney51ffac92024-01-18 15:46:26 +00002512 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2513 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 alg, input, input_length,
2515 actual_hash, sizeof(actual_hash),
2516 &actual_hash_length);
2517 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002518 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002519 }
2520 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002521 status = PSA_ERROR_INVALID_SIGNATURE;
2522 goto exit;
2523 }
Thomas Daubney51ffac92024-01-18 15:46:26 +00002524
2525 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
Dave Rodgman78701152023-08-29 14:20:18 +01002526 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002527 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002529
2530exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002531 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
Thomas Daubney51ffac92024-01-18 15:46:26 +00002532
2533 LOCAL_INPUT_FREE(input_external, input);
2534 LOCAL_INPUT_FREE(hash_external, hash);
2535
Gilles Peskine449bd832023-01-11 14:50:10 +01002536 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002537}
2538
Gilles Peskine449bd832023-01-11 14:50:10 +01002539psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2540 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002541{
Gilles Peskine449bd832023-01-11 14:50:10 +01002542 if (source_operation->id == 0 ||
2543 target_operation->id != 0) {
2544 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002545 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002546
Gilles Peskine449bd832023-01-11 14:50:10 +01002547 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2548 target_operation);
2549 if (status != PSA_SUCCESS) {
2550 psa_hash_abort(target_operation);
2551 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002552
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002554}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002555
2556
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002557/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002558/* MAC */
2559/****************************************************************/
2560
Gilles Peskine449bd832023-01-11 14:50:10 +01002561psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002562{
Steven Cooremane6804192021-03-19 18:28:56 +01002563 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002564 if (operation->id == 0) {
2565 return PSA_SUCCESS;
2566 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002567
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002569 operation->mac_size = 0;
2570 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002571 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002572
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002574}
2575
Ronald Cron2dff3b22021-06-17 16:33:22 +02002576static psa_status_t psa_mac_finalize_alg_and_key_validation(
2577 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002578 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002579 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002580{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002581 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002582 psa_key_type_t key_type = psa_get_key_type(attributes);
2583 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002584
Gilles Peskine449bd832023-01-11 14:50:10 +01002585 if (!PSA_ALG_IS_MAC(alg)) {
2586 return PSA_ERROR_INVALID_ARGUMENT;
2587 }
Steven Cooremane6804192021-03-19 18:28:56 +01002588
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002589 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002590 status = psa_mac_key_can_do(alg, key_type);
2591 if (status != PSA_SUCCESS) {
2592 return status;
2593 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002594
Steven Cooremand1a68f12021-05-10 11:13:41 +02002595 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002596 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002597
Gilles Peskine449bd832023-01-11 14:50:10 +01002598 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002599 /* A very short MAC is too short for security since it can be
2600 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2601 * so we make this our minimum, even though 32 bits is still
2602 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002603 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002604 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002605
Gilles Peskine449bd832023-01-11 14:50:10 +01002606 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2607 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002608 /* It's impossible to "truncate" to a larger length than the full length
2609 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002611 }
2612
Gilles Peskine449bd832023-01-11 14:50:10 +01002613 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002614 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2615 * that is disabled in the compile-time configuration. The result can
2616 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2617 * configuration into account. In this case, force a return of
2618 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2619 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2620 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2621 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2622 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002623 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002624 }
2625
Gilles Peskine449bd832023-01-11 14:50:10 +01002626 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002627}
2628
Gilles Peskine449bd832023-01-11 14:50:10 +01002629static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2630 mbedtls_svc_key_id_t key,
2631 psa_algorithm_t alg,
2632 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002633{
2634 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2635 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002636 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002637
2638 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002639 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002640 status = PSA_ERROR_BAD_STATE;
2641 goto exit;
2642 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002643
2644 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002645 key,
2646 &slot,
2647 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2648 alg);
2649 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002650 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002652
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002653 status = psa_mac_finalize_alg_and_key_validation(alg, &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002654 &operation->mac_size);
2655 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002656 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002657 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002658
2659 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002660 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 if (is_sign) {
2662 status = psa_driver_wrapper_mac_sign_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002663 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 slot->key.data,
2665 slot->key.bytes,
2666 alg);
2667 } else {
2668 status = psa_driver_wrapper_mac_verify_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002669 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 slot->key.data,
2671 slot->key.bytes,
2672 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002673 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002674
Gilles Peskinefbfac682018-07-08 20:51:54 +02002675exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002676 if (status != PSA_SUCCESS) {
2677 psa_mac_abort(operation);
2678 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002679
Ryan Everettfb9857f2024-02-14 12:16:41 +00002680 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002681
Gilles Peskine449bd832023-01-11 14:50:10 +01002682 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002683}
2684
Gilles Peskine449bd832023-01-11 14:50:10 +01002685psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2686 mbedtls_svc_key_id_t key,
2687 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002688{
Gilles Peskine449bd832023-01-11 14:50:10 +01002689 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002690}
2691
Gilles Peskine449bd832023-01-11 14:50:10 +01002692psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2693 mbedtls_svc_key_id_t key,
2694 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002695{
Gilles Peskine449bd832023-01-11 14:50:10 +01002696 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002697}
2698
Gilles Peskine449bd832023-01-11 14:50:10 +01002699psa_status_t psa_mac_update(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002700 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002702{
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002703 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2704 LOCAL_INPUT_DECLARE(input_external, input);
2705
Gilles Peskine449bd832023-01-11 14:50:10 +01002706 if (operation->id == 0) {
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002707 status = PSA_ERROR_BAD_STATE;
2708 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002709 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002710
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002711 /* Don't require hash implementations to behave correctly on a
2712 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002713 if (input_length == 0) {
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002714 status = PSA_SUCCESS;
2715 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002716 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002717
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002718 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2719 status = psa_driver_wrapper_mac_update(operation, input, input_length);
2720
Gilles Peskine449bd832023-01-11 14:50:10 +01002721 if (status != PSA_SUCCESS) {
2722 psa_mac_abort(operation);
2723 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002724
David Horstmann4a48bec2024-03-13 15:42:31 +00002725#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002726exit:
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002727#endif
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002728 LOCAL_INPUT_FREE(input_external, input);
2729
Gilles Peskine449bd832023-01-11 14:50:10 +01002730 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002731}
2732
Gilles Peskine449bd832023-01-11 14:50:10 +01002733psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002734 uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002735 size_t mac_size,
2736 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002737{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002738 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2739 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002740 LOCAL_OUTPUT_DECLARE(mac_external, mac);
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002741 LOCAL_OUTPUT_ALLOC(mac_external, mac_size, mac);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002742
Gilles Peskine449bd832023-01-11 14:50:10 +01002743 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002744 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002745 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002746 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002747
Gilles Peskine449bd832023-01-11 14:50:10 +01002748 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002749 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002750 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002751 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002752
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002753 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2754 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002755 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002756 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002757 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002758 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002759
Gilles Peskine449bd832023-01-11 14:50:10 +01002760 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002761 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002762 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002763 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002764
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002765
Gilles Peskine449bd832023-01-11 14:50:10 +01002766 status = psa_driver_wrapper_mac_sign_finish(operation,
2767 mac, operation->mac_size,
2768 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002769
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002770exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002771 /* In case of success, set the potential excess room in the output buffer
2772 * to an invalid value, to avoid potentially leaking a longer MAC.
2773 * In case of error, set the output length and content to a safe default,
2774 * such that in case the caller misses an error check, the output would be
2775 * an unachievable MAC.
2776 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002777 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002778 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002779 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002780 }
mohammad16036df908f2018-04-02 08:34:15 -07002781
Thomas Daubney03f1ea32024-02-01 16:16:27 +00002782 if (mac != NULL) {
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002783 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
2784 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002785
Gilles Peskine449bd832023-01-11 14:50:10 +01002786 abort_status = psa_mac_abort(operation);
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002787 LOCAL_OUTPUT_FREE(mac_external, mac);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002788
Gilles Peskine449bd832023-01-11 14:50:10 +01002789 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002790}
2791
Gilles Peskine449bd832023-01-11 14:50:10 +01002792psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002793 const uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002794 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002795{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002796 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2797 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002798 LOCAL_INPUT_DECLARE(mac_external, mac);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002799
Gilles Peskine449bd832023-01-11 14:50:10 +01002800 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002801 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002802 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002803 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002804
Gilles Peskine449bd832023-01-11 14:50:10 +01002805 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002806 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002807 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002808 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002809
Gilles Peskine449bd832023-01-11 14:50:10 +01002810 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002811 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002812 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002813 }
2814
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002815 LOCAL_INPUT_ALLOC(mac_external, mac_length, mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01002816 status = psa_driver_wrapper_mac_verify_finish(operation,
2817 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002818
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002819exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002820 abort_status = psa_mac_abort(operation);
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002821 LOCAL_INPUT_FREE(mac_external, mac);
mohammad16036df908f2018-04-02 08:34:15 -07002822
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002824}
2825
Gilles Peskine449bd832023-01-11 14:50:10 +01002826static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2827 psa_algorithm_t alg,
2828 const uint8_t *input,
2829 size_t input_length,
2830 uint8_t *mac,
2831 size_t mac_size,
2832 size_t *mac_length,
2833 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002834{
2835 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002836 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2837 psa_key_slot_t *slot;
2838 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002839
Ronald Cron51131b52021-06-17 17:17:20 +02002840 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002841 key,
2842 &slot,
2843 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2844 alg);
2845 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002846 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002848
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002849 status = psa_mac_finalize_alg_and_key_validation(alg, &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002850 &operation_mac_size);
2851 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002852 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002853 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002854
Gilles Peskine449bd832023-01-11 14:50:10 +01002855 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002856 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002857 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002858 }
2859
2860 status = psa_driver_wrapper_mac_compute(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002861 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002862 slot->key.data, slot->key.bytes,
2863 alg,
2864 input, input_length,
2865 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002866
2867exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002868 /* In case of success, set the potential excess room in the output buffer
2869 * to an invalid value, to avoid potentially leaking a longer MAC.
2870 * In case of error, set the output length and content to a safe default,
2871 * such that in case the caller misses an error check, the output would be
2872 * an unachievable MAC.
2873 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002874 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002875 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002876 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002877 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002878
2879 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002880
Ryan Everetta103ec92024-01-31 13:59:57 +00002881 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002882
Gilles Peskine449bd832023-01-11 14:50:10 +01002883 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002884}
2885
Gilles Peskine449bd832023-01-11 14:50:10 +01002886psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002887 psa_algorithm_t alg,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002888 const uint8_t *input_external,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002889 size_t input_length,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002890 uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002891 size_t mac_size,
2892 size_t *mac_length)
2893{
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002894 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2895 LOCAL_INPUT_DECLARE(input_external, input);
2896 LOCAL_OUTPUT_DECLARE(mac_external, mac);
2897
2898 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2899 LOCAL_OUTPUT_ALLOC(mac_external, mac_size, mac);
2900 status = psa_mac_compute_internal(key, alg,
Thomas Daubney7480a742024-01-30 11:29:47 +00002901 input, input_length,
2902 mac, mac_size, mac_length, 1);
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002903
David Horstmann4a48bec2024-03-13 15:42:31 +00002904#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002905exit:
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002906#endif
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002907 LOCAL_INPUT_FREE(input_external, input);
2908 LOCAL_OUTPUT_FREE(mac_external, mac);
2909
2910 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002911}
2912
2913psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2914 psa_algorithm_t alg,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002915 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002916 size_t input_length,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002917 const uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002919{
2920 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002921 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2922 size_t actual_mac_length;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002923 LOCAL_INPUT_DECLARE(input_external, input);
2924 LOCAL_INPUT_DECLARE(mac_external, mac);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002925
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002926 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002927 status = psa_mac_compute_internal(key, alg,
2928 input, input_length,
2929 actual_mac, sizeof(actual_mac),
2930 &actual_mac_length, 0);
2931 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002932 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002934
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002936 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002937 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002938 }
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002939
2940 LOCAL_INPUT_ALLOC(mac_external, mac_length, mac);
Dave Rodgman78701152023-08-29 14:20:18 +01002941 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002942 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002943 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002944 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002945
2946exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002947 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002948 LOCAL_INPUT_FREE(input_external, input);
2949 LOCAL_INPUT_FREE(mac_external, mac);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002950
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002952}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002953
Gilles Peskinee59236f2018-01-27 23:32:46 +01002954/****************************************************************/
2955/* Asymmetric cryptography */
2956/****************************************************************/
2957
Gilles Peskine449bd832023-01-11 14:50:10 +01002958static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2959 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002960{
Gilles Peskine449bd832023-01-11 14:50:10 +01002961 if (input_is_message) {
2962 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2963 return PSA_ERROR_INVALID_ARGUMENT;
2964 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002965
Gilles Peskine449bd832023-01-11 14:50:10 +01002966 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2967 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2968 return PSA_ERROR_INVALID_ARGUMENT;
2969 }
2970 }
2971 } else {
2972 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2973 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002974 }
2975 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002976
Gilles Peskine449bd832023-01-11 14:50:10 +01002977 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002978}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002979
Gilles Peskine449bd832023-01-11 14:50:10 +01002980static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2981 int input_is_message,
2982 psa_algorithm_t alg,
2983 const uint8_t *input,
2984 size_t input_length,
2985 uint8_t *signature,
2986 size_t signature_size,
2987 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002988{
2989 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2990 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2991 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002992
2993 *signature_length = 0;
2994
Gilles Peskine449bd832023-01-11 14:50:10 +01002995 status = psa_sign_verify_check_alg(input_is_message, alg);
2996 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002997 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002998 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002999
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003000 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02003001 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003002 * buffer can in principle be empty since it doesn't actually have
3003 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003004 if (signature_size == 0) {
3005 return PSA_ERROR_BUFFER_TOO_SMALL;
3006 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003007
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003008 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003009 key, &slot,
3010 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
3011 PSA_KEY_USAGE_SIGN_HASH,
3012 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003013
Gilles Peskine449bd832023-01-11 14:50:10 +01003014 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003015 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003016 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003017
Gilles Peskine449bd832023-01-11 14:50:10 +01003018 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003019 status = PSA_ERROR_INVALID_ARGUMENT;
3020 goto exit;
3021 }
3022
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003024 status = psa_driver_wrapper_sign_message(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003025 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003026 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003027 signature, signature_size, signature_length);
3028 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003029
3030 status = psa_driver_wrapper_sign_hash(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003031 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003032 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003033 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003034 }
3035
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003036
3037exit:
Paul Elliott59200a22023-02-21 15:07:40 +00003038 psa_wipe_tag_output_buffer(signature, status, signature_size,
3039 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003040
Ryan Everetta103ec92024-01-31 13:59:57 +00003041 unlock_status = psa_unregister_read_under_mutex(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003042
Gilles Peskine449bd832023-01-11 14:50:10 +01003043 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003044}
3045
Gilles Peskine449bd832023-01-11 14:50:10 +01003046static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
3047 int input_is_message,
3048 psa_algorithm_t alg,
3049 const uint8_t *input,
3050 size_t input_length,
3051 const uint8_t *signature,
3052 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003053{
3054 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3055 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3056 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003057
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 status = psa_sign_verify_check_alg(input_is_message, alg);
3059 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003060 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003061 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003062
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003063 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 key, &slot,
3065 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
3066 PSA_KEY_USAGE_VERIFY_HASH,
3067 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003068
Gilles Peskine449bd832023-01-11 14:50:10 +01003069 if (status != PSA_SUCCESS) {
3070 return status;
3071 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003072
Gilles Peskine449bd832023-01-11 14:50:10 +01003073 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003074 status = psa_driver_wrapper_verify_message(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003075 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003076 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003077 signature, signature_length);
3078 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003079 status = psa_driver_wrapper_verify_hash(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003080 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003081 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003083 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003084
Ryan Everetta103ec92024-01-31 13:59:57 +00003085 unlock_status = psa_unregister_read_under_mutex(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003086
Gilles Peskine449bd832023-01-11 14:50:10 +01003087 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003088
3089}
3090
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003091psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003092 const psa_key_attributes_t *attributes,
3093 const uint8_t *key_buffer,
3094 size_t key_buffer_size,
3095 psa_algorithm_t alg,
3096 const uint8_t *input,
3097 size_t input_length,
3098 uint8_t *signature,
3099 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01003100 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003101{
3102 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003103
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003105 size_t hash_length;
3106 uint8_t hash[PSA_HASH_MAX_SIZE];
3107
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003108 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003109 PSA_ALG_SIGN_GET_HASH(alg),
3110 input, input_length,
3111 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003112
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003114 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003115 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003116
3117 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003118 attributes, key_buffer, key_buffer_size,
3119 alg, hash, hash_length,
3120 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003121 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003122
Gilles Peskine449bd832023-01-11 14:50:10 +01003123 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003124}
3125
Gilles Peskine449bd832023-01-11 14:50:10 +01003126psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3127 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003128 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003129 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003130 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003131 size_t signature_size,
3132 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003133{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003134 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3135 LOCAL_INPUT_DECLARE(input_external, input);
3136 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3137
3138 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3139 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3140 status = psa_sign_internal(key, 1, alg, input, input_length, signature,
3141 signature_size, signature_length);
3142
David Horstmann4a48bec2024-03-13 15:42:31 +00003143#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003144exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003145#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003146 LOCAL_INPUT_FREE(input_external, input);
3147 LOCAL_OUTPUT_FREE(signature_external, signature);
3148 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003149}
3150
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003151psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003152 const psa_key_attributes_t *attributes,
3153 const uint8_t *key_buffer,
3154 size_t key_buffer_size,
3155 psa_algorithm_t alg,
3156 const uint8_t *input,
3157 size_t input_length,
3158 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003159 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003160{
3161 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003162
Gilles Peskine449bd832023-01-11 14:50:10 +01003163 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003164 size_t hash_length;
3165 uint8_t hash[PSA_HASH_MAX_SIZE];
3166
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003167 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003168 PSA_ALG_SIGN_GET_HASH(alg),
3169 input, input_length,
3170 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003171
Gilles Peskine449bd832023-01-11 14:50:10 +01003172 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003173 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003174 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003175
3176 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003177 attributes, key_buffer, key_buffer_size,
3178 alg, hash, hash_length,
3179 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003180 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003181
Gilles Peskine449bd832023-01-11 14:50:10 +01003182 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003183}
3184
Gilles Peskine449bd832023-01-11 14:50:10 +01003185psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3186 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003187 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003188 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003189 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003190 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003191{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003192 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3193 LOCAL_INPUT_DECLARE(input_external, input);
3194 LOCAL_INPUT_DECLARE(signature_external, signature);
3195
3196 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3197 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3198 status = psa_verify_internal(key, 1, alg, input, input_length, signature,
3199 signature_length);
3200
David Horstmann4a48bec2024-03-13 15:42:31 +00003201#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003202exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003203#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003204 LOCAL_INPUT_FREE(input_external, input);
3205 LOCAL_INPUT_FREE(signature_external, signature);
3206
3207 return status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003208}
3209
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003210psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003211 const psa_key_attributes_t *attributes,
3212 const uint8_t *key_buffer, size_t key_buffer_size,
3213 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003214 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003215{
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003216 if (attributes->type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003217 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3218 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003219#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003220 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3221 return mbedtls_psa_rsa_sign_hash(
3222 attributes,
3223 key_buffer, key_buffer_size,
3224 alg, hash, hash_length,
3225 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003226#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3227 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003228 } else {
3229 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003230 }
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003231 } else if (PSA_KEY_TYPE_IS_ECC(attributes->type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003232 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003233#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003234 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3235 return mbedtls_psa_ecdsa_sign_hash(
3236 attributes,
3237 key_buffer, key_buffer_size,
3238 alg, hash, hash_length,
3239 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003240#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3241 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003242 } else {
3243 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003244 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003245 }
Ronald Cron4501c982021-03-19 20:09:32 +01003246
Gilles Peskine449bd832023-01-11 14:50:10 +01003247 (void) key_buffer;
3248 (void) key_buffer_size;
3249 (void) hash;
3250 (void) hash_length;
3251 (void) signature;
3252 (void) signature_size;
3253 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003254
Gilles Peskine449bd832023-01-11 14:50:10 +01003255 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003256}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003257
Gilles Peskine449bd832023-01-11 14:50:10 +01003258psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3259 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003260 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003261 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003262 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003263 size_t signature_size,
3264 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003265{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003266 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3267 LOCAL_INPUT_DECLARE(hash_external, hash);
3268 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3269
3270 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3271 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3272 status = psa_sign_internal(key, 0, alg, hash, hash_length, signature,
3273 signature_size, signature_length);
3274
David Horstmann4a48bec2024-03-13 15:42:31 +00003275#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003276exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003277#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003278 LOCAL_INPUT_FREE(hash_external, hash);
3279 LOCAL_OUTPUT_FREE(signature_external, signature);
3280
3281 return status;
itayzafrir5c753392018-05-08 11:18:38 +03003282}
3283
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003284psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003285 const psa_key_attributes_t *attributes,
3286 const uint8_t *key_buffer, size_t key_buffer_size,
3287 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003288 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003289{
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003290 if (PSA_KEY_TYPE_IS_RSA(attributes->type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003291 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3292 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003293#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003294 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3295 return mbedtls_psa_rsa_verify_hash(
3296 attributes,
3297 key_buffer, key_buffer_size,
3298 alg, hash, hash_length,
3299 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003300#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3301 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003302 } else {
3303 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003304 }
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003305 } else if (PSA_KEY_TYPE_IS_ECC(attributes->type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003306 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003307#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003308 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3309 return mbedtls_psa_ecdsa_verify_hash(
3310 attributes,
3311 key_buffer, key_buffer_size,
3312 alg, hash, hash_length,
3313 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003314#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3315 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003316 } else {
3317 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003318 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003319 }
Ronald Cron4501c982021-03-19 20:09:32 +01003320
Gilles Peskine449bd832023-01-11 14:50:10 +01003321 (void) key_buffer;
3322 (void) key_buffer_size;
3323 (void) hash;
3324 (void) hash_length;
3325 (void) signature;
3326 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003327
Gilles Peskine449bd832023-01-11 14:50:10 +01003328 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003329}
3330
Gilles Peskine449bd832023-01-11 14:50:10 +01003331psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3332 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003333 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003334 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003335 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003336 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003337{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003338 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3339 LOCAL_INPUT_DECLARE(hash_external, hash);
3340 LOCAL_INPUT_DECLARE(signature_external, signature);
3341
3342 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3343 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3344 status = psa_verify_internal(key, 0, alg, hash, hash_length, signature,
3345 signature_length);
3346
David Horstmann4a48bec2024-03-13 15:42:31 +00003347#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003348exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003349#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003350 LOCAL_INPUT_FREE(hash_external, hash);
3351 LOCAL_INPUT_FREE(signature_external, signature);
3352
3353 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01003354}
3355
Gilles Peskine449bd832023-01-11 14:50:10 +01003356psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3357 psa_algorithm_t alg,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003358 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003359 size_t input_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003360 const uint8_t *salt_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003361 size_t salt_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003362 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003363 size_t output_size,
3364 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003365{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003366 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003367 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003368 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003369
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003370 LOCAL_INPUT_DECLARE(input_external, input);
3371 LOCAL_INPUT_DECLARE(salt_external, salt);
3372 LOCAL_OUTPUT_DECLARE(output_external, output);
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003373
Darryl Green5cc689a2018-07-24 15:34:10 +01003374 (void) input;
3375 (void) input_length;
3376 (void) salt;
3377 (void) output;
3378 (void) output_size;
3379
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003380 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003381
Gilles Peskine449bd832023-01-11 14:50:10 +01003382 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3383 return PSA_ERROR_INVALID_ARGUMENT;
3384 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003385
Valerio Setti5bb454a2024-01-15 10:43:16 +01003386 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003387 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3388 if (status != PSA_SUCCESS) {
3389 return status;
3390 }
3391 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3392 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003393 status = PSA_ERROR_INVALID_ARGUMENT;
3394 goto exit;
3395 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003396
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003397 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3398 LOCAL_INPUT_ALLOC(salt_external, salt_length, salt);
3399 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmann93fa4e12024-03-12 15:02:28 +00003400
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003401 status = psa_driver_wrapper_asymmetric_encrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003402 &slot->attr, slot->key.data, slot->key.bytes,
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003403 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003404 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003405exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00003406 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003407
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003408 LOCAL_INPUT_FREE(input_external, input);
3409 LOCAL_INPUT_FREE(salt_external, salt);
3410 LOCAL_OUTPUT_FREE(output_external, output);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003411
Gilles Peskine449bd832023-01-11 14:50:10 +01003412 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003413}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003414
Gilles Peskine449bd832023-01-11 14:50:10 +01003415psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3416 psa_algorithm_t alg,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003417 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003418 size_t input_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003419 const uint8_t *salt_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003420 size_t salt_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003421 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003422 size_t output_size,
3423 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003424{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003425 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003426 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003427 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003428
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003429 LOCAL_INPUT_DECLARE(input_external, input);
3430 LOCAL_INPUT_DECLARE(salt_external, salt);
3431 LOCAL_OUTPUT_DECLARE(output_external, output);
3432
Darryl Green5cc689a2018-07-24 15:34:10 +01003433 (void) input;
3434 (void) input_length;
3435 (void) salt;
3436 (void) output;
3437 (void) output_size;
3438
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003439 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003440
Gilles Peskine449bd832023-01-11 14:50:10 +01003441 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3442 return PSA_ERROR_INVALID_ARGUMENT;
3443 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003444
Valerio Setti5bb454a2024-01-15 10:43:16 +01003445 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003446 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3447 if (status != PSA_SUCCESS) {
3448 return status;
3449 }
3450 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003451 status = PSA_ERROR_INVALID_ARGUMENT;
3452 goto exit;
3453 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003454
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003455 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3456 LOCAL_INPUT_ALLOC(salt_external, salt_length, salt);
3457 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmann93fa4e12024-03-12 15:02:28 +00003458
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003459 status = psa_driver_wrapper_asymmetric_decrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003460 &slot->attr, slot->key.data, slot->key.bytes,
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003461 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003462 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003463
3464exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00003465 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003466
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003467 LOCAL_INPUT_FREE(input_external, input);
3468 LOCAL_INPUT_FREE(salt_external, salt);
3469 LOCAL_OUTPUT_FREE(output_external, output);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003470
Gilles Peskine449bd832023-01-11 14:50:10 +01003471 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003472}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003473
Paul Elliott9fe12f62022-11-30 19:16:02 +00003474/****************************************************************/
3475/* Asymmetric interruptible cryptography */
3476/****************************************************************/
3477
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003478static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3479
Paul Elliott9fe12f62022-11-30 19:16:02 +00003480void psa_interruptible_set_max_ops(uint32_t max_ops)
3481{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003482 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003483}
3484
3485uint32_t psa_interruptible_get_max_ops(void)
3486{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003487 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003488}
3489
Paul Elliott9fe12f62022-11-30 19:16:02 +00003490uint32_t psa_sign_hash_get_num_ops(
3491 const psa_sign_hash_interruptible_operation_t *operation)
3492{
Paul Elliott296ede92022-12-15 17:00:30 +00003493 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003494}
3495
3496uint32_t psa_verify_hash_get_num_ops(
3497 const psa_verify_hash_interruptible_operation_t *operation)
3498{
Paul Elliott296ede92022-12-15 17:00:30 +00003499 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003500}
3501
Paul Elliott59ad9452022-12-18 15:09:02 +00003502static psa_status_t psa_sign_hash_abort_internal(
3503 psa_sign_hash_interruptible_operation_t *operation)
3504{
3505 if (operation->id == 0) {
3506 /* The object has (apparently) been initialized but it is not (yet)
3507 * in use. It's ok to call abort on such an object, and there's
3508 * nothing to do. */
3509 return PSA_SUCCESS;
3510 }
3511
3512 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3513
3514 status = psa_driver_wrapper_sign_hash_abort(operation);
3515
3516 operation->id = 0;
3517
Paul Elliotte6145dc2023-02-07 12:51:21 +00003518 /* Do not clear either the error_occurred or num_ops elements here as they
3519 * only want to be cleared by the application calling abort, not by abort
3520 * being called at completion of an operation. */
3521
Paul Elliott59ad9452022-12-18 15:09:02 +00003522 return status;
3523}
3524
Paul Elliott9fe12f62022-11-30 19:16:02 +00003525psa_status_t psa_sign_hash_start(
3526 psa_sign_hash_interruptible_operation_t *operation,
3527 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
David Horstmann4a523a62024-03-11 13:32:16 +00003528 const uint8_t *hash_external, size_t hash_length)
Paul Elliott9fe12f62022-11-30 19:16:02 +00003529{
3530 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3531 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3532 psa_key_slot_t *slot;
3533
David Horstmann4a523a62024-03-11 13:32:16 +00003534 LOCAL_INPUT_DECLARE(hash_external, hash);
3535
Paul Elliottc9774412023-02-06 15:14:07 +00003536 /* Check that start has not been previously called, or operation has not
3537 * previously errored. */
3538 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003539 return PSA_ERROR_BAD_STATE;
3540 }
3541
Paul Elliott9fe12f62022-11-30 19:16:02 +00003542 status = psa_sign_verify_check_alg(0, alg);
3543 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003544 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003545 return status;
3546 }
3547
3548 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3549 PSA_KEY_USAGE_SIGN_HASH,
3550 alg);
3551
3552 if (status != PSA_SUCCESS) {
3553 goto exit;
3554 }
3555
3556 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3557 status = PSA_ERROR_INVALID_ARGUMENT;
3558 goto exit;
3559 }
3560
David Horstmann4a523a62024-03-11 13:32:16 +00003561 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3562
Paul Elliott296ede92022-12-15 17:00:30 +00003563 /* Ensure ops count gets reset, in case of operation re-use. */
3564 operation->num_ops = 0;
3565
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003566 status = psa_driver_wrapper_sign_hash_start(operation, &slot->attr,
Paul Elliott9fe12f62022-11-30 19:16:02 +00003567 slot->key.data,
3568 slot->key.bytes, alg,
3569 hash, hash_length);
3570exit:
3571
3572 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003573 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003574 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003575 }
3576
Ryan Everettdcc03d52024-02-14 15:44:13 +00003577 unlock_status = psa_unregister_read_under_mutex(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003578
Paul Elliottc9774412023-02-06 15:14:07 +00003579 if (unlock_status != PSA_SUCCESS) {
3580 operation->error_occurred = 1;
3581 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003582
David Horstmann4a523a62024-03-11 13:32:16 +00003583 LOCAL_INPUT_FREE(hash_external, hash);
3584
Paul Elliottc9774412023-02-06 15:14:07 +00003585 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003586}
3587
3588
3589psa_status_t psa_sign_hash_complete(
3590 psa_sign_hash_interruptible_operation_t *operation,
David Horstmann4a523a62024-03-11 13:32:16 +00003591 uint8_t *signature_external, size_t signature_size,
Paul Elliott9fe12f62022-11-30 19:16:02 +00003592 size_t *signature_length)
3593{
3594 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3595
David Horstmann4a523a62024-03-11 13:32:16 +00003596 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3597
Paul Elliott9fe12f62022-11-30 19:16:02 +00003598 *signature_length = 0;
3599
Paul Elliottc9774412023-02-06 15:14:07 +00003600 /* Check that start has been called first, and that operation has not
3601 * previously errored. */
3602 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003603 status = PSA_ERROR_BAD_STATE;
3604 goto exit;
3605 }
3606
Paul Elliott096abc42023-02-03 18:33:23 +00003607 /* Immediately reject a zero-length signature buffer. This guarantees that
3608 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003609 if (signature_size == 0) {
3610 status = PSA_ERROR_BUFFER_TOO_SMALL;
3611 goto exit;
3612 }
3613
David Horstmann4a523a62024-03-11 13:32:16 +00003614 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3615
Paul Elliott9fe12f62022-11-30 19:16:02 +00003616 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3617 signature_size,
3618 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003619
Paul Elliott296ede92022-12-15 17:00:30 +00003620 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003621 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003622
Paul Elliottebe225c2023-02-10 14:32:53 +00003623exit:
3624
David Horstmannc5064c82024-03-11 17:02:03 +00003625 if (signature != NULL) {
3626 psa_wipe_tag_output_buffer(signature, status, signature_size,
3627 *signature_length);
3628 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003629
Paul Elliott53bb3122023-02-10 14:22:22 +00003630 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003631 if (status != PSA_SUCCESS) {
3632 operation->error_occurred = 1;
3633 }
3634
Paul Elliott59ad9452022-12-18 15:09:02 +00003635 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003636 }
3637
David Horstmann4a523a62024-03-11 13:32:16 +00003638 LOCAL_OUTPUT_FREE(signature_external, signature);
3639
Paul Elliott9fe12f62022-11-30 19:16:02 +00003640 return status;
3641}
3642
3643psa_status_t psa_sign_hash_abort(
3644 psa_sign_hash_interruptible_operation_t *operation)
3645{
Paul Elliott59ad9452022-12-18 15:09:02 +00003646 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3647
3648 status = psa_sign_hash_abort_internal(operation);
3649
3650 /* We clear the number of ops done here, so that it is not cleared when
3651 * the operation fails or succeeds, only on manual abort. */
3652 operation->num_ops = 0;
3653
Paul Elliottc9774412023-02-06 15:14:07 +00003654 /* Likewise, failure state. */
3655 operation->error_occurred = 0;
3656
Paul Elliott59ad9452022-12-18 15:09:02 +00003657 return status;
3658}
3659
3660static psa_status_t psa_verify_hash_abort_internal(
3661 psa_verify_hash_interruptible_operation_t *operation)
3662{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003663 if (operation->id == 0) {
3664 /* The object has (apparently) been initialized but it is not (yet)
3665 * in use. It's ok to call abort on such an object, and there's
3666 * nothing to do. */
3667 return PSA_SUCCESS;
3668 }
3669
Paul Elliott59ad9452022-12-18 15:09:02 +00003670 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3671
3672 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003673
3674 operation->id = 0;
3675
Paul Elliotte6145dc2023-02-07 12:51:21 +00003676 /* Do not clear either the error_occurred or num_ops elements here as they
3677 * only want to be cleared by the application calling abort, not by abort
3678 * being called at completion of an operation. */
3679
Paul Elliott59ad9452022-12-18 15:09:02 +00003680 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003681}
3682
3683psa_status_t psa_verify_hash_start(
3684 psa_verify_hash_interruptible_operation_t *operation,
3685 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
David Horstmann0fea6a52024-03-11 13:41:05 +00003686 const uint8_t *hash_external, size_t hash_length,
3687 const uint8_t *signature_external, size_t signature_length)
Paul Elliott9fe12f62022-11-30 19:16:02 +00003688{
3689 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3690 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3691 psa_key_slot_t *slot;
3692
David Horstmann0fea6a52024-03-11 13:41:05 +00003693 LOCAL_INPUT_DECLARE(hash_external, hash);
3694 LOCAL_INPUT_DECLARE(signature_external, signature);
3695
Paul Elliottc9774412023-02-06 15:14:07 +00003696 /* Check that start has not been previously called, or operation has not
3697 * previously errored. */
3698 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003699 return PSA_ERROR_BAD_STATE;
3700 }
3701
3702 status = psa_sign_verify_check_alg(0, alg);
3703 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003704 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003705 return status;
3706 }
3707
3708 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3709 PSA_KEY_USAGE_VERIFY_HASH,
3710 alg);
3711
3712 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003713 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003714 return status;
3715 }
3716
David Horstmann0fea6a52024-03-11 13:41:05 +00003717 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3718 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3719
Paul Elliott296ede92022-12-15 17:00:30 +00003720 /* Ensure ops count gets reset, in case of operation re-use. */
3721 operation->num_ops = 0;
3722
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003723 status = psa_driver_wrapper_verify_hash_start(operation, &slot->attr,
Paul Elliott9fe12f62022-11-30 19:16:02 +00003724 slot->key.data,
3725 slot->key.bytes,
3726 alg, hash, hash_length,
3727 signature, signature_length);
David Horstmann4a48bec2024-03-13 15:42:31 +00003728#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
David Horstmann0fea6a52024-03-11 13:41:05 +00003729exit:
3730#endif
Paul Elliott9fe12f62022-11-30 19:16:02 +00003731
3732 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003733 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003734 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003735 }
3736
Ryan Everett291267f2024-02-14 15:59:15 +00003737 unlock_status = psa_unregister_read_under_mutex(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003738
Paul Elliottc9774412023-02-06 15:14:07 +00003739 if (unlock_status != PSA_SUCCESS) {
3740 operation->error_occurred = 1;
3741 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003742
David Horstmann0fea6a52024-03-11 13:41:05 +00003743 LOCAL_INPUT_FREE(hash_external, hash);
3744 LOCAL_INPUT_FREE(signature_external, signature);
3745
Paul Elliottc9774412023-02-06 15:14:07 +00003746 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003747}
3748
3749psa_status_t psa_verify_hash_complete(
3750 psa_verify_hash_interruptible_operation_t *operation)
3751{
3752 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3753
Paul Elliottc9774412023-02-06 15:14:07 +00003754 /* Check that start has been called first, and that operation has not
3755 * previously errored. */
3756 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003757 status = PSA_ERROR_BAD_STATE;
3758 goto exit;
3759 }
3760
3761 status = psa_driver_wrapper_verify_hash_complete(operation);
3762
Paul Elliott296ede92022-12-15 17:00:30 +00003763 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003764 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003765 operation);
3766
Paul Elliottebe225c2023-02-10 14:32:53 +00003767exit:
3768
Paul Elliott9fe12f62022-11-30 19:16:02 +00003769 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003770 if (status != PSA_SUCCESS) {
3771 operation->error_occurred = 1;
3772 }
3773
Paul Elliott59ad9452022-12-18 15:09:02 +00003774 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003775 }
3776
3777 return status;
3778}
3779
3780psa_status_t psa_verify_hash_abort(
3781 psa_verify_hash_interruptible_operation_t *operation)
3782{
Paul Elliott59ad9452022-12-18 15:09:02 +00003783 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003784
Paul Elliott59ad9452022-12-18 15:09:02 +00003785 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003786
Paul Elliott59ad9452022-12-18 15:09:02 +00003787 /* We clear the number of ops done here, so that it is not cleared when
3788 * the operation fails or succeeds, only on manual abort. */
3789 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003790
Paul Elliottc9774412023-02-06 15:14:07 +00003791 /* Likewise, failure state. */
3792 operation->error_occurred = 0;
3793
Paul Elliott59ad9452022-12-18 15:09:02 +00003794 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003795}
3796
Paul Elliott588f8ed2022-12-02 18:10:26 +00003797/****************************************************************/
3798/* Asymmetric interruptible cryptography internal */
3799/* implementations */
3800/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003801
Paul Elliott588f8ed2022-12-02 18:10:26 +00003802void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3803{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003804
Paul Elliott588f8ed2022-12-02 18:10:26 +00003805#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3806 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3807 defined(MBEDTLS_ECP_RESTARTABLE)
3808
3809 /* Internal implementation uses zero to indicate infinite number max ops,
3810 * therefore avoid this value, and set to minimum possible. */
3811 if (max_ops == 0) {
3812 max_ops = 1;
3813 }
3814
Paul Elliott588f8ed2022-12-02 18:10:26 +00003815 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003816#else
3817 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003818#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3819 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3820 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3821}
3822
Paul Elliott588f8ed2022-12-02 18:10:26 +00003823uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003824 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003825{
3826#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3827 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3828 defined(MBEDTLS_ECP_RESTARTABLE)
3829
Paul Elliott93d9ca82023-02-15 18:14:21 +00003830 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003831#else
3832 (void) operation;
3833 return 0;
3834#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3835 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3836 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3837}
3838
3839uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003840 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003841{
3842 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3843 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3844 defined(MBEDTLS_ECP_RESTARTABLE)
3845
Paul Elliott93d9ca82023-02-15 18:14:21 +00003846 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003847#else
3848 (void) operation;
3849 return 0;
3850#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3851 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3852 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3853}
3854
3855psa_status_t mbedtls_psa_sign_hash_start(
3856 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3857 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3858 size_t key_buffer_size, psa_algorithm_t alg,
3859 const uint8_t *hash, size_t hash_length)
3860{
3861 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003862 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003863
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003864 if (!PSA_KEY_TYPE_IS_ECC(attributes->type)) {
Paul Elliott068fe072023-01-16 13:59:15 +00003865 return PSA_ERROR_NOT_SUPPORTED;
3866 }
3867
3868 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003869 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003870 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003871
3872#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003873 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3874 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003875
Paul Elliotta1c94092023-02-15 16:38:04 +00003876 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3877
Paul Elliott93d9ca82023-02-15 18:14:21 +00003878 /* Ensure num_ops is zero'ed in case of context re-use. */
3879 operation->num_ops = 0;
3880
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003881 status = mbedtls_psa_ecp_load_representation(attributes->type,
3882 attributes->bits,
Paul Elliott068fe072023-01-16 13:59:15 +00003883 key_buffer,
3884 key_buffer_size,
3885 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003886
Paul Elliott068fe072023-01-16 13:59:15 +00003887 if (status != PSA_SUCCESS) {
3888 return status;
3889 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003890
Paul Elliott1bc59df2023-02-05 13:41:57 +00003891 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003892 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003893
Paul Elliott068fe072023-01-16 13:59:15 +00003894 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003895 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003896 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003897
Paul Elliott0290a762023-02-09 14:30:24 +00003898 /* We only need to store the same length of hash as the private key size
3899 * here, it would be truncated by the internal implementation anyway. */
3900 required_hash_length = (hash_length < operation->coordinate_bytes ?
3901 hash_length : operation->coordinate_bytes);
3902
Paul Elliottba70ad42023-02-15 18:23:53 +00003903 if (required_hash_length > sizeof(operation->hash)) {
3904 /* Shouldn't happen, but better safe than sorry. */
3905 return PSA_ERROR_CORRUPTION_DETECTED;
3906 }
3907
Paul Elliott0290a762023-02-09 14:30:24 +00003908 memcpy(operation->hash, hash, required_hash_length);
3909 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003910
3911 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003912
3913#else
Paul Elliott068fe072023-01-16 13:59:15 +00003914 (void) operation;
3915 (void) key_buffer;
3916 (void) key_buffer_size;
3917 (void) alg;
3918 (void) hash;
3919 (void) hash_length;
3920 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003921 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003922
Paul Elliott068fe072023-01-16 13:59:15 +00003923 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003924#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3925 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3926 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003927}
3928
3929psa_status_t mbedtls_psa_sign_hash_complete(
3930 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3931 uint8_t *signature, size_t signature_size,
3932 size_t *signature_length)
3933{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003934#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3935 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3936 defined(MBEDTLS_ECP_RESTARTABLE)
3937
Paul Elliotta1c94092023-02-15 16:38:04 +00003938 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003939 mbedtls_mpi r;
3940 mbedtls_mpi s;
3941
Paul Elliott46845252023-02-03 14:59:11 +00003942 mbedtls_mpi_init(&r);
3943 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003944
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003945 /* Ensure max_ops is set to the current value (or default). */
3946 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3947
Paul Elliotta1c94092023-02-15 16:38:04 +00003948 if (signature_size < 2 * operation->coordinate_bytes) {
3949 status = PSA_ERROR_BUFFER_TOO_SMALL;
3950 goto exit;
3951 }
3952
Paul Elliott588f8ed2022-12-02 18:10:26 +00003953 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003954
Paul Elliott588f8ed2022-12-02 18:10:26 +00003955#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3956 status = mbedtls_to_psa_error(
3957 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003958 &r,
3959 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003960 &operation->ctx->d,
3961 operation->hash,
3962 operation->hash_length,
3963 operation->md_alg,
3964 mbedtls_psa_get_random,
3965 MBEDTLS_PSA_RANDOM_STATE,
3966 &operation->restart_ctx));
3967#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003968 status = PSA_ERROR_NOT_SUPPORTED;
3969 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003970#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3971 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003972 status = mbedtls_to_psa_error(
3973 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003974 &r,
3975 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003976 &operation->ctx->d,
3977 operation->hash,
3978 operation->hash_length,
3979 mbedtls_psa_get_random,
3980 MBEDTLS_PSA_RANDOM_STATE,
3981 mbedtls_psa_get_random,
3982 MBEDTLS_PSA_RANDOM_STATE,
3983 &operation->restart_ctx));
3984 }
3985
Paul Elliottf8e5b562023-02-19 18:43:45 +00003986 /* Hide the fact that the restart context only holds a delta of number of
3987 * ops done during the last operation, not an absolute value. */
3988 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3989
Paul Elliott724bd252023-02-08 12:35:08 +00003990 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003991 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003992 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003993 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003994 operation->coordinate_bytes)
3995 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003996
3997 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003998 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003999 }
4000
4001 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00004002 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004003 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004004 operation->coordinate_bytes,
4005 operation->coordinate_bytes)
4006 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00004007
4008 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00004009 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004010 }
4011
Paul Elliott1bc59df2023-02-05 13:41:57 +00004012 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004013
Paul Elliott724bd252023-02-08 12:35:08 +00004014 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004015 }
Paul Elliott724bd252023-02-08 12:35:08 +00004016
4017exit:
4018
4019 mbedtls_mpi_free(&r);
4020 mbedtls_mpi_free(&s);
4021 return status;
4022
Paul Elliott588f8ed2022-12-02 18:10:26 +00004023 #else
4024
4025 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004026 (void) signature;
4027 (void) signature_size;
4028 (void) signature_length;
4029
4030 return PSA_ERROR_NOT_SUPPORTED;
4031
4032#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4033 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4034 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4035}
4036
4037psa_status_t mbedtls_psa_sign_hash_abort(
4038 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
4039{
4040
4041#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4042 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4043 defined(MBEDTLS_ECP_RESTARTABLE)
4044
4045 if (operation->ctx) {
4046 mbedtls_ecdsa_free(operation->ctx);
4047 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004048 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004049 }
4050
4051 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4052
Paul Elliott93d9ca82023-02-15 18:14:21 +00004053 operation->num_ops = 0;
4054
Paul Elliott588f8ed2022-12-02 18:10:26 +00004055 return PSA_SUCCESS;
4056
4057#else
4058
4059 (void) operation;
4060
4061 return PSA_ERROR_NOT_SUPPORTED;
4062
4063#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4064 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4065 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4066}
4067
4068psa_status_t mbedtls_psa_verify_hash_start(
4069 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
4070 const psa_key_attributes_t *attributes,
4071 const uint8_t *key_buffer, size_t key_buffer_size,
4072 psa_algorithm_t alg,
4073 const uint8_t *hash, size_t hash_length,
4074 const uint8_t *signature, size_t signature_length)
4075{
4076 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00004077 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00004078 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004079
Gilles Peskine2f107ae2024-02-28 01:26:46 +01004080 if (!PSA_KEY_TYPE_IS_ECC(attributes->type)) {
Paul Elliott068fe072023-01-16 13:59:15 +00004081 return PSA_ERROR_NOT_SUPPORTED;
4082 }
4083
4084 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00004085 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00004086 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004087
4088#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00004089 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4090 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00004091
Paul Elliotta1c94092023-02-15 16:38:04 +00004092 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
4093 mbedtls_mpi_init(&operation->r);
4094 mbedtls_mpi_init(&operation->s);
4095
Paul Elliott93d9ca82023-02-15 18:14:21 +00004096 /* Ensure num_ops is zero'ed in case of context re-use. */
4097 operation->num_ops = 0;
4098
Gilles Peskine2f107ae2024-02-28 01:26:46 +01004099 status = mbedtls_psa_ecp_load_representation(attributes->type,
4100 attributes->bits,
Paul Elliott068fe072023-01-16 13:59:15 +00004101 key_buffer,
4102 key_buffer_size,
4103 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004104
Paul Elliott068fe072023-01-16 13:59:15 +00004105 if (status != PSA_SUCCESS) {
4106 return status;
4107 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004108
Paul Elliottc569fc22023-02-10 13:02:54 +00004109 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004110
Paul Elliott1bc59df2023-02-05 13:41:57 +00004111 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004112 return PSA_ERROR_INVALID_SIGNATURE;
4113 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004114
Paul Elliott068fe072023-01-16 13:59:15 +00004115 status = mbedtls_to_psa_error(
4116 mbedtls_mpi_read_binary(&operation->r,
4117 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004118 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004119
Paul Elliott068fe072023-01-16 13:59:15 +00004120 if (status != PSA_SUCCESS) {
4121 return status;
4122 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004123
Paul Elliott068fe072023-01-16 13:59:15 +00004124 status = mbedtls_to_psa_error(
4125 mbedtls_mpi_read_binary(&operation->s,
4126 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004127 coordinate_bytes,
4128 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004129
Paul Elliott068fe072023-01-16 13:59:15 +00004130 if (status != PSA_SUCCESS) {
4131 return status;
4132 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004133
Paul Elliott2c9843f2023-02-15 17:32:42 +00004134 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004135
Paul Elliott2c9843f2023-02-15 17:32:42 +00004136 if (status != PSA_SUCCESS) {
4137 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004138 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004139
Paul Elliott0290a762023-02-09 14:30:24 +00004140 /* We only need to store the same length of hash as the private key size
4141 * here, it would be truncated by the internal implementation anyway. */
4142 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4143 coordinate_bytes);
4144
Paul Elliottba70ad42023-02-15 18:23:53 +00004145 if (required_hash_length > sizeof(operation->hash)) {
4146 /* Shouldn't happen, but better safe than sorry. */
4147 return PSA_ERROR_CORRUPTION_DETECTED;
4148 }
4149
Paul Elliott0290a762023-02-09 14:30:24 +00004150 memcpy(operation->hash, hash, required_hash_length);
4151 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004152
4153 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004154#else
Paul Elliott068fe072023-01-16 13:59:15 +00004155 (void) operation;
4156 (void) key_buffer;
4157 (void) key_buffer_size;
4158 (void) alg;
4159 (void) hash;
4160 (void) hash_length;
4161 (void) signature;
4162 (void) signature_length;
4163 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004164 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004165 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004166
Paul Elliott068fe072023-01-16 13:59:15 +00004167 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004168#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4169 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4170 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004171}
4172
4173psa_status_t mbedtls_psa_verify_hash_complete(
4174 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4175{
4176
4177#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4178 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4179 defined(MBEDTLS_ECP_RESTARTABLE)
4180
Paul Elliottf8e5b562023-02-19 18:43:45 +00004181 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4182
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004183 /* Ensure max_ops is set to the current value (or default). */
4184 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4185
Paul Elliottf8e5b562023-02-19 18:43:45 +00004186 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004187 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4188 operation->hash,
4189 operation->hash_length,
4190 &operation->ctx->Q,
4191 &operation->r,
4192 &operation->s,
4193 &operation->restart_ctx));
4194
Paul Elliottf8e5b562023-02-19 18:43:45 +00004195 /* Hide the fact that the restart context only holds a delta of number of
4196 * ops done during the last operation, not an absolute value. */
4197 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4198
4199 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004200#else
4201 (void) operation;
4202
4203 return PSA_ERROR_NOT_SUPPORTED;
4204
4205#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4206 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4207 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4208}
4209
4210psa_status_t mbedtls_psa_verify_hash_abort(
4211 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4212{
4213
4214#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4215 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4216 defined(MBEDTLS_ECP_RESTARTABLE)
4217
4218 if (operation->ctx) {
4219 mbedtls_ecdsa_free(operation->ctx);
4220 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004221 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004222 }
4223
4224 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4225
Paul Elliott93d9ca82023-02-15 18:14:21 +00004226 operation->num_ops = 0;
4227
Paul Elliott588f8ed2022-12-02 18:10:26 +00004228 mbedtls_mpi_free(&operation->r);
4229 mbedtls_mpi_free(&operation->s);
4230
4231 return PSA_SUCCESS;
4232
4233#else
4234 (void) operation;
4235
4236 return PSA_ERROR_NOT_SUPPORTED;
4237
4238#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4239 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4240 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4241}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004242
David Horstmann6e99bb22024-02-06 15:27:49 +00004243static psa_status_t psa_generate_random_internal(uint8_t *output,
4244 size_t output_size)
4245{
4246 GUARD_MODULE_INITIALIZED;
4247
David Horstmann6e99bb22024-02-06 15:27:49 +00004248#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4249
David Horstmanndb909142024-03-12 16:07:08 +00004250 psa_status_t status;
David Horstmann6e99bb22024-02-06 15:27:49 +00004251 size_t output_length = 0;
4252 status = mbedtls_psa_external_get_random(&global_data.rng,
4253 output, output_size,
4254 &output_length);
4255 if (status != PSA_SUCCESS) {
David Horstmanndb909142024-03-12 16:07:08 +00004256 return status;
David Horstmann6e99bb22024-02-06 15:27:49 +00004257 }
4258 /* Breaking up a request into smaller chunks is currently not supported
4259 * for the external RNG interface. */
4260 if (output_length != output_size) {
David Horstmanndb909142024-03-12 16:07:08 +00004261 return PSA_ERROR_INSUFFICIENT_ENTROPY;
David Horstmann6e99bb22024-02-06 15:27:49 +00004262 }
David Horstmanndb909142024-03-12 16:07:08 +00004263 return PSA_SUCCESS;
David Horstmann6e99bb22024-02-06 15:27:49 +00004264
4265#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4266
4267 while (output_size > 0) {
David Horstmann93fa4e12024-03-12 15:02:28 +00004268 int ret = MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED;
David Horstmann6e99bb22024-02-06 15:27:49 +00004269 size_t request_size =
4270 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4271 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4272 output_size);
David Horstmann93fa4e12024-03-12 15:02:28 +00004273#if defined(MBEDTLS_CTR_DRBG_C)
4274 ret = mbedtls_ctr_drbg_random(&global_data.rng.drbg, output, request_size);
4275#elif defined(MBEDTLS_HMAC_DRBG_C)
4276 ret = mbedtls_hmac_drbg_random(&global_data.rng.drbg, output, request_size);
4277#endif /* !MBEDTLS_CTR_DRBG_C && !MBEDTLS_HMAC_DRBG_C */
David Horstmann6e99bb22024-02-06 15:27:49 +00004278 if (ret != 0) {
David Horstmann93fa4e12024-03-12 15:02:28 +00004279 return mbedtls_to_psa_error(ret);
David Horstmann6e99bb22024-02-06 15:27:49 +00004280 }
4281 output_size -= request_size;
4282 output += request_size;
4283 }
David Horstmann93fa4e12024-03-12 15:02:28 +00004284 return PSA_SUCCESS;
David Horstmann6e99bb22024-02-06 15:27:49 +00004285#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
David Horstmann6e99bb22024-02-06 15:27:49 +00004286}
4287
4288
mohammad1603503973b2018-03-12 15:59:30 +02004289/****************************************************************/
4290/* Symmetric cryptography */
4291/****************************************************************/
4292
Gilles Peskine449bd832023-01-11 14:50:10 +01004293static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4294 mbedtls_svc_key_id_t key,
4295 psa_algorithm_t alg,
4296 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004297{
4298 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4299 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004300 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004301 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4302 PSA_KEY_USAGE_ENCRYPT :
4303 PSA_KEY_USAGE_DECRYPT);
Ronald Cronab99ac22020-10-01 16:38:28 +02004304
4305 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004306 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004307 status = PSA_ERROR_BAD_STATE;
4308 goto exit;
4309 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004310
Gilles Peskine449bd832023-01-11 14:50:10 +01004311 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004312 status = PSA_ERROR_INVALID_ARGUMENT;
4313 goto exit;
4314 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004315
Gilles Peskine449bd832023-01-11 14:50:10 +01004316 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4317 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004318 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004319 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004320
Ronald Cron49fafa92021-03-10 08:34:23 +01004321 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004322 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004323 * so we only set it (in the driver wrapper) after resources have been
4324 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004325 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004326 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004327 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004328 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004329 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004330 }
4331 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004332
4333 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004334 if (cipher_operation == MBEDTLS_ENCRYPT) {
4335 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004336 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01004337 slot->key.data,
4338 slot->key.bytes,
4339 alg);
4340 } else {
4341 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004342 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01004343 slot->key.data,
4344 slot->key.bytes,
4345 alg);
4346 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004347
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004348exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004349 if (status != PSA_SUCCESS) {
4350 psa_cipher_abort(operation);
4351 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004352
Ryan Everettc0053cc2024-02-14 16:27:13 +00004353 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004354
Gilles Peskine449bd832023-01-11 14:50:10 +01004355 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004356}
4357
Gilles Peskine449bd832023-01-11 14:50:10 +01004358psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4359 mbedtls_svc_key_id_t key,
4360 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004361{
Gilles Peskine449bd832023-01-11 14:50:10 +01004362 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004363}
4364
Gilles Peskine449bd832023-01-11 14:50:10 +01004365psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4366 mbedtls_svc_key_id_t key,
4367 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004368{
Gilles Peskine449bd832023-01-11 14:50:10 +01004369 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004370}
4371
Gilles Peskine449bd832023-01-11 14:50:10 +01004372psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
Gabor Mezei358eb212024-02-07 18:10:13 +01004373 uint8_t *iv_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004374 size_t iv_size,
4375 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004376{
Ronald Cron6d051732020-10-01 14:10:20 +02004377 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Sergeybef1f632023-03-06 15:25:06 -07004378 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004379
Gabor Mezei358eb212024-02-07 18:10:13 +01004380 LOCAL_OUTPUT_DECLARE(iv_external, iv);
4381
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004383 status = PSA_ERROR_BAD_STATE;
4384 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004385 }
4386
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004388 status = PSA_ERROR_BAD_STATE;
4389 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004390 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004391
Ronald Cron2fb90522021-07-05 12:31:44 +02004392 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004394 status = PSA_ERROR_BUFFER_TOO_SMALL;
4395 goto exit;
4396 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004397
Gilles Peskine449bd832023-01-11 14:50:10 +01004398 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004399 status = PSA_ERROR_GENERIC_ERROR;
4400 goto exit;
4401 }
4402
Gabor Mezei358eb212024-02-07 18:10:13 +01004403 LOCAL_OUTPUT_ALLOC(iv_external, default_iv_length, iv);
4404
Gabor Mezei1b5b58d2024-03-04 17:15:08 +01004405 status = psa_generate_random_internal(iv, default_iv_length);
Gilles Peskine449bd832023-01-11 14:50:10 +01004406 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004407 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004408 }
Ronald Cron5618a392021-03-26 09:52:26 +01004409
Gilles Peskine449bd832023-01-11 14:50:10 +01004410 status = psa_driver_wrapper_cipher_set_iv(operation,
Gabor Mezei358eb212024-02-07 18:10:13 +01004411 iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004412
4413exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004414 if (status == PSA_SUCCESS) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004415 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004416 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004417 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004418 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004419 psa_cipher_abort(operation);
Gabor Mezei358eb212024-02-07 18:10:13 +01004420 if (iv != NULL) {
4421 mbedtls_platform_zeroize(iv, default_iv_length);
4422 }
Ronald Cron2fb90522021-07-05 12:31:44 +02004423 }
Ronald Cron6d051732020-10-01 14:10:20 +02004424
Gabor Mezei358eb212024-02-07 18:10:13 +01004425 LOCAL_OUTPUT_FREE(iv_external, iv);
Gilles Peskine449bd832023-01-11 14:50:10 +01004426 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004427}
4428
Gilles Peskine449bd832023-01-11 14:50:10 +01004429psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004430 const uint8_t *iv_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004431 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004432{
Ronald Cron6d051732020-10-01 14:10:20 +02004433 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004434
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004435 LOCAL_INPUT_DECLARE(iv_external, iv);
4436
Gilles Peskine449bd832023-01-11 14:50:10 +01004437 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004438 status = PSA_ERROR_BAD_STATE;
4439 goto exit;
4440 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004441
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004443 status = PSA_ERROR_BAD_STATE;
4444 goto exit;
4445 }
Ronald Crona0d68172021-03-26 10:15:08 +01004446
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004448 status = PSA_ERROR_INVALID_ARGUMENT;
4449 goto exit;
4450 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004451
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004452 LOCAL_INPUT_ALLOC(iv_external, iv_length, iv);
4453
Gilles Peskine449bd832023-01-11 14:50:10 +01004454 status = psa_driver_wrapper_cipher_set_iv(operation,
4455 iv,
4456 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004457
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004458exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004459 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004460 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004461 } else {
4462 psa_cipher_abort(operation);
4463 }
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004464
4465 LOCAL_INPUT_FREE(iv_external, iv);
4466
Gilles Peskine449bd832023-01-11 14:50:10 +01004467 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004468}
4469
Gilles Peskine449bd832023-01-11 14:50:10 +01004470psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
Gabor Mezei212eb082024-01-24 16:56:00 +01004471 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004472 size_t input_length,
Gabor Mezei212eb082024-01-24 16:56:00 +01004473 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004474 size_t output_size,
4475 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004476{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004477 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004478
Gabor Mezei212eb082024-01-24 16:56:00 +01004479 LOCAL_INPUT_DECLARE(input_external, input);
4480 LOCAL_OUTPUT_DECLARE(output_external, output);
4481
Gilles Peskine449bd832023-01-11 14:50:10 +01004482 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004483 status = PSA_ERROR_BAD_STATE;
4484 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004485 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004486
Gilles Peskine449bd832023-01-11 14:50:10 +01004487 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004488 status = PSA_ERROR_BAD_STATE;
4489 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004490 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004491
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004492 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gabor Mezei0b041162024-02-29 10:08:16 +00004493 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004494
Gilles Peskine449bd832023-01-11 14:50:10 +01004495 status = psa_driver_wrapper_cipher_update(operation,
4496 input,
4497 input_length,
4498 output,
4499 output_size,
4500 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004501
4502exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 if (status != PSA_SUCCESS) {
4504 psa_cipher_abort(operation);
4505 }
Ronald Cron6d051732020-10-01 14:10:20 +02004506
Gabor Mezei212eb082024-01-24 16:56:00 +01004507 LOCAL_INPUT_FREE(input_external, input);
4508 LOCAL_OUTPUT_FREE(output_external, output);
4509
Gilles Peskine449bd832023-01-11 14:50:10 +01004510 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004511}
4512
Gilles Peskine449bd832023-01-11 14:50:10 +01004513psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
Gabor Mezei212eb082024-01-24 16:56:00 +01004514 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 size_t output_size,
4516 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004517{
David Saadab4ecc272019-02-14 13:48:10 +02004518 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004519
Gabor Mezei212eb082024-01-24 16:56:00 +01004520 LOCAL_OUTPUT_DECLARE(output_external, output);
4521
Gilles Peskine449bd832023-01-11 14:50:10 +01004522 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004523 status = PSA_ERROR_BAD_STATE;
4524 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004525 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004526
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004528 status = PSA_ERROR_BAD_STATE;
4529 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004530 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004531
Gabor Mezei0b041162024-02-29 10:08:16 +00004532 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004533
Gilles Peskine449bd832023-01-11 14:50:10 +01004534 status = psa_driver_wrapper_cipher_finish(operation,
4535 output,
4536 output_size,
4537 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004538
4539exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004540 if (status == PSA_SUCCESS) {
Gabor Mezei212eb082024-01-24 16:56:00 +01004541 status = psa_cipher_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01004542 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004543 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 (void) psa_cipher_abort(operation);
Steven Cooremanef8575e2020-09-11 11:44:50 +02004545 }
Gabor Mezei212eb082024-01-24 16:56:00 +01004546
4547 LOCAL_OUTPUT_FREE(output_external, output);
4548
4549 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004550}
4551
Gilles Peskine449bd832023-01-11 14:50:10 +01004552psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004553{
Gilles Peskine449bd832023-01-11 14:50:10 +01004554 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004555 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004556 * in use. It's ok to call abort on such an object, and there's
4557 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004558 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004559 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004560
Gilles Peskine449bd832023-01-11 14:50:10 +01004561 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004562
Ronald Cron49fafa92021-03-10 08:34:23 +01004563 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004564 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004565 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004566
Gilles Peskine449bd832023-01-11 14:50:10 +01004567 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004568}
4569
Gilles Peskine449bd832023-01-11 14:50:10 +01004570psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4571 psa_algorithm_t alg,
David Horstmann36df4b22023-12-13 15:55:25 +00004572 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004573 size_t input_length,
David Horstmann36df4b22023-12-13 15:55:25 +00004574 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004575 size_t output_size,
4576 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004577{
4578 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004579 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004580 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004581 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4582 size_t default_iv_length = 0;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004583
David Horstmann62a56d92023-12-14 18:12:47 +00004584 LOCAL_INPUT_DECLARE(input_external, input);
4585 LOCAL_OUTPUT_DECLARE(output_external, output);
4586
Gilles Peskine449bd832023-01-11 14:50:10 +01004587 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004588 status = PSA_ERROR_INVALID_ARGUMENT;
4589 goto exit;
4590 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004591
Gilles Peskine449bd832023-01-11 14:50:10 +01004592 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4593 PSA_KEY_USAGE_ENCRYPT,
4594 alg);
4595 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004596 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004597 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004598
Gilles Peskine449bd832023-01-11 14:50:10 +01004599 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4600 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004601 status = PSA_ERROR_GENERIC_ERROR;
4602 goto exit;
4603 }
4604
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 if (default_iv_length > 0) {
4606 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004607 status = PSA_ERROR_BUFFER_TOO_SMALL;
4608 goto exit;
4609 }
4610
David Horstmann6e99bb22024-02-06 15:27:49 +00004611 status = psa_generate_random_internal(local_iv, default_iv_length);
Gilles Peskine449bd832023-01-11 14:50:10 +01004612 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004613 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004614 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004615 }
4616
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004617 LOCAL_INPUT_ALLOC(input_external, input_length, input);
4618 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
4619
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004620 status = psa_driver_wrapper_cipher_encrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004621 &slot->attr, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004622 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004623 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004625
4626exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004627 unlock_status = psa_unregister_read_under_mutex(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004628 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004629 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004630 }
Ronald Cron23919522021-07-08 19:00:07 +02004631
Gilles Peskine449bd832023-01-11 14:50:10 +01004632 if (status == PSA_SUCCESS) {
4633 if (default_iv_length > 0) {
4634 memcpy(output, local_iv, default_iv_length);
4635 }
4636 *output_length += default_iv_length;
4637 } else {
4638 *output_length = 0;
4639 }
4640
David Horstmann62a56d92023-12-14 18:12:47 +00004641 LOCAL_INPUT_FREE(input_external, input);
4642 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004643
Gilles Peskine449bd832023-01-11 14:50:10 +01004644 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004645}
4646
Gilles Peskine449bd832023-01-11 14:50:10 +01004647psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4648 psa_algorithm_t alg,
Gabor Mezei212eb082024-01-24 16:56:00 +01004649 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004650 size_t input_length,
Gabor Mezei212eb082024-01-24 16:56:00 +01004651 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004652 size_t output_size,
4653 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004654{
4655 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004656 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004657 psa_key_slot_t *slot = NULL;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004658
Gabor Mezei212eb082024-01-24 16:56:00 +01004659 LOCAL_INPUT_DECLARE(input_external, input);
4660 LOCAL_OUTPUT_DECLARE(output_external, output);
4661
Gilles Peskine449bd832023-01-11 14:50:10 +01004662 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004663 status = PSA_ERROR_INVALID_ARGUMENT;
4664 goto exit;
4665 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004666
Gilles Peskine449bd832023-01-11 14:50:10 +01004667 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4668 PSA_KEY_USAGE_DECRYPT,
4669 alg);
4670 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004671 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004672 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004673
Gilles Peskineb47c3b32024-06-26 13:16:33 +02004674 if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004675 status = PSA_ERROR_INVALID_ARGUMENT;
4676 goto exit;
4677 }
4678
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004679 LOCAL_INPUT_ALLOC(input_external, input_length, input);
4680 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
4681
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004682 status = psa_driver_wrapper_cipher_decrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004683 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004684 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004685 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004686
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004687exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004688 unlock_status = psa_unregister_read_under_mutex(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004689 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004690 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004691 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004692
Gilles Peskine449bd832023-01-11 14:50:10 +01004693 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004694 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004695 }
Ronald Cron23919522021-07-08 19:00:07 +02004696
Gabor Mezei212eb082024-01-24 16:56:00 +01004697 LOCAL_INPUT_FREE(input_external, input);
4698 LOCAL_OUTPUT_FREE(output_external, output);
4699
Gilles Peskine449bd832023-01-11 14:50:10 +01004700 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004701}
4702
4703
mohammad16035955c982018-04-26 00:53:03 +03004704/****************************************************************/
4705/* AEAD */
4706/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004707
Paul Elliottbaff51c2021-09-28 17:44:45 +01004708/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004709static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004710{
Gilles Peskine449bd832023-01-11 14:50:10 +01004711 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004712}
4713
4714/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004715static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4716 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004717{
Gilles Peskine449bd832023-01-11 14:50:10 +01004718 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004719
Gilles Peskine449bd832023-01-11 14:50:10 +01004720 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004721#if defined(PSA_WANT_ALG_GCM)
4722 case PSA_ALG_GCM:
4723 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004724 * arbitrarily large nonces. Please note that we do not generally
4725 * recommend the usage of nonces of greater length than
4726 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4727 * size, which can then lead to collisions if you encrypt a very
4728 * large number of messages.*/
4729 if (nonce_length != 0) {
4730 return PSA_SUCCESS;
4731 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004732 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004733#endif /* PSA_WANT_ALG_GCM */
4734#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004735 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 if (nonce_length >= 7 && nonce_length <= 13) {
4737 return PSA_SUCCESS;
4738 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004739 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004740#endif /* PSA_WANT_ALG_CCM */
4741#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004742 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004743 if (nonce_length == 12) {
4744 return PSA_SUCCESS;
4745 } else if (nonce_length == 8) {
4746 return PSA_ERROR_NOT_SUPPORTED;
4747 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004748 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004749#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004750 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004751 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004752 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004753 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004754
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004756}
4757
Gilles Peskine449bd832023-01-11 14:50:10 +01004758static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004759{
Gilles Peskine449bd832023-01-11 14:50:10 +01004760 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4761 return PSA_ERROR_INVALID_ARGUMENT;
4762 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004763
Gilles Peskine449bd832023-01-11 14:50:10 +01004764 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004765}
4766
Gilles Peskine449bd832023-01-11 14:50:10 +01004767psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4768 psa_algorithm_t alg,
David Horstmann9d09a022023-11-28 19:25:00 +00004769 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004770 size_t nonce_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004771 const uint8_t *additional_data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004772 size_t additional_data_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004773 const uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004774 size_t plaintext_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004775 uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004776 size_t ciphertext_size,
4777 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004778{
Ronald Cron215633c2021-03-16 17:15:37 +01004779 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4780 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004781
David Horstmann9d09a022023-11-28 19:25:00 +00004782 LOCAL_INPUT_DECLARE(nonce_external, nonce);
4783 LOCAL_INPUT_DECLARE(additional_data_external, additional_data);
4784 LOCAL_INPUT_DECLARE(plaintext_external, plaintext);
4785 LOCAL_OUTPUT_DECLARE(ciphertext_external, ciphertext);
4786
mohammad1603f08a5502018-06-03 15:05:47 +03004787 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004788
Gilles Peskine449bd832023-01-11 14:50:10 +01004789 status = psa_aead_check_algorithm(alg);
4790 if (status != PSA_SUCCESS) {
4791 return status;
4792 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004793
Ronald Cron9a986162021-03-26 12:40:07 +01004794 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004795 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4796 if (status != PSA_SUCCESS) {
4797 return status;
4798 }
mohammad16035955c982018-04-26 00:53:03 +03004799
David Horstmann9d09a022023-11-28 19:25:00 +00004800 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
4801 LOCAL_INPUT_ALLOC(additional_data_external, additional_data_length, additional_data);
4802 LOCAL_INPUT_ALLOC(plaintext_external, plaintext_length, plaintext);
4803 LOCAL_OUTPUT_ALLOC(ciphertext_external, ciphertext_size, ciphertext);
4804
Gilles Peskine449bd832023-01-11 14:50:10 +01004805 status = psa_aead_check_nonce_length(alg, nonce_length);
4806 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004807 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004808 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004809
Ronald Cronde822812021-03-17 16:08:20 +01004810 status = psa_driver_wrapper_aead_encrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004811 &slot->attr, slot->key.data, slot->key.bytes,
Ronald Cron215633c2021-03-16 17:15:37 +01004812 alg,
4813 nonce, nonce_length,
4814 additional_data, additional_data_length,
4815 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004817
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4819 memset(ciphertext, 0, ciphertext_size);
4820 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004821
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004822exit:
David Horstmann9d09a022023-11-28 19:25:00 +00004823 LOCAL_INPUT_FREE(nonce_external, nonce);
4824 LOCAL_INPUT_FREE(additional_data_external, additional_data);
4825 LOCAL_INPUT_FREE(plaintext_external, plaintext);
4826 LOCAL_OUTPUT_FREE(ciphertext_external, ciphertext);
4827
Ryan Everetta103ec92024-01-31 13:59:57 +00004828 psa_unregister_read_under_mutex(slot);
mohammad16035955c982018-04-26 00:53:03 +03004829
Gilles Peskine449bd832023-01-11 14:50:10 +01004830 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004831}
4832
Gilles Peskine449bd832023-01-11 14:50:10 +01004833psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4834 psa_algorithm_t alg,
David Horstmann7f2e0402023-11-28 19:43:53 +00004835 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004836 size_t nonce_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004837 const uint8_t *additional_data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004838 size_t additional_data_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004839 const uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004840 size_t ciphertext_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004841 uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004842 size_t plaintext_size,
4843 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004844{
Ronald Cron215633c2021-03-16 17:15:37 +01004845 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4846 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004847
David Horstmann7f2e0402023-11-28 19:43:53 +00004848 LOCAL_INPUT_DECLARE(nonce_external, nonce);
4849 LOCAL_INPUT_DECLARE(additional_data_external, additional_data);
4850 LOCAL_INPUT_DECLARE(ciphertext_external, ciphertext);
4851 LOCAL_OUTPUT_DECLARE(plaintext_external, plaintext);
4852
Gilles Peskineee652a32018-06-01 19:23:52 +02004853 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004854
Gilles Peskine449bd832023-01-11 14:50:10 +01004855 status = psa_aead_check_algorithm(alg);
4856 if (status != PSA_SUCCESS) {
4857 return status;
4858 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004859
Ronald Cron9a986162021-03-26 12:40:07 +01004860 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004861 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4862 if (status != PSA_SUCCESS) {
4863 return status;
4864 }
mohammad16035955c982018-04-26 00:53:03 +03004865
David Horstmann7f2e0402023-11-28 19:43:53 +00004866 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
4867 LOCAL_INPUT_ALLOC(additional_data_external, additional_data_length,
4868 additional_data);
4869 LOCAL_INPUT_ALLOC(ciphertext_external, ciphertext_length, ciphertext);
4870 LOCAL_OUTPUT_ALLOC(plaintext_external, plaintext_size, plaintext);
4871
Gilles Peskine449bd832023-01-11 14:50:10 +01004872 status = psa_aead_check_nonce_length(alg, nonce_length);
4873 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004874 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004875 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004876
Ronald Cronde822812021-03-17 16:08:20 +01004877 status = psa_driver_wrapper_aead_decrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004878 &slot->attr, slot->key.data, slot->key.bytes,
Ronald Cron215633c2021-03-16 17:15:37 +01004879 alg,
4880 nonce, nonce_length,
4881 additional_data, additional_data_length,
4882 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004883 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004884
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 if (status != PSA_SUCCESS && plaintext_size != 0) {
4886 memset(plaintext, 0, plaintext_size);
4887 }
mohammad160360a64d02018-06-03 17:20:42 +03004888
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004889exit:
David Horstmann7f2e0402023-11-28 19:43:53 +00004890 LOCAL_INPUT_FREE(nonce_external, nonce);
4891 LOCAL_INPUT_FREE(additional_data_external, additional_data);
4892 LOCAL_INPUT_FREE(ciphertext_external, ciphertext);
4893 LOCAL_OUTPUT_FREE(plaintext_external, plaintext);
4894
Ryan Everetta103ec92024-01-31 13:59:57 +00004895 psa_unregister_read_under_mutex(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004896
Gilles Peskine449bd832023-01-11 14:50:10 +01004897 return status;
mohammad16035955c982018-04-26 00:53:03 +03004898}
4899
Gilles Peskine449bd832023-01-11 14:50:10 +01004900static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4901{
4902 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004903
Gilles Peskine449bd832023-01-11 14:50:10 +01004904 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004905#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004906 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004907 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004908 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4909 return PSA_ERROR_INVALID_ARGUMENT;
4910 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004911 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004912#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004913
Przemek Stekiel86679c72022-10-06 17:06:56 +02004914#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004915 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004916 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004917 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4918 return PSA_ERROR_INVALID_ARGUMENT;
4919 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004920 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004921#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004922
Przemek Stekiel86679c72022-10-06 17:06:56 +02004923#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004925 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004926 if (tag_len != 16) {
4927 return PSA_ERROR_INVALID_ARGUMENT;
4928 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004929 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004930#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004931
4932 default:
4933 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004934 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004935 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004936 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004937}
4938
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004939/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004940static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4941 int is_encrypt,
4942 mbedtls_svc_key_id_t key,
4943 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004944{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004945 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4946 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4947 psa_key_slot_t *slot = NULL;
4948 psa_key_usage_t key_usage = 0;
4949
Gilles Peskine449bd832023-01-11 14:50:10 +01004950 status = psa_aead_check_algorithm(alg);
4951 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004952 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004954
Gilles Peskine449bd832023-01-11 14:50:10 +01004955 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004956 status = PSA_ERROR_BAD_STATE;
4957 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004958 }
4959
Gilles Peskine449bd832023-01-11 14:50:10 +01004960 if (operation->nonce_set || operation->lengths_set ||
4961 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004962 status = PSA_ERROR_BAD_STATE;
4963 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004964 }
4965
Gilles Peskine449bd832023-01-11 14:50:10 +01004966 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004967 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004968 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004969 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004970 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004971
Gilles Peskine449bd832023-01-11 14:50:10 +01004972 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4973 alg);
4974 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004975 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004976 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004977
Gilles Peskine449bd832023-01-11 14:50:10 +01004978 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004979 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004980 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004981
Gilles Peskine449bd832023-01-11 14:50:10 +01004982 if (is_encrypt) {
4983 status = psa_driver_wrapper_aead_encrypt_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004984 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01004985 slot->key.data,
4986 slot->key.bytes,
4987 alg);
4988 } else {
4989 status = psa_driver_wrapper_aead_decrypt_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004990 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01004991 slot->key.data,
4992 slot->key.bytes,
4993 alg);
4994 }
4995 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004996 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004997 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004998
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004999 operation->key_type = psa_get_key_type(&slot->attr);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005000
5001exit:
Ryan Everett9af70e52024-02-14 18:38:56 +00005002 unlock_status = psa_unregister_read_under_mutex(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005003
Gilles Peskine449bd832023-01-11 14:50:10 +01005004 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005005 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005006 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01005007 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01005008 } else {
5009 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005010 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005011
Gilles Peskine449bd832023-01-11 14:50:10 +01005012 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01005013}
5014
Paul Elliott302ff6b2021-04-20 18:10:30 +01005015/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005016psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
5017 mbedtls_svc_key_id_t key,
5018 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005019{
Gilles Peskine449bd832023-01-11 14:50:10 +01005020 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005021}
5022
5023/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005024psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
5025 mbedtls_svc_key_id_t key,
5026 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005027{
Gilles Peskine449bd832023-01-11 14:50:10 +01005028 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005029}
5030
David Horstmannfed23772023-12-19 17:49:20 +00005031static psa_status_t psa_aead_set_nonce_internal(psa_aead_operation_t *operation,
5032 const uint8_t *nonce,
5033 size_t nonce_length)
5034{
5035 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5036
5037 if (operation->id == 0) {
5038 status = PSA_ERROR_BAD_STATE;
5039 goto exit;
5040 }
5041
5042 if (operation->nonce_set) {
5043 status = PSA_ERROR_BAD_STATE;
5044 goto exit;
5045 }
5046
5047 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
5048 if (status != PSA_SUCCESS) {
5049 status = PSA_ERROR_INVALID_ARGUMENT;
5050 goto exit;
5051 }
5052
5053 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
5054 nonce_length);
5055
5056exit:
5057 if (status == PSA_SUCCESS) {
5058 operation->nonce_set = 1;
5059 } else {
5060 psa_aead_abort(operation);
5061 }
5062
5063 return status;
5064}
5065
Paul Elliott302ff6b2021-04-20 18:10:30 +01005066/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01005067psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
David Horstmannd3cad8b2023-12-11 14:46:04 +00005068 uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005069 size_t nonce_size,
5070 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005071{
5072 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01005073 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07005074 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005075
David Horstmannd3cad8b2023-12-11 14:46:04 +00005076 LOCAL_OUTPUT_DECLARE(nonce_external, nonce);
5077 LOCAL_OUTPUT_ALLOC(nonce_external, nonce_size, nonce);
5078
Paul Elliott8eb9daf2021-06-04 16:42:21 +01005079 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005080
Gilles Peskine449bd832023-01-11 14:50:10 +01005081 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005082 status = PSA_ERROR_BAD_STATE;
5083 goto exit;
5084 }
5085
Gilles Peskine449bd832023-01-11 14:50:10 +01005086 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005087 status = PSA_ERROR_BAD_STATE;
5088 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005089 }
5090
Paul Elliotte193ea82021-10-01 13:00:16 +01005091 /* For CCM, this size may not be correct according to the PSA
5092 * specification. The PSA Crypto 1.0.1 specification states:
5093 *
5094 * CCM encodes the plaintext length pLen in L octets, with L the smallest
5095 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
5096 *
5097 * However this restriction that L has to be the smallest integer is not
5098 * applied in practice, and it is not implementable here since the
5099 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005100 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
5101 operation->alg);
5102 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005103 status = PSA_ERROR_BUFFER_TOO_SMALL;
5104 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005105 }
5106
David Horstmann6e99bb22024-02-06 15:27:49 +00005107 status = psa_generate_random_internal(local_nonce, required_nonce_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005109 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005110 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01005111
David Horstmannfed23772023-12-19 17:49:20 +00005112 status = psa_aead_set_nonce_internal(operation, local_nonce,
5113 required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005114
Paul Elliott39dc6b82021-05-11 19:16:09 +01005115exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005116 if (status == PSA_SUCCESS) {
5117 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005118 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01005119 } else {
5120 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01005121 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005122
David Horstmannd3cad8b2023-12-11 14:46:04 +00005123 LOCAL_OUTPUT_FREE(nonce_external, nonce);
5124
Gilles Peskine449bd832023-01-11 14:50:10 +01005125 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005126}
5127
5128/* Set the nonce for a multipart authenticated encryption or decryption
5129 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005130psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
David Horstmann8f0ef512023-12-11 15:17:11 +00005131 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005132 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005133{
David Horstmannfed23772023-12-19 17:49:20 +00005134 psa_status_t status;
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005135
David Horstmann8f0ef512023-12-11 15:17:11 +00005136 LOCAL_INPUT_DECLARE(nonce_external, nonce);
5137 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
Paul Elliottcee785c2021-05-20 14:29:20 +01005138
David Horstmannfed23772023-12-19 17:49:20 +00005139 status = psa_aead_set_nonce_internal(operation, nonce, nonce_length);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005140
David Horstmann18dc0322023-12-20 16:16:43 +00005141/* Exit label is only needed for buffer copying, prevent unused warnings. */
David Horstmann4a48bec2024-03-13 15:42:31 +00005142#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Paul Elliott39dc6b82021-05-11 19:16:09 +01005143exit:
David Horstmann18dc0322023-12-20 16:16:43 +00005144#endif
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005145
David Horstmann8f0ef512023-12-11 15:17:11 +00005146 LOCAL_INPUT_FREE(nonce_external, nonce);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005147
Gilles Peskine449bd832023-01-11 14:50:10 +01005148 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005149}
5150
5151/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005152psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
5153 size_t ad_length,
5154 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005155{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005156 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5157
Gilles Peskine449bd832023-01-11 14:50:10 +01005158 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005159 status = PSA_ERROR_BAD_STATE;
5160 goto exit;
5161 }
5162
Gilles Peskine449bd832023-01-11 14:50:10 +01005163 if (operation->lengths_set || operation->ad_started ||
5164 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005165 status = PSA_ERROR_BAD_STATE;
5166 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005167 }
5168
Gilles Peskine449bd832023-01-11 14:50:10 +01005169 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005170#if defined(PSA_WANT_ALG_GCM)
5171 case PSA_ALG_GCM:
5172 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 * bits. Without the guard this code will generate warnings on 32bit
5174 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01005175#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01005176 if (((uint64_t) ad_length) >> 61 != 0 ||
5177 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005178 status = PSA_ERROR_INVALID_ARGUMENT;
5179 goto exit;
5180 }
Paul Elliott325d3742021-09-27 17:56:28 +01005181#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005182 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005183#endif /* PSA_WANT_ALG_GCM */
5184#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005185 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005187 status = PSA_ERROR_INVALID_ARGUMENT;
5188 goto exit;
5189 }
5190 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005191#endif /* PSA_WANT_ALG_CCM */
5192#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005193 case PSA_ALG_CHACHA20_POLY1305:
5194 /* No length restrictions for ChaChaPoly. */
5195 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005196#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005197 default:
5198 break;
5199 }
Paul Elliott325d3742021-09-27 17:56:28 +01005200
Gilles Peskine449bd832023-01-11 14:50:10 +01005201 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
5202 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005203
Paul Elliott39dc6b82021-05-11 19:16:09 +01005204exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005205 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005206 operation->ad_remaining = ad_length;
5207 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01005208 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005209 } else {
5210 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01005211 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005212
Gilles Peskine449bd832023-01-11 14:50:10 +01005213 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005214}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005215
5216/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005217psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
David Horstmann25dac6e2023-12-11 15:23:13 +00005218 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005219 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005220{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005221 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5222
David Horstmann25dac6e2023-12-11 15:23:13 +00005223 LOCAL_INPUT_DECLARE(input_external, input);
5224 LOCAL_INPUT_ALLOC(input_external, input_length, input);
5225
Gilles Peskine449bd832023-01-11 14:50:10 +01005226 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005227 status = PSA_ERROR_BAD_STATE;
5228 goto exit;
5229 }
5230
Gilles Peskine449bd832023-01-11 14:50:10 +01005231 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005232 status = PSA_ERROR_BAD_STATE;
5233 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005234 }
5235
Paul Elliott304766f2024-04-26 18:30:11 +01005236 /* No input to add (zero length), nothing to do. */
5237 if (input_length == 0) {
5238 status = PSA_SUCCESS;
5239 goto exit;
5240 }
5241
Gilles Peskine449bd832023-01-11 14:50:10 +01005242 if (operation->lengths_set) {
5243 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005244 status = PSA_ERROR_INVALID_ARGUMENT;
5245 goto exit;
5246 }
5247
5248 operation->ad_remaining -= input_length;
5249 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005250#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005251 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005252 status = PSA_ERROR_BAD_STATE;
5253 goto exit;
5254 }
5255#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005256
Gilles Peskine449bd832023-01-11 14:50:10 +01005257 status = psa_driver_wrapper_aead_update_ad(operation, input,
5258 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005259
Paul Elliott39dc6b82021-05-11 19:16:09 +01005260exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005261 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005262 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005263 } else {
5264 psa_aead_abort(operation);
5265 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005266
David Horstmann25dac6e2023-12-11 15:23:13 +00005267 LOCAL_INPUT_FREE(input_external, input);
5268
Gilles Peskine449bd832023-01-11 14:50:10 +01005269 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005270}
5271
5272/* Encrypt or decrypt a message fragment in an active multipart AEAD
5273 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005274psa_status_t psa_aead_update(psa_aead_operation_t *operation,
David Horstmann2914fac2023-12-11 15:28:37 +00005275 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005276 size_t input_length,
David Horstmann2914fac2023-12-11 15:28:37 +00005277 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005278 size_t output_size,
5279 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005280{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005281 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005282
David Horstmann2914fac2023-12-11 15:28:37 +00005283
5284 LOCAL_INPUT_DECLARE(input_external, input);
5285 LOCAL_OUTPUT_DECLARE(output_external, output);
5286
5287 LOCAL_INPUT_ALLOC(input_external, input_length, input);
5288 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
5289
Paul Elliott302ff6b2021-04-20 18:10:30 +01005290 *output_length = 0;
5291
Gilles Peskine449bd832023-01-11 14:50:10 +01005292 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005293 status = PSA_ERROR_BAD_STATE;
5294 goto exit;
5295 }
5296
Gilles Peskine449bd832023-01-11 14:50:10 +01005297 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005298 status = PSA_ERROR_BAD_STATE;
5299 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005300 }
5301
Gilles Peskine449bd832023-01-11 14:50:10 +01005302 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005303 /* Additional data length was supplied, but not all the additional
5304 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005305 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005306 status = PSA_ERROR_INVALID_ARGUMENT;
5307 goto exit;
5308 }
5309
5310 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005311 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005312 status = PSA_ERROR_INVALID_ARGUMENT;
5313 goto exit;
5314 }
5315
5316 operation->body_remaining -= input_length;
5317 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005318#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005319 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005320 status = PSA_ERROR_BAD_STATE;
5321 goto exit;
5322 }
5323#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005324
Gilles Peskine449bd832023-01-11 14:50:10 +01005325 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5326 output, output_size,
5327 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005328
Paul Elliott39dc6b82021-05-11 19:16:09 +01005329exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005330 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005331 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005332 } else {
5333 psa_aead_abort(operation);
5334 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005335
David Horstmann2914fac2023-12-11 15:28:37 +00005336 LOCAL_INPUT_FREE(input_external, input);
5337 LOCAL_OUTPUT_FREE(output_external, output);
5338
Gilles Peskine449bd832023-01-11 14:50:10 +01005339 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005340}
5341
Gilles Peskine449bd832023-01-11 14:50:10 +01005342static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005343{
Gilles Peskine449bd832023-01-11 14:50:10 +01005344 if (operation->id == 0 || !operation->nonce_set) {
5345 return PSA_ERROR_BAD_STATE;
5346 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005347
Gilles Peskine449bd832023-01-11 14:50:10 +01005348 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5349 operation->body_remaining != 0)) {
5350 return PSA_ERROR_INVALID_ARGUMENT;
5351 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005352
Gilles Peskine449bd832023-01-11 14:50:10 +01005353 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005354}
5355
Paul Elliott302ff6b2021-04-20 18:10:30 +01005356/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005357psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
David Horstmann6db0e732023-12-11 15:35:59 +00005358 uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005359 size_t ciphertext_size,
5360 size_t *ciphertext_length,
David Horstmann6db0e732023-12-11 15:35:59 +00005361 uint8_t *tag_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005362 size_t tag_size,
5363 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005364{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005365 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5366
David Horstmann6db0e732023-12-11 15:35:59 +00005367 LOCAL_OUTPUT_DECLARE(ciphertext_external, ciphertext);
5368 LOCAL_OUTPUT_DECLARE(tag_external, tag);
5369
5370 LOCAL_OUTPUT_ALLOC(ciphertext_external, ciphertext_size, ciphertext);
5371 LOCAL_OUTPUT_ALLOC(tag_external, tag_size, tag);
5372
Paul Elliott302ff6b2021-04-20 18:10:30 +01005373 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005374 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005375
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 status = psa_aead_final_checks(operation);
5377 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005378 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005379 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005380
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005382 status = PSA_ERROR_BAD_STATE;
5383 goto exit;
5384 }
5385
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5387 ciphertext_size,
5388 ciphertext_length,
5389 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005390
Paul Elliott39dc6b82021-05-11 19:16:09 +01005391exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005392
5393
Paul Elliottf47b0952021-05-21 18:02:33 +01005394 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005395 * the zero tag size, make sure the tag is set to something implausible.
5396 * Even if the operation succeeds, make sure we clear the rest of the
5397 * buffer to prevent potential leakage of anything previously placed in
5398 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005399 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005400
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005402
David Horstmann6db0e732023-12-11 15:35:59 +00005403 LOCAL_OUTPUT_FREE(ciphertext_external, ciphertext);
5404 LOCAL_OUTPUT_FREE(tag_external, tag);
5405
Gilles Peskine449bd832023-01-11 14:50:10 +01005406 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005407}
5408
5409/* Finish authenticating and decrypting a message in a multipart AEAD
5410 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005411psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
David Horstmanne000a0a2023-12-11 16:37:04 +00005412 uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005413 size_t plaintext_size,
5414 size_t *plaintext_length,
David Horstmanne000a0a2023-12-11 16:37:04 +00005415 const uint8_t *tag_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005416 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005417{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005418 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5419
David Horstmanne000a0a2023-12-11 16:37:04 +00005420 LOCAL_OUTPUT_DECLARE(plaintext_external, plaintext);
5421 LOCAL_INPUT_DECLARE(tag_external, tag);
5422
5423 LOCAL_OUTPUT_ALLOC(plaintext_external, plaintext_size, plaintext);
5424 LOCAL_INPUT_ALLOC(tag_external, tag_length, tag);
5425
Paul Elliott302ff6b2021-04-20 18:10:30 +01005426 *plaintext_length = 0;
5427
Gilles Peskine449bd832023-01-11 14:50:10 +01005428 status = psa_aead_final_checks(operation);
5429 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005430 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005431 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005432
Gilles Peskine449bd832023-01-11 14:50:10 +01005433 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005434 status = PSA_ERROR_BAD_STATE;
5435 goto exit;
5436 }
5437
Gilles Peskine449bd832023-01-11 14:50:10 +01005438 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5439 plaintext_size,
5440 plaintext_length,
5441 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005442
5443exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005444 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005445
David Horstmanne000a0a2023-12-11 16:37:04 +00005446 LOCAL_OUTPUT_FREE(plaintext_external, plaintext);
5447 LOCAL_INPUT_FREE(tag_external, tag);
5448
Gilles Peskine449bd832023-01-11 14:50:10 +01005449 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005450}
5451
5452/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005453psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005454{
5455 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5456
Gilles Peskine449bd832023-01-11 14:50:10 +01005457 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005458 /* The object has (apparently) been initialized but it is not (yet)
5459 * in use. It's ok to call abort on such an object, and there's
5460 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005461 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005462 }
5463
Gilles Peskine449bd832023-01-11 14:50:10 +01005464 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005465
Gilles Peskine449bd832023-01-11 14:50:10 +01005466 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005467
Gilles Peskine449bd832023-01-11 14:50:10 +01005468 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005469}
5470
Gilles Peskinee59236f2018-01-27 23:32:46 +01005471/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005472/* Generators */
5473/****************************************************************/
5474
Przemek Stekiel69c46792022-06-10 12:59:51 +02005475#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005476 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005477 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305478 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305479 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005480#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005481#endif /* At least one builtin KDF */
5482
Przemek Stekiel69c46792022-06-10 12:59:51 +02005483#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005484 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5485 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5486static psa_status_t psa_key_derivation_start_hmac(
5487 psa_mac_operation_t *operation,
5488 psa_algorithm_t hash_alg,
5489 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005490 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005491{
5492 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5493 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005494 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5495 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5496 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005497
Steven Cooreman72f736a2021-05-07 14:14:37 +02005498 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005499 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005500
Gilles Peskine449bd832023-01-11 14:50:10 +01005501 status = psa_driver_wrapper_mac_sign_setup(operation,
5502 &attributes,
5503 hmac_key, hmac_key_length,
5504 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005505
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 psa_reset_key_attributes(&attributes);
5507 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005508}
5509#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005510
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005511#define HKDF_STATE_INIT 0 /* no input yet */
5512#define HKDF_STATE_STARTED 1 /* got salt */
5513#define HKDF_STATE_KEYED 2 /* got key */
5514#define HKDF_STATE_OUTPUT 3 /* output started */
5515
Gilles Peskinecbe66502019-05-16 16:59:18 +02005516static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005517 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005518{
Gilles Peskine449bd832023-01-11 14:50:10 +01005519 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5520 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5521 } else {
5522 return operation->alg;
5523 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005524}
5525
Gilles Peskine449bd832023-01-11 14:50:10 +01005526psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005527{
5528 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5530 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005531 /* The object has (apparently) been initialized but it is not
5532 * in use. It's ok to call abort on such an object, and there's
5533 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005534 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005535#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005536 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5537 mbedtls_free(operation->ctx.hkdf.info);
5538 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5539 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005540#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005541#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5542 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005543 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5544 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5545 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5546 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005547 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005548 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005549 }
5550
Gilles Peskine449bd832023-01-11 14:50:10 +01005551 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005552 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005553 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005554 }
5555
Gilles Peskine449bd832023-01-11 14:50:10 +01005556 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005557 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005558 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005559 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005560#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005561 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005562 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005563 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005564 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005565#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005566 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005567
5568 /* We leave the fields Ai and output_block to be erased safely by the
5569 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005570 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005571#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5572 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005573#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005574 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5575 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5576 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5577 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005578#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305579#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305580 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305581 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005582 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305583 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305584 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305585
5586 status = PSA_SUCCESS;
5587 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305588#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005589 {
5590 status = PSA_ERROR_BAD_STATE;
5591 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005592 mbedtls_platform_zeroize(operation, sizeof(*operation));
5593 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005594}
5595
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005596psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005597 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005598{
Gilles Peskine449bd832023-01-11 14:50:10 +01005599 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005600 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005601 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005602 }
5603
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005604 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005605 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005606}
5607
Gilles Peskine449bd832023-01-11 14:50:10 +01005608psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5609 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005610{
Gilles Peskine449bd832023-01-11 14:50:10 +01005611 if (operation->alg == 0) {
5612 return PSA_ERROR_BAD_STATE;
5613 }
5614 if (capacity > operation->capacity) {
5615 return PSA_ERROR_INVALID_ARGUMENT;
5616 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005617 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005619}
5620
Przemek Stekiel69c46792022-06-10 12:59:51 +02005621#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005622/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005623static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5624 psa_algorithm_t kdf_alg,
5625 uint8_t *output,
5626 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005627{
Gilles Peskine449bd832023-01-11 14:50:10 +01005628 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5629 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005630 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005631 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005632#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005633 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005634#else
5635 const uint8_t last_block = 0xff;
5636#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005637
Gilles Peskine449bd832023-01-11 14:50:10 +01005638 if (hkdf->state < HKDF_STATE_KEYED ||
5639 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005640#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005641 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005642#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005643 )) {
5644 return PSA_ERROR_BAD_STATE;
5645 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005646 hkdf->state = HKDF_STATE_OUTPUT;
5647
Gilles Peskine449bd832023-01-11 14:50:10 +01005648 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005649 /* Copy what remains of the current block */
5650 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005651 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005652 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005653 }
5654 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005655 output += n;
5656 output_length -= n;
5657 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005658 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005659 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005660 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005661 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005662 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005663 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005664 * object was corrupted or if this function is called directly
5665 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005666 if (hkdf->block_number == last_block) {
5667 return PSA_ERROR_BAD_STATE;
5668 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005669
5670 /* We need a new block */
5671 ++hkdf->block_number;
5672 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005673
Gilles Peskine449bd832023-01-11 14:50:10 +01005674 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5675 hash_alg,
5676 hkdf->prk,
5677 hash_length);
5678 if (status != PSA_SUCCESS) {
5679 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005680 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005681
5682 if (hkdf->block_number != 1) {
5683 status = psa_mac_update(&hkdf->hmac,
5684 hkdf->output_block,
5685 hash_length);
5686 if (status != PSA_SUCCESS) {
5687 return status;
5688 }
5689 }
5690 status = psa_mac_update(&hkdf->hmac,
5691 hkdf->info,
5692 hkdf->info_length);
5693 if (status != PSA_SUCCESS) {
5694 return status;
5695 }
5696 status = psa_mac_update(&hkdf->hmac,
5697 &hkdf->block_number, 1);
5698 if (status != PSA_SUCCESS) {
5699 return status;
5700 }
5701 status = psa_mac_sign_finish(&hkdf->hmac,
5702 hkdf->output_block,
5703 sizeof(hkdf->output_block),
5704 &hmac_output_length);
5705 if (status != PSA_SUCCESS) {
5706 return status;
5707 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005708 }
5709
Gilles Peskine449bd832023-01-11 14:50:10 +01005710 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005711}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005712#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005713
John Durkop07cc04a2020-11-16 22:08:34 -08005714#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5715 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005716static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5717 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005718 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005719{
Gilles Peskine449bd832023-01-11 14:50:10 +01005720 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5721 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005722 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5723 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005724 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005725
Janos Follath7742fee2019-06-17 12:58:10 +01005726 /* We can't be wanting more output after block 0xff, otherwise
5727 * the capacity check in psa_key_derivation_output_bytes() would have
5728 * prevented this call. It could happen only if the operation
5729 * object was corrupted or if this function is called directly
5730 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005731 if (tls12_prf->block_number == 0xff) {
5732 return PSA_ERROR_CORRUPTION_DETECTED;
5733 }
Janos Follath7742fee2019-06-17 12:58:10 +01005734
5735 /* We need a new block */
5736 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005737 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005738
5739 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5740 *
5741 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5742 *
5743 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5744 * HMAC_hash(secret, A(2) + seed) +
5745 * HMAC_hash(secret, A(3) + seed) + ...
5746 *
5747 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005748 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005749 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005750 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005751 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005752 * is currently extracted as `output_block` and where i is
5753 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005754 */
5755
Gilles Peskine449bd832023-01-11 14:50:10 +01005756 status = psa_key_derivation_start_hmac(&hmac,
5757 hash_alg,
5758 tls12_prf->secret,
5759 tls12_prf->secret_length);
5760 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005761 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005762 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005763
5764 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005765 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005766 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5767 * the variable seed and in this instance means it in the context of the
5768 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005769 status = psa_mac_update(&hmac,
5770 tls12_prf->label,
5771 tls12_prf->label_length);
5772 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005773 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005774 }
5775 status = psa_mac_update(&hmac,
5776 tls12_prf->seed,
5777 tls12_prf->seed_length);
5778 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005779 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005780 }
5781 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005782 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005783 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5784 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005785 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005786 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005787 }
5788
Gilles Peskine449bd832023-01-11 14:50:10 +01005789 status = psa_mac_sign_finish(&hmac,
5790 tls12_prf->Ai, hash_length,
5791 &hmac_output_length);
5792 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005793 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005794 }
5795 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005796 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005797 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005798
5799 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005800 status = psa_key_derivation_start_hmac(&hmac,
5801 hash_alg,
5802 tls12_prf->secret,
5803 tls12_prf->secret_length);
5804 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005805 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005806 }
5807 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5808 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005809 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005810 }
5811 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5812 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005813 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005814 }
5815 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5816 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005817 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005818 }
5819 status = psa_mac_sign_finish(&hmac,
5820 tls12_prf->output_block, hash_length,
5821 &hmac_output_length);
5822 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005823 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005824 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005825
Janos Follath7742fee2019-06-17 12:58:10 +01005826
5827cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005828 cleanup_status = psa_mac_abort(&hmac);
5829 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005830 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005831 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005832
Gilles Peskine449bd832023-01-11 14:50:10 +01005833 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005834}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005835
Janos Follath844eb0e2019-06-19 12:10:49 +01005836static psa_status_t psa_key_derivation_tls12_prf_read(
5837 psa_tls12_prf_key_derivation_t *tls12_prf,
5838 psa_algorithm_t alg,
5839 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005840 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005841{
Gilles Peskine449bd832023-01-11 14:50:10 +01005842 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5843 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005844 psa_status_t status;
5845 uint8_t offset, length;
5846
Gilles Peskine449bd832023-01-11 14:50:10 +01005847 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005848 case PSA_TLS12_PRF_STATE_LABEL_SET:
5849 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5850 break;
5851 case PSA_TLS12_PRF_STATE_OUTPUT:
5852 break;
5853 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005854 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005855 }
5856
Gilles Peskine449bd832023-01-11 14:50:10 +01005857 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005858 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005859 if (tls12_prf->left_in_block == 0) {
5860 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5861 alg);
5862 if (status != PSA_SUCCESS) {
5863 return status;
5864 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005865
5866 continue;
5867 }
5868
Gilles Peskine449bd832023-01-11 14:50:10 +01005869 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005870 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005871 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005872 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005873 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005874
5875 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005876 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005877 output += length;
5878 output_length -= length;
5879 tls12_prf->left_in_block -= length;
5880 }
5881
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005883}
John Durkop07cc04a2020-11-16 22:08:34 -08005884#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5885 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005886
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005887#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5888static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5889 psa_tls12_ecjpake_to_pms_t *ecjpake,
5890 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005891 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005892{
5893 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005894 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005895
Gilles Peskine449bd832023-01-11 14:50:10 +01005896 if (output_length != 32) {
5897 return PSA_ERROR_INVALID_ARGUMENT;
5898 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005899
Gilles Peskine449bd832023-01-11 14:50:10 +01005900 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5901 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5902 &output_size);
5903 if (status != PSA_SUCCESS) {
5904 return status;
5905 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005906
Gilles Peskine449bd832023-01-11 14:50:10 +01005907 if (output_size != output_length) {
5908 return PSA_ERROR_GENERIC_ERROR;
5909 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005910
Gilles Peskine449bd832023-01-11 14:50:10 +01005911 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005912}
5913#endif
5914
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305915#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305916static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5917 psa_pbkdf2_key_derivation_t *pbkdf2,
5918 psa_algorithm_t prf_alg,
5919 uint8_t prf_output_length,
5920 psa_key_attributes_t *attributes)
5921{
5922 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305923 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305924 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305925 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305926 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305927 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305928 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305929
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305930 mac_operation.is_sign = 1;
5931 mac_operation.mac_size = prf_output_length;
5932 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305933
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305934 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5935 attributes,
5936 pbkdf2->password,
5937 pbkdf2->password_length,
5938 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305939 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305940 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305941 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305942 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5943 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305944 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305945 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305946 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305947 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305948 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305949 }
5950 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5951 &mac_output_length);
5952 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305953 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305954 }
5955
5956 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305957 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305958 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305959 }
5960
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305961 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305962
5963 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305964 /* We are passing prf_output_length as mac_size because the driver
5965 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305966 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305967 status = psa_driver_wrapper_mac_compute(attributes,
5968 pbkdf2->password,
5969 pbkdf2->password_length,
5970 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305971 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305972 &mac_output_length);
5973 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305974 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305975 }
5976
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305977 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305978 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305979
5980cleanup:
5981 /* Zeroise buffers to clear sensitive data from memory. */
5982 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5983 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305984}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305985
5986static psa_status_t psa_key_derivation_pbkdf2_read(
5987 psa_pbkdf2_key_derivation_t *pbkdf2,
5988 psa_algorithm_t kdf_alg,
5989 uint8_t *output,
5990 size_t output_length)
5991{
5992 psa_status_t status;
5993 psa_algorithm_t prf_alg;
5994 uint8_t prf_output_length;
5995 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5996 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5997 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5998
5999 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6000 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
6001 prf_output_length = PSA_HASH_LENGTH(prf_alg);
6002 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05306003 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6004 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306005 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05306006 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05306007 } else {
6008 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05306009 }
6010
6011 switch (pbkdf2->state) {
6012 case PSA_PBKDF2_STATE_PASSWORD_SET:
6013 /* Initially we need a new block so bytes_used is equal to block size*/
6014 pbkdf2->bytes_used = prf_output_length;
6015 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
6016 break;
6017 case PSA_PBKDF2_STATE_OUTPUT:
6018 break;
6019 default:
6020 return PSA_ERROR_BAD_STATE;
6021 }
6022
6023 while (output_length != 0) {
6024 uint8_t n = prf_output_length - pbkdf2->bytes_used;
6025 if (n > output_length) {
6026 n = (uint8_t) output_length;
6027 }
6028 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
6029 output += n;
6030 output_length -= n;
6031 pbkdf2->bytes_used += n;
6032
6033 if (output_length == 0) {
6034 break;
6035 }
6036
6037 /* We need a new block */
6038 pbkdf2->bytes_used = 0;
6039 pbkdf2->block_number++;
6040
6041 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
6042 prf_output_length,
6043 &attributes);
6044 if (status != PSA_SUCCESS) {
6045 return status;
6046 }
6047 }
6048
6049 return PSA_SUCCESS;
6050}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306051#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306052
Janos Follath6c6c8fc2019-06-17 12:38:20 +01006053psa_status_t psa_key_derivation_output_bytes(
6054 psa_key_derivation_operation_t *operation,
Ryan Everettf943e222024-01-19 14:46:39 +00006055 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01006056 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006057{
6058 psa_status_t status;
Ryan Everettf943e222024-01-19 14:46:39 +00006059 LOCAL_OUTPUT_DECLARE(output_external, output);
6060
Gilles Peskine449bd832023-01-11 14:50:10 +01006061 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02006062
Gilles Peskine449bd832023-01-11 14:50:10 +01006063 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006064 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006065 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006066 }
6067
Gilles Peskine449bd832023-01-11 14:50:10 +01006068 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006069 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006070 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02006071 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
6072 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006073 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02006074 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006075 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006076 }
Ryan Everettf943e222024-01-19 14:46:39 +00006077
6078 LOCAL_OUTPUT_ALLOC(output_external, output_length, output);
Ryan Everettda9227d2024-01-25 11:37:22 +00006079 if (output_length > operation->capacity) {
6080 operation->capacity = 0;
6081 /* Go through the error path to wipe all confidential data now
6082 * that the operation object is useless. */
6083 status = PSA_ERROR_INSUFFICIENT_DATA;
6084 goto exit;
6085 }
6086
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006087 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006088
Przemek Stekiel69c46792022-06-10 12:59:51 +02006089#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006090 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6091 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
6092 output, output_length);
6093 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006094#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006095#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6096 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6098 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6099 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
6100 kdf_alg, output,
6101 output_length);
6102 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006103#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
6104 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006105#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006106 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006107 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01006108 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
6109 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006110#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306111#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306112 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05306113 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
6114 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05306115 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306116#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006117
Gilles Peskineeab56e42018-07-12 17:12:33 +02006118 {
Steven Cooreman74afe472021-02-10 17:19:22 +01006119 (void) kdf_alg;
Ryan Everettf943e222024-01-19 14:46:39 +00006120 status = PSA_ERROR_BAD_STATE;
6121 LOCAL_OUTPUT_FREE(output_external, output);
6122
6123 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006124 }
6125
6126exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006127 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006128 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006129 * This allows us to differentiate between exhausted operations and
6130 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
6131 * operations. */
6132 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006133 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006134 operation->alg = alg;
Ryan Everettee5920a2024-02-09 15:09:28 +00006135 if (output != NULL) {
6136 memset(output, '!', output_length);
6137 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006138 }
Ryan Everettda9227d2024-01-25 11:37:22 +00006139
6140 LOCAL_OUTPUT_FREE(output_external, output);
Gilles Peskine449bd832023-01-11 14:50:10 +01006141 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006142}
6143
David Brown7807bf72021-02-09 16:28:23 -07006144#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006145static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02006146{
Gilles Peskine449bd832023-01-11 14:50:10 +01006147 if (data_size >= 8) {
6148 mbedtls_des_key_set_parity(data);
6149 }
6150 if (data_size >= 16) {
6151 mbedtls_des_key_set_parity(data + 8);
6152 }
6153 if (data_size >= 24) {
6154 mbedtls_des_key_set_parity(data + 16);
6155 }
Gilles Peskine08542d82018-07-19 17:05:42 +02006156}
David Brown7807bf72021-02-09 16:28:23 -07006157#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02006158
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006159/*
Gilles Peskine449bd832023-01-11 14:50:10 +01006160 * ECC keys on a Weierstrass elliptic curve require the generation
6161 * of a private key which is an integer
6162 * in the range [1, N - 1], where N is the boundary of the private key domain:
6163 * N is the prime p for Diffie-Hellman, or the order of the
6164 * curve’s base point for ECC.
6165 *
6166 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
6167 * This function generates the private key using the following process:
6168 *
6169 * 1. Draw a byte string of length ceiling(m/8) bytes.
6170 * 2. If m is not a multiple of 8, set the most significant
6171 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
6172 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
6173 * 4. If k > N - 2, discard the result and return to step 1.
6174 * 5. Output k + 1 as the private key.
6175 *
6176 * This method allows compliance to NIST standards, specifically the methods titled
6177 * Key-Pair Generation by Testing Candidates in the following publications:
6178 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
6179 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
6180 * Diffie-Hellman keys.
6181 *
6182 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
6183 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
6184 *
6185 * Note: Function allocates memory for *data buffer, so given *data should be
6186 * always NULL.
6187 */
Valerio Setti86587ab2023-06-27 13:09:30 +02006188#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
6189#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006190static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006191 psa_key_slot_t *slot,
6192 size_t bits,
6193 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006194 uint8_t **data
6195 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006196{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006197 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006198 mbedtls_mpi k;
6199 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006200 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006201 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006202 size_t m;
6203 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006204
Gilles Peskine449bd832023-01-11 14:50:10 +01006205 mbedtls_mpi_init(&k);
6206 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006207
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006208 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01006209 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006210 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01006211 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006212
Gilles Peskine449bd832023-01-11 14:50:10 +01006213 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006214 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01006215 goto cleanup;
6216 }
6217
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006218 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01006219 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006220
Gilles Peskine449bd832023-01-11 14:50:10 +01006221 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006222
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006223 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006224 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006225 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006226
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006227 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006228
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006229 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006231
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006232 /* Note: This function is always called with *data == NULL and it
6233 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006234 *data = mbedtls_calloc(1, m_bytes);
6235 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006236 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006237 goto cleanup;
6238 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006239
Gilles Peskine449bd832023-01-11 14:50:10 +01006240 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006241 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006242 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006243 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01006244 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006245
6246 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006247 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006248 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006249 * (8 * ceiling(m/8) - m) bits of the first byte in
6250 * the string to zero.
6251 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006252 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006253 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006254 }
6255
6256 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01006257 * big-endian byte string.
6258 */
6259 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006260
6261 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01006262 * Result of comparison is returned. When it indicates error
6263 * then this function is called again.
6264 */
6265 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006266 }
6267
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006268 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006269 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6270 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006271cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006272 if (ret != 0) {
6273 status = mbedtls_to_psa_error(ret);
6274 }
6275 if (status != PSA_SUCCESS) {
6276 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006277 *data = NULL;
6278 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006279 mbedtls_mpi_free(&k);
6280 mbedtls_mpi_free(&diff_N_2);
6281 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006282}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006283
6284/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6285 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6286 *
6287 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6288 * draw a 32-byte string and process it as specified in
6289 * Elliptic Curves for Security [RFC7748] §5.
6290 *
6291 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6292 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6293 *
6294 * Note: Function allocates memory for *data buffer, so given *data should be
6295 * always NULL.
6296 */
6297
6298static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6299 size_t bits,
6300 psa_key_derivation_operation_t *operation,
6301 uint8_t **data
6302 )
6303{
6304 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006305 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006306
Gilles Peskine449bd832023-01-11 14:50:10 +01006307 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006308 case 255:
6309 output_length = 32;
6310 break;
6311 case 448:
6312 output_length = 56;
6313 break;
6314 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006315 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006316 break;
6317 }
6318
Gilles Peskine449bd832023-01-11 14:50:10 +01006319 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006320
Gilles Peskine449bd832023-01-11 14:50:10 +01006321 if (*data == NULL) {
6322 return PSA_ERROR_INSUFFICIENT_MEMORY;
6323 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006324
Gilles Peskine449bd832023-01-11 14:50:10 +01006325 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006326
Gilles Peskine449bd832023-01-11 14:50:10 +01006327 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006328 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006329 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006330
Gilles Peskine449bd832023-01-11 14:50:10 +01006331 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006332 case 255:
6333 (*data)[0] &= 248;
6334 (*data)[31] &= 127;
6335 (*data)[31] |= 64;
6336 break;
6337 case 448:
6338 (*data)[0] &= 252;
6339 (*data)[55] |= 128;
6340 break;
6341 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006342 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006343 break;
6344 }
6345
6346 return status;
6347}
Valerio Setti86587ab2023-06-27 13:09:30 +02006348#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6349static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6350 psa_key_slot_t *slot, size_t bits,
6351 psa_key_derivation_operation_t *operation, uint8_t **data)
6352{
6353 (void) slot;
6354 (void) bits;
6355 (void) operation;
6356 (void) data;
6357 return PSA_ERROR_NOT_SUPPORTED;
6358}
6359
6360static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6361 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6362{
6363 (void) bits;
6364 (void) operation;
6365 (void) data;
6366 return PSA_ERROR_NOT_SUPPORTED;
6367}
6368#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6369#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006370
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006371static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006372 psa_key_slot_t *slot,
6373 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006374 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006375{
6376 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006377 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306378 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006379 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006380
Gilles Peskine449bd832023-01-11 14:50:10 +01006381 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6382 return PSA_ERROR_INVALID_ARGUMENT;
6383 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006384
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006385#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006386 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006387 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6388 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6389 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006390 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006391 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6392 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006393 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006394 }
6395 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006396 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006397 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6398 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006399 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006400 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006401 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006402 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006403#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006404 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006405 if (key_type_is_raw_bytes(slot->attr.type)) {
6406 if (bits % 8 != 0) {
6407 return PSA_ERROR_INVALID_ARGUMENT;
6408 }
6409 data = mbedtls_calloc(1, bytes);
6410 if (data == NULL) {
6411 return PSA_ERROR_INSUFFICIENT_MEMORY;
6412 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006413
Gilles Peskine449bd832023-01-11 14:50:10 +01006414 status = psa_key_derivation_output_bytes(operation, data, bytes);
6415 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006416 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006417 }
David Brown12ca5032021-02-11 11:02:00 -07006418#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006419 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6420 psa_des_set_key_parity(data, bytes);
6421 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006422#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006423 } else {
6424 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006425 }
Ronald Crondd04d422020-11-28 15:14:42 +01006426
Ronald Cronbf33c932020-11-28 18:06:53 +01006427 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006428
Gilles Peskine2f107ae2024-02-28 01:26:46 +01006429 if (psa_key_lifetime_is_external(slot->attr.lifetime)) {
Gilles Peskine7a5d9202024-02-28 01:18:23 +01006430 status = psa_driver_wrapper_get_key_buffer_size(&slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01006431 &storage_size);
6432 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306433 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006434 }
Archanad8a83dc2021-06-14 10:04:16 +05306435 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006436 status = psa_allocate_buffer_to_slot(slot, storage_size);
6437 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306438 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006439 }
Archanad8a83dc2021-06-14 10:04:16 +05306440
Gilles Peskine7a5d9202024-02-28 01:18:23 +01006441 status = psa_driver_wrapper_import_key(&slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01006442 data, bytes,
6443 slot->key.data,
6444 slot->key.bytes,
6445 &slot->key.bytes, &bits);
6446 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006447 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006448 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006449
6450exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006451 mbedtls_free(data);
6452 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006453}
6454
Gilles Peskinef36d7852024-06-06 21:11:44 +02006455static const psa_custom_key_parameters_t default_custom_production =
Gilles Peskine4a85ff32024-07-18 18:52:59 +02006456 PSA_CUSTOM_KEY_PARAMETERS_INIT;
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006457
Gilles Peskine52504f82024-06-20 17:19:58 +02006458int psa_custom_key_parameters_are_default(
Gilles Peskinef36d7852024-06-06 21:11:44 +02006459 const psa_custom_key_parameters_t *custom,
6460 size_t custom_data_length)
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006461{
Gilles Peskinef36d7852024-06-06 21:11:44 +02006462 if (custom->flags != 0) {
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006463 return 0;
6464 }
Gilles Peskinef36d7852024-06-06 21:11:44 +02006465 if (custom_data_length != 0) {
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006466 return 0;
6467 }
6468 return 1;
6469}
6470
Gilles Peskinef36d7852024-06-06 21:11:44 +02006471psa_status_t psa_key_derivation_output_key_custom(
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006472 const psa_key_attributes_t *attributes,
6473 psa_key_derivation_operation_t *operation,
Gilles Peskinef36d7852024-06-06 21:11:44 +02006474 const psa_custom_key_parameters_t *custom,
6475 const uint8_t *custom_data,
6476 size_t custom_data_length,
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006477 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006478{
6479 psa_status_t status;
6480 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006481 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006482
Ronald Cron81709fc2020-11-14 12:10:32 +01006483 *key = MBEDTLS_SVC_KEY_ID_INIT;
6484
Gilles Peskine0f84d622019-09-12 19:03:13 +02006485 /* Reject any attempt to create a zero-length key so that we don't
6486 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006487 if (psa_get_key_bits(attributes) == 0) {
6488 return PSA_ERROR_INVALID_ARGUMENT;
6489 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006490
Gilles Peskinef36d7852024-06-06 21:11:44 +02006491 (void) custom_data; /* We only accept 0-length data */
Gilles Peskine52504f82024-06-20 17:19:58 +02006492 if (!psa_custom_key_parameters_are_default(custom, custom_data_length)) {
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006493 return PSA_ERROR_INVALID_ARGUMENT;
6494 }
6495
Gilles Peskine449bd832023-01-11 14:50:10 +01006496 if (operation->alg == PSA_ALG_NONE) {
6497 return PSA_ERROR_BAD_STATE;
6498 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006499
Gilles Peskine449bd832023-01-11 14:50:10 +01006500 if (!operation->can_output_key) {
6501 return PSA_ERROR_NOT_PERMITTED;
6502 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006503
Gilles Peskine449bd832023-01-11 14:50:10 +01006504 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6505 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006506#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006507 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006508 /* Deriving a key in a secure element is not implemented yet. */
6509 status = PSA_ERROR_NOT_SUPPORTED;
6510 }
6511#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006512 if (status == PSA_SUCCESS) {
6513 status = psa_generate_derived_key_internal(slot,
Gilles Peskine2f107ae2024-02-28 01:26:46 +01006514 attributes->bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006515 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006516 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006517 if (status == PSA_SUCCESS) {
6518 status = psa_finish_key_creation(slot, driver, key);
6519 }
6520 if (status != PSA_SUCCESS) {
6521 psa_fail_key_creation(slot, driver);
6522 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006523
Gilles Peskine449bd832023-01-11 14:50:10 +01006524 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006525}
6526
Gilles Peskinef36d7852024-06-06 21:11:44 +02006527psa_status_t psa_key_derivation_output_key_ext(
6528 const psa_key_attributes_t *attributes,
6529 psa_key_derivation_operation_t *operation,
6530 const psa_key_production_parameters_t *params,
6531 size_t params_data_length,
6532 mbedtls_svc_key_id_t *key)
6533{
6534 return psa_key_derivation_output_key_custom(
6535 attributes, operation,
6536 (const psa_custom_key_parameters_t *) params,
6537 params->data, params_data_length,
6538 key);
6539}
6540
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006541psa_status_t psa_key_derivation_output_key(
6542 const psa_key_attributes_t *attributes,
6543 psa_key_derivation_operation_t *operation,
6544 mbedtls_svc_key_id_t *key)
6545{
Gilles Peskinef36d7852024-06-06 21:11:44 +02006546 return psa_key_derivation_output_key_custom(attributes, operation,
6547 &default_custom_production,
6548 NULL, 0,
6549 key);
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006550}
Gilles Peskineeab56e42018-07-12 17:12:33 +02006551
6552
6553/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006554/* Key derivation */
6555/****************************************************************/
6556
Steven Cooreman932ffb72021-02-15 12:14:32 +01006557#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006558static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006559{
6560#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006561 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6562 return 1;
6563 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006564#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006565#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006566 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6567 return 1;
6568 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006569#endif
6570#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006571 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6572 return 1;
6573 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006574#endif
6575#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006576 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6577 return 1;
6578 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006579#endif
6580#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006581 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6582 return 1;
6583 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006584#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006585#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006586 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6587 return 1;
6588 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006589#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306590#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6591 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6592 return 1;
6593 }
6594#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306595#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6596 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6597 return 1;
6598 }
6599#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006600 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006601}
6602
Gilles Peskine449bd832023-01-11 14:50:10 +01006603static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006604{
6605 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006606 psa_status_t status = psa_hash_setup(&operation, alg);
6607 psa_hash_abort(&operation);
6608 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006609}
6610
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306611static psa_status_t psa_key_derivation_set_maximum_capacity(
6612 psa_key_derivation_operation_t *operation,
6613 psa_algorithm_t kdf_alg)
6614{
6615#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6616 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6617 operation->capacity = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6618 return PSA_SUCCESS;
6619 }
6620#endif
6621#if defined(PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128)
6622 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6623#if (SIZE_MAX > UINT32_MAX)
Kusumit Ghoderao7d4db632023-12-07 16:17:46 +05306624 operation->capacity = UINT32_MAX * (size_t) PSA_MAC_LENGTH(
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306625 PSA_KEY_TYPE_AES,
6626 128U,
6627 PSA_ALG_CMAC);
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306628#else
6629 operation->capacity = SIZE_MAX;
6630#endif
6631 return PSA_SUCCESS;
6632 }
6633#endif /* PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128 */
6634
6635 /* After this point, if kdf_alg is not valid then value of hash_alg may be
6636 * invalid or meaningless but it does not affect this function */
6637 psa_algorithm_t hash_alg = PSA_ALG_GET_HASH(kdf_alg);
6638 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306639 if (hash_size == 0) {
6640 return PSA_ERROR_NOT_SUPPORTED;
6641 }
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306642
6643 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6644 * we might fail later, which is somewhat unfriendly and potentially
6645 * risk-prone. */
6646 psa_status_t status = psa_hash_try_support(hash_alg);
6647 if (status != PSA_SUCCESS) {
6648 return status;
6649 }
6650
6651#if defined(PSA_WANT_ALG_HKDF)
6652 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6653 operation->capacity = 255 * hash_size;
6654 } else
6655#endif
6656#if defined(PSA_WANT_ALG_HKDF_EXTRACT)
6657 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6658 operation->capacity = hash_size;
6659 } else
6660#endif
6661#if defined(PSA_WANT_ALG_HKDF_EXPAND)
6662 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6663 operation->capacity = 255 * hash_size;
6664 } else
6665#endif
6666#if defined(PSA_WANT_ALG_TLS12_PRF)
6667 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) &&
6668 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6669 operation->capacity = SIZE_MAX;
6670 } else
6671#endif
6672#if defined(PSA_WANT_ALG_TLS12_PSK_TO_MS)
6673 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg) &&
6674 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6675 /* Master Secret is always 48 bytes
6676 * https://datatracker.ietf.org/doc/html/rfc5246.html#section-8.1 */
6677 operation->capacity = 48U;
6678 } else
6679#endif
6680#if defined(PSA_WANT_ALG_PBKDF2_HMAC)
6681 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6682#if (SIZE_MAX > UINT32_MAX)
6683 operation->capacity = UINT32_MAX * hash_size;
6684#else
6685 operation->capacity = SIZE_MAX;
6686#endif
6687 } else
6688#endif /* PSA_WANT_ALG_PBKDF2_HMAC */
6689 {
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306690 (void) hash_size;
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306691 status = PSA_ERROR_NOT_SUPPORTED;
6692 }
6693 return status;
6694}
6695
Gilles Peskine969c5d62019-01-16 15:53:06 +01006696static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006697 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006698 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006699{
Janos Follath5fe19732019-06-20 15:09:30 +01006700 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6701 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006702 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006703
Gilles Peskine969c5d62019-01-16 15:53:06 +01006704 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006705 if (!is_kdf_alg_supported(kdf_alg)) {
6706 return PSA_ERROR_NOT_SUPPORTED;
6707 }
John Durkop07cc04a2020-11-16 22:08:34 -08006708
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306709 psa_status_t status = psa_key_derivation_set_maximum_capacity(operation,
6710 kdf_alg);
Kusumit Ghoderao5f3a9382023-09-13 16:28:12 +05306711 return status;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006712}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006713
Gilles Peskine449bd832023-01-11 14:50:10 +01006714static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006715{
6716#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006717 if (alg == PSA_ALG_ECDH) {
6718 return PSA_SUCCESS;
6719 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006720#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006721#if defined(PSA_WANT_ALG_FFDH)
6722 if (alg == PSA_ALG_FFDH) {
6723 return PSA_SUCCESS;
6724 }
6725#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006726 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006727 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006728}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006729
6730static int psa_key_derivation_allows_free_form_secret_input(
6731 psa_algorithm_t kdf_alg)
6732{
6733#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6734 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6735 return 0;
6736 }
6737#endif
6738 (void) kdf_alg;
6739 return 1;
6740}
John Durkop07cc04a2020-11-16 22:08:34 -08006741#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006742
Gilles Peskine449bd832023-01-11 14:50:10 +01006743psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6744 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006745{
6746 psa_status_t status;
6747
Gilles Peskine449bd832023-01-11 14:50:10 +01006748 if (operation->alg != 0) {
6749 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006750 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006751
Gilles Peskine449bd832023-01-11 14:50:10 +01006752 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6753 return PSA_ERROR_INVALID_ARGUMENT;
6754 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6755#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6756 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6757 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6758 status = psa_key_agreement_try_support(ka_alg);
6759 if (status != PSA_SUCCESS) {
6760 return status;
6761 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006762 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6763 return PSA_ERROR_INVALID_ARGUMENT;
6764 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006765 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6766#else
6767 return PSA_ERROR_NOT_SUPPORTED;
6768#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6769 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6770#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6771 status = psa_key_derivation_setup_kdf(operation, alg);
6772#else
6773 return PSA_ERROR_NOT_SUPPORTED;
6774#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6775 } else {
6776 return PSA_ERROR_INVALID_ARGUMENT;
6777 }
6778
6779 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006780 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006781 }
6782 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006783}
6784
Przemek Stekiel69c46792022-06-10 12:59:51 +02006785#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006786static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6787 psa_algorithm_t kdf_alg,
6788 psa_key_derivation_step_t step,
6789 const uint8_t *data,
6790 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006791{
Gilles Peskine449bd832023-01-11 14:50:10 +01006792 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006793 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006794 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006795 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006796#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6798 return PSA_ERROR_INVALID_ARGUMENT;
6799 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006800#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006801 if (hkdf->state != HKDF_STATE_INIT) {
6802 return PSA_ERROR_BAD_STATE;
6803 } else {
6804 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6805 hash_alg,
6806 data, data_length);
6807 if (status != PSA_SUCCESS) {
6808 return status;
6809 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006810 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006811 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006812 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006813 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006814#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006815 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006816 /* We shouldn't be in different state as HKDF_EXPAND only allows
6817 * two inputs: SECRET (this case) and INFO which does not modify
6818 * the state. It could happen only if the hkdf
6819 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006820 if (hkdf->state != HKDF_STATE_INIT) {
6821 return PSA_ERROR_BAD_STATE;
6822 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006823
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006824 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006825 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6826 return PSA_ERROR_INVALID_ARGUMENT;
6827 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006828
Gilles Peskine449bd832023-01-11 14:50:10 +01006829 memcpy(hkdf->prk, data, data_length);
6830 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006831#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006832 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006833 /* HKDF: If no salt was provided, use an empty salt.
6834 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006835 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006836#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006837 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6838 return PSA_ERROR_BAD_STATE;
6839 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006840#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006841 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6842 hash_alg,
6843 NULL, 0);
6844 if (status != PSA_SUCCESS) {
6845 return status;
6846 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006847 hkdf->state = HKDF_STATE_STARTED;
6848 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006849 if (hkdf->state != HKDF_STATE_STARTED) {
6850 return PSA_ERROR_BAD_STATE;
6851 }
6852 status = psa_mac_update(&hkdf->hmac,
6853 data, data_length);
6854 if (status != PSA_SUCCESS) {
6855 return status;
6856 }
6857 status = psa_mac_sign_finish(&hkdf->hmac,
6858 hkdf->prk,
6859 sizeof(hkdf->prk),
6860 &data_length);
6861 if (status != PSA_SUCCESS) {
6862 return status;
6863 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006864 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006865
Gilles Peskine2b522db2019-04-12 15:11:49 +02006866 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006867 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006868#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006869 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006870 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006871 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006872 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006873 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006874#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006875 {
6876 /* Block 0 is empty, and the next block will be
6877 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006878 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006879 }
6880
Gilles Peskine449bd832023-01-11 14:50:10 +01006881 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006882 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006883#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006884 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6885 return PSA_ERROR_INVALID_ARGUMENT;
6886 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006887#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006888#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006889 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6890 hkdf->state == HKDF_STATE_INIT) {
6891 return PSA_ERROR_BAD_STATE;
6892 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006893#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006894 if (hkdf->state == HKDF_STATE_OUTPUT) {
6895 return PSA_ERROR_BAD_STATE;
6896 }
6897 if (hkdf->info_set) {
6898 return PSA_ERROR_BAD_STATE;
6899 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006900 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006901 if (data_length != 0) {
6902 hkdf->info = mbedtls_calloc(1, data_length);
6903 if (hkdf->info == NULL) {
6904 return PSA_ERROR_INSUFFICIENT_MEMORY;
6905 }
6906 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006907 }
6908 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006909 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006910 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006911 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006912 }
6913}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006914#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006915
John Durkop07cc04a2020-11-16 22:08:34 -08006916#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6917 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006918static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6919 const uint8_t *data,
6920 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006921{
Gilles Peskine449bd832023-01-11 14:50:10 +01006922 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6923 return PSA_ERROR_BAD_STATE;
6924 }
Janos Follathf08e2652019-06-13 09:05:41 +01006925
Gilles Peskine449bd832023-01-11 14:50:10 +01006926 if (data_length != 0) {
6927 prf->seed = mbedtls_calloc(1, data_length);
6928 if (prf->seed == NULL) {
6929 return PSA_ERROR_INSUFFICIENT_MEMORY;
6930 }
Janos Follathf08e2652019-06-13 09:05:41 +01006931
Gilles Peskine449bd832023-01-11 14:50:10 +01006932 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006933 prf->seed_length = data_length;
6934 }
Janos Follathf08e2652019-06-13 09:05:41 +01006935
Gilles Peskine43f958b2020-12-13 14:55:14 +01006936 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006937
Gilles Peskine449bd832023-01-11 14:50:10 +01006938 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006939}
6940
Gilles Peskine449bd832023-01-11 14:50:10 +01006941static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6942 const uint8_t *data,
6943 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006944{
Gilles Peskine449bd832023-01-11 14:50:10 +01006945 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6946 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6947 return PSA_ERROR_BAD_STATE;
6948 }
Janos Follath81550542019-06-13 14:26:34 +01006949
Gilles Peskine449bd832023-01-11 14:50:10 +01006950 if (data_length != 0) {
6951 prf->secret = mbedtls_calloc(1, data_length);
6952 if (prf->secret == NULL) {
6953 return PSA_ERROR_INSUFFICIENT_MEMORY;
6954 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006955
Gilles Peskine449bd832023-01-11 14:50:10 +01006956 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006957 prf->secret_length = data_length;
6958 }
Janos Follath81550542019-06-13 14:26:34 +01006959
Gilles Peskine43f958b2020-12-13 14:55:14 +01006960 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006961
Gilles Peskine449bd832023-01-11 14:50:10 +01006962 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006963}
6964
Gilles Peskine449bd832023-01-11 14:50:10 +01006965static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6966 const uint8_t *data,
6967 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006968{
Gilles Peskine449bd832023-01-11 14:50:10 +01006969 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6970 return PSA_ERROR_BAD_STATE;
6971 }
Janos Follath63028dd2019-06-13 09:15:47 +01006972
Gilles Peskine449bd832023-01-11 14:50:10 +01006973 if (data_length != 0) {
6974 prf->label = mbedtls_calloc(1, data_length);
6975 if (prf->label == NULL) {
6976 return PSA_ERROR_INSUFFICIENT_MEMORY;
6977 }
Janos Follath63028dd2019-06-13 09:15:47 +01006978
Gilles Peskine449bd832023-01-11 14:50:10 +01006979 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006980 prf->label_length = data_length;
6981 }
Janos Follath63028dd2019-06-13 09:15:47 +01006982
Gilles Peskine43f958b2020-12-13 14:55:14 +01006983 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006984
Gilles Peskine449bd832023-01-11 14:50:10 +01006985 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006986}
6987
Gilles Peskine449bd832023-01-11 14:50:10 +01006988static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6989 psa_key_derivation_step_t step,
6990 const uint8_t *data,
6991 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006992{
Gilles Peskine449bd832023-01-11 14:50:10 +01006993 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006994 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006995 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006996 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006997 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006998 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006999 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01007000 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007001 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01007002 }
7003}
John Durkop07cc04a2020-11-16 22:08:34 -08007004#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
7005 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
7006
7007#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
7008static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
7009 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08007010 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007011 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08007012{
7013 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007014 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
7015 4 + data_length + prf->other_secret_length :
7016 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08007017
Gilles Peskine449bd832023-01-11 14:50:10 +01007018 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
7019 return PSA_ERROR_INVALID_ARGUMENT;
7020 }
John Durkop07cc04a2020-11-16 22:08:34 -08007021
Gilles Peskine449bd832023-01-11 14:50:10 +01007022 uint8_t *pms = mbedtls_calloc(1, pms_len);
7023 if (pms == NULL) {
7024 return PSA_ERROR_INSUFFICIENT_MEMORY;
7025 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02007026 uint8_t *cur = pms;
7027
7028 /* pure-PSK:
7029 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08007030 *
7031 * The premaster secret is formed as follows: if the PSK is N octets
7032 * long, concatenate a uint16 with the value N, N zero octets, a second
7033 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02007034 *
7035 * mixed-PSK:
7036 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
7037 * follows: concatenate a uint16 with the length of the other secret,
7038 * the other secret itself, uint16 with the length of PSK, and the
7039 * PSK itself.
7040 * For details please check:
7041 * - RFC 4279, Section 4 for the definition of RSA-PSK,
7042 * - RFC 4279, Section 3 for the definition of DHE-PSK,
7043 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08007044 */
7045
Gilles Peskine449bd832023-01-11 14:50:10 +01007046 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
7047 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
7048 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
7049 if (prf->other_secret_length != 0) {
7050 memcpy(cur, prf->other_secret, prf->other_secret_length);
7051 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02007052 cur += prf->other_secret_length;
7053 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007054 } else {
7055 *cur++ = MBEDTLS_BYTE_1(data_length);
7056 *cur++ = MBEDTLS_BYTE_0(data_length);
7057 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02007058 cur += data_length;
7059 }
7060
Gilles Peskine449bd832023-01-11 14:50:10 +01007061 *cur++ = MBEDTLS_BYTE_1(data_length);
7062 *cur++ = MBEDTLS_BYTE_0(data_length);
7063 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08007064 cur += data_length;
7065
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007066 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08007067
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01007068 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01007069 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08007070}
Janos Follath6660f0e2019-06-17 08:44:03 +01007071
Przemek Stekiele47201b2022-04-19 13:53:28 +02007072static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
7073 psa_tls12_prf_key_derivation_t *prf,
7074 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007075 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02007076{
Gilles Peskine449bd832023-01-11 14:50:10 +01007077 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
7078 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02007079 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007080
7081 if (data_length != 0) {
7082 prf->other_secret = mbedtls_calloc(1, data_length);
7083 if (prf->other_secret == NULL) {
7084 return PSA_ERROR_INSUFFICIENT_MEMORY;
7085 }
7086
7087 memcpy(prf->other_secret, data, data_length);
7088 prf->other_secret_length = data_length;
7089 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02007090 prf->other_secret_length = 0;
7091 }
7092
7093 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
7094
Gilles Peskine449bd832023-01-11 14:50:10 +01007095 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02007096}
7097
Janos Follath6660f0e2019-06-17 08:44:03 +01007098static psa_status_t psa_tls12_prf_psk_to_ms_input(
7099 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01007100 psa_key_derivation_step_t step,
7101 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007102 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01007103{
Gilles Peskine449bd832023-01-11 14:50:10 +01007104 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02007105 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007106 return psa_tls12_prf_psk_to_ms_set_key(prf,
7107 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02007108 break;
7109 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007110 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
7111 data,
7112 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02007113 break;
7114 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007115 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02007116 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01007117
Przemek Stekiele47201b2022-04-19 13:53:28 +02007118 }
Janos Follath6660f0e2019-06-17 08:44:03 +01007119}
John Durkop07cc04a2020-11-16 22:08:34 -08007120#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007121
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007122#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
7123static psa_status_t psa_tls12_ecjpake_to_pms_input(
7124 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04007125 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007126 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007127 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007128{
Gilles Peskine449bd832023-01-11 14:50:10 +01007129 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
7130 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
7131 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04007132 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007133
7134 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01007135 if (data[0] != 0x04) {
7136 return PSA_ERROR_INVALID_ARGUMENT;
7137 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007138
7139 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007140 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007141
Gilles Peskine449bd832023-01-11 14:50:10 +01007142 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007143}
7144#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307145
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307146#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307147static psa_status_t psa_pbkdf2_set_input_cost(
7148 psa_pbkdf2_key_derivation_t *pbkdf2,
7149 psa_key_derivation_step_t step,
7150 uint64_t data)
7151{
7152 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
7153 return PSA_ERROR_INVALID_ARGUMENT;
7154 }
7155
7156 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
7157 return PSA_ERROR_BAD_STATE;
7158 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307159
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05307160 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307161 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307162 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307163
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307164 if (data == 0) {
7165 return PSA_ERROR_INVALID_ARGUMENT;
7166 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05307167
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307168 pbkdf2->input_cost = data;
7169 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
7170
7171 return PSA_SUCCESS;
7172}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307173
7174static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
7175 const uint8_t *data,
7176 size_t data_length)
7177{
Gilles Peskineead17662023-08-20 22:02:51 +02007178 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
7179 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
7180 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
7181 /* Appending to existing salt. No state change. */
7182 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307183 return PSA_ERROR_BAD_STATE;
7184 }
7185
Gilles Peskineca57d782023-07-20 19:08:06 +02007186 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02007187 /* Appending an empty string, nothing to do. */
7188 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307189 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05307190
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307191 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
7192 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05307193 return PSA_ERROR_INSUFFICIENT_MEMORY;
7194 }
7195
Gilles Peskineead17662023-08-20 22:02:51 +02007196 if (pbkdf2->salt_length != 0) {
7197 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
7198 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307199 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05307200 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307201 mbedtls_free(pbkdf2->salt);
7202 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307203 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307204 return PSA_SUCCESS;
7205}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307206
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307207#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307208static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307209 const uint8_t *input,
7210 size_t input_len,
7211 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05307212 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307213{
7214 psa_status_t status = PSA_SUCCESS;
7215 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
Ryan Everett5d2e82f2024-02-07 17:24:59 +00007216 return psa_hash_compute(hash_alg, input, input_len, output,
7217 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
7218 } else if (input_len > 0) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307219 memcpy(output, input, input_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307220 }
Ryan Everett5d2e82f2024-02-07 17:24:59 +00007221 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307222 return status;
7223}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307224#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307225
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307226#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307227static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
7228 size_t input_len,
7229 uint8_t *output,
7230 size_t *output_len)
7231{
7232 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307233 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307234 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05307235 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307236 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
7237 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
7238 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307239 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05307240 * mac_size as the driver function sets mac_output_length = mac_size
7241 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307242 status = psa_driver_wrapper_mac_compute(&attributes,
7243 zeros, sizeof(zeros),
7244 PSA_ALG_CMAC, input, input_len,
7245 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307246 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
7247 128U,
7248 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307249 output_len);
7250 } else {
7251 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307252 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307253 }
7254 return status;
7255}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307256#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307257
7258static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307259 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307260 const uint8_t *data,
7261 size_t data_length)
7262{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307263 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307264 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
7265 return PSA_ERROR_BAD_STATE;
7266 }
7267
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307268#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307269 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
7270 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
7271 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
7272 pbkdf2->password,
7273 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307274 } else
7275#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
7276#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
7277 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307278 status = psa_pbkdf2_cmac_set_password(data, data_length,
7279 pbkdf2->password,
7280 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307281 } else
7282#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
7283 {
7284 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307285 }
7286
7287 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
7288
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307289 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307290}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307291
7292static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307293 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307294 psa_key_derivation_step_t step,
7295 const uint8_t *data,
7296 size_t data_length)
7297{
7298 switch (step) {
7299 case PSA_KEY_DERIVATION_INPUT_SALT:
7300 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
7301 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307302 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307303 default:
7304 return PSA_ERROR_INVALID_ARGUMENT;
7305 }
7306}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307307#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307308
Gilles Peskineb8965192019-09-24 16:21:10 +02007309/** Check whether the given key type is acceptable for the given
7310 * input step of a key derivation.
7311 *
7312 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
7313 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
7314 * Both secret and non-secret inputs can alternatively have the type
7315 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
7316 * that the input was passed as a buffer rather than via a key object.
7317 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02007318static int psa_key_derivation_check_input_type(
7319 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007320 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02007321{
Gilles Peskine449bd832023-01-11 14:50:10 +01007322 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007323 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007324 if (key_type == PSA_KEY_TYPE_DERIVE) {
7325 return PSA_SUCCESS;
7326 }
7327 if (key_type == PSA_KEY_TYPE_NONE) {
7328 return PSA_SUCCESS;
7329 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007330 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02007331 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007332 if (key_type == PSA_KEY_TYPE_DERIVE) {
7333 return PSA_SUCCESS;
7334 }
7335 if (key_type == PSA_KEY_TYPE_NONE) {
7336 return PSA_SUCCESS;
7337 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02007338 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007339 case PSA_KEY_DERIVATION_INPUT_LABEL:
7340 case PSA_KEY_DERIVATION_INPUT_SALT:
7341 case PSA_KEY_DERIVATION_INPUT_INFO:
7342 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01007343 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
7344 return PSA_SUCCESS;
7345 }
7346 if (key_type == PSA_KEY_TYPE_NONE) {
7347 return PSA_SUCCESS;
7348 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007349 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307350 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
7351 if (key_type == PSA_KEY_TYPE_PASSWORD) {
7352 return PSA_SUCCESS;
7353 }
7354 if (key_type == PSA_KEY_TYPE_DERIVE) {
7355 return PSA_SUCCESS;
7356 }
7357 if (key_type == PSA_KEY_TYPE_NONE) {
7358 return PSA_SUCCESS;
7359 }
7360 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007361 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007362 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007363}
7364
Janos Follathb80a94e2019-06-12 15:54:46 +01007365static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007366 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007367 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007368 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007369 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007370 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007371{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007372 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007373 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007374
Gilles Peskine449bd832023-01-11 14:50:10 +01007375 status = psa_key_derivation_check_input_type(step, key_type);
7376 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007377 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007378 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007379
Przemek Stekiel69c46792022-06-10 12:59:51 +02007380#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007381 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7382 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7383 step, data, data_length);
7384 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007385#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007386#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007387 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7388 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7389 step, data, data_length);
7390 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007391#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7392#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007393 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7394 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7395 step, data, data_length);
7396 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007397#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007398#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007399 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007400 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007401 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7402 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007403#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307404#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307405 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307406 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7407 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307408 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307409#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007410 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007411 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007412 (void) data;
7413 (void) data_length;
7414 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007415 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007416 }
7417
Gilles Peskine224b0d62019-09-23 18:13:17 +02007418exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007419 if (status != PSA_SUCCESS) {
7420 psa_key_derivation_abort(operation);
7421 }
7422 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007423}
7424
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307425static psa_status_t psa_key_derivation_input_integer_internal(
7426 psa_key_derivation_operation_t *operation,
7427 psa_key_derivation_step_t step,
7428 uint64_t value)
7429{
7430 psa_status_t status;
7431 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7432
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307433#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307434 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307435 status = psa_pbkdf2_set_input_cost(
7436 &operation->ctx.pbkdf2, step, value);
7437 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307438#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307439 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307440 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307441 (void) value;
7442 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307443 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307444 }
7445
7446 if (status != PSA_SUCCESS) {
7447 psa_key_derivation_abort(operation);
7448 }
7449 return status;
7450}
7451
Janos Follath51f4a0f2019-06-14 11:35:55 +01007452psa_status_t psa_key_derivation_input_bytes(
7453 psa_key_derivation_operation_t *operation,
7454 psa_key_derivation_step_t step,
Ryan Everettd1e398c2024-01-19 14:46:00 +00007455 const uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007457{
Ryan Everettd1e398c2024-01-19 14:46:00 +00007458 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7459 LOCAL_INPUT_DECLARE(data_external, data);
7460
7461 LOCAL_INPUT_ALLOC(data_external, data_length, data);
7462
7463 status = psa_key_derivation_input_internal(operation, step,
7464 PSA_KEY_TYPE_NONE,
7465 data, data_length);
David Horstmann4a48bec2024-03-13 15:42:31 +00007466#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Ryan Everettd1e398c2024-01-19 14:46:00 +00007467exit:
Ryan Everettb41c3c92024-01-25 11:56:35 +00007468#endif
Ryan Everettd1e398c2024-01-19 14:46:00 +00007469 LOCAL_INPUT_FREE(data_external, data);
7470 return status;
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007471}
7472
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307473psa_status_t psa_key_derivation_input_integer(
7474 psa_key_derivation_operation_t *operation,
7475 psa_key_derivation_step_t step,
7476 uint64_t value)
7477{
7478 return psa_key_derivation_input_integer_internal(operation, step, value);
7479}
7480
Janos Follath51f4a0f2019-06-14 11:35:55 +01007481psa_status_t psa_key_derivation_input_key(
7482 psa_key_derivation_operation_t *operation,
7483 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007484 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007485{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007486 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007487 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007488 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007489
Ronald Cron5c522922020-11-14 16:35:34 +01007490 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007491 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7492 if (status != PSA_SUCCESS) {
7493 psa_key_derivation_abort(operation);
7494 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007495 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007496
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307497 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7498 * permission to output to a key object. */
7499 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7500 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007501 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007502 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007503
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 status = psa_key_derivation_input_internal(operation,
7505 step, slot->attr.type,
7506 slot->key.data,
7507 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007508
Ryan Everett5ac6fa72024-02-14 17:11:36 +00007509 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007510
Gilles Peskine449bd832023-01-11 14:50:10 +01007511 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007512}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007513
7514
7515
7516/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007517/* Key agreement */
7518/****************************************************************/
7519
Gilles Peskine449bd832023-01-11 14:50:10 +01007520psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7521 const uint8_t *key_buffer,
7522 size_t key_buffer_size,
7523 psa_algorithm_t alg,
7524 const uint8_t *peer_key,
7525 size_t peer_key_length,
7526 uint8_t *shared_secret,
7527 size_t shared_secret_size,
7528 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007529{
Gilles Peskine449bd832023-01-11 14:50:10 +01007530 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007531#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007532 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007533 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7534 key_buffer_size, alg,
7535 peer_key, peer_key_length,
7536 shared_secret,
7537 shared_secret_size,
7538 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007539#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007540
7541#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7542 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007543 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007544 peer_key,
7545 peer_key_length,
7546 key_buffer,
7547 key_buffer_size,
7548 shared_secret,
7549 shared_secret_size,
7550 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007551#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7552
Gilles Peskine01d718c2018-09-18 12:01:02 +02007553 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007554 (void) attributes;
7555 (void) key_buffer;
7556 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007557 (void) peer_key;
7558 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007559 (void) shared_secret;
7560 (void) shared_secret_size;
7561 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007562 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007563 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007564}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007565
Aditya Deshpande17845b82022-10-13 17:21:01 +01007566/** Internal function for raw key agreement
7567 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007568 * to the driver's implementation if a driver is present.
7569 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007570 * (psa_key_agreement_raw_builtin).
7571 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007572static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7573 psa_key_slot_t *private_key,
7574 const uint8_t *peer_key,
7575 size_t peer_key_length,
7576 uint8_t *shared_secret,
7577 size_t shared_secret_size,
7578 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007579{
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7581 return PSA_ERROR_NOT_SUPPORTED;
7582 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007583
Gilles Peskine7a5d9202024-02-28 01:18:23 +01007584 return psa_driver_wrapper_key_agreement(&private_key->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01007585 private_key->key.data,
7586 private_key->key.bytes, alg,
7587 peer_key, peer_key_length,
7588 shared_secret,
7589 shared_secret_size,
7590 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007591}
7592
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007593/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007594 * to potentially free embedded data structures and wipe confidential data.
7595 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007596static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7597 psa_key_derivation_step_t step,
7598 psa_key_slot_t *private_key,
7599 const uint8_t *peer_key,
7600 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007601{
7602 psa_status_t status;
Moritz Fischer967f8cd2024-03-02 00:55:06 +00007603 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE] = { 0 };
Gilles Peskine01d718c2018-09-18 12:01:02 +02007604 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007605 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007606
7607 /* Step 1: run the secret agreement algorithm to generate the shared
7608 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007609 status = psa_key_agreement_raw_internal(ka_alg,
7610 private_key,
7611 peer_key, peer_key_length,
7612 shared_secret,
7613 sizeof(shared_secret),
7614 &shared_secret_length);
7615 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007616 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007617 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007618
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007619 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007620 * the shared secret. A shared secret is permitted wherever a key
7621 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007622 status = psa_key_derivation_input_internal(operation, step,
7623 PSA_KEY_TYPE_DERIVE,
7624 shared_secret,
7625 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007626exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007627 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7628 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007629}
7630
Gilles Peskine449bd832023-01-11 14:50:10 +01007631psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7632 psa_key_derivation_step_t step,
7633 mbedtls_svc_key_id_t private_key,
Thomas Daubney9739ac02024-02-15 13:15:47 +00007634 const uint8_t *peer_key_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007635 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007636{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007637 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007638 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007639 psa_key_slot_t *slot;
Thomas Daubney9739ac02024-02-15 13:15:47 +00007640 LOCAL_INPUT_DECLARE(peer_key_external, peer_key);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007641
Gilles Peskine449bd832023-01-11 14:50:10 +01007642 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7643 return PSA_ERROR_INVALID_ARGUMENT;
7644 }
Ronald Cron5c522922020-11-14 16:35:34 +01007645 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007646 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7647 if (status != PSA_SUCCESS) {
7648 return status;
7649 }
Thomas Daubney9739ac02024-02-15 13:15:47 +00007650
Thomas Daubney692fb3c2024-03-12 16:20:41 +00007651 LOCAL_INPUT_ALLOC(peer_key_external, peer_key_length, peer_key);
Gilles Peskine449bd832023-01-11 14:50:10 +01007652 status = psa_key_agreement_internal(operation, step,
7653 slot,
7654 peer_key, peer_key_length);
Thomas Daubney9739ac02024-02-15 13:15:47 +00007655
David Horstmann4a48bec2024-03-13 15:42:31 +00007656#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney9739ac02024-02-15 13:15:47 +00007657exit:
Thomas Daubney50f58fc2024-02-15 14:24:03 +00007658#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007659 if (status != PSA_SUCCESS) {
7660 psa_key_derivation_abort(operation);
7661 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007662 /* If a private key has been added as SECRET, we allow the derived
7663 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007664 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007665 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007666 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007667 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007668
Ryan Everett5ac6fa72024-02-14 17:11:36 +00007669 unlock_status = psa_unregister_read_under_mutex(slot);
Thomas Daubney9739ac02024-02-15 13:15:47 +00007670 LOCAL_INPUT_FREE(peer_key_external, peer_key);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007671
Gilles Peskine449bd832023-01-11 14:50:10 +01007672 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007673}
7674
Gilles Peskine449bd832023-01-11 14:50:10 +01007675psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7676 mbedtls_svc_key_id_t private_key,
Thomas Daubney81899ab2024-02-15 12:57:26 +00007677 const uint8_t *peer_key_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007678 size_t peer_key_length,
Thomas Daubney81899ab2024-02-15 12:57:26 +00007679 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007680 size_t output_size,
7681 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007682{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007683 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007684 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007685 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007686 size_t expected_length;
Thomas Daubney81899ab2024-02-15 12:57:26 +00007687 LOCAL_INPUT_DECLARE(peer_key_external, peer_key);
7688 LOCAL_OUTPUT_DECLARE(output_external, output);
Thomas Daubney89d8c2a2024-02-21 11:16:16 +00007689 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007690
Gilles Peskine449bd832023-01-11 14:50:10 +01007691 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007692 status = PSA_ERROR_INVALID_ARGUMENT;
7693 goto exit;
7694 }
Ronald Cron5c522922020-11-14 16:35:34 +01007695 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007696 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7697 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007698 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007699 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007700
Gilles Peskine3e561302022-04-14 00:17:15 +02007701 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7702 * for the output size. The PSA specification only guarantees that this
7703 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7704 * but it might be nice to allow smaller buffers if the output fits.
7705 * At the time of writing this comment, with only ECDH implemented,
7706 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7707 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7708 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007709 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007710 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7711 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007712 status = PSA_ERROR_BUFFER_TOO_SMALL;
7713 goto exit;
7714 }
7715
Thomas Daubney81899ab2024-02-15 12:57:26 +00007716 LOCAL_INPUT_ALLOC(peer_key_external, peer_key_length, peer_key);
Gilles Peskine449bd832023-01-11 14:50:10 +01007717 status = psa_key_agreement_raw_internal(alg, slot,
7718 peer_key, peer_key_length,
7719 output, output_size,
7720 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007721
7722exit:
Thomas Daubney5390aca2024-02-22 11:06:04 +00007723 /* Check for successful allocation of output,
7724 * with an unsuccessful status. */
Thomas Daubney0576a6a2024-02-21 15:15:00 +00007725 if (output != NULL && status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007726 /* If an error happens and is not handled properly, the output
7727 * may be used as a key to protect sensitive data. Arrange for such
7728 * a key to be random, which is likely to result in decryption or
7729 * verification errors. This is better than filling the buffer with
7730 * some constant data such as zeros, which would result in the data
7731 * being protected with a reproducible, easily knowable key.
7732 */
David Horstmann6e99bb22024-02-06 15:27:49 +00007733 psa_generate_random_internal(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007734 *output_length = output_size;
7735 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007736
Thomas Daubney5390aca2024-02-22 11:06:04 +00007737 if (output == NULL) {
Thomas Daubney89d8c2a2024-02-21 11:16:16 +00007738 /* output allocation failed. */
7739 *output_length = 0;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007740 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007741
Ryan Everetta103ec92024-01-31 13:59:57 +00007742 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007743
Thomas Daubney81899ab2024-02-15 12:57:26 +00007744 LOCAL_INPUT_FREE(peer_key_external, peer_key);
7745 LOCAL_OUTPUT_FREE(output_external, output);
Gilles Peskine449bd832023-01-11 14:50:10 +01007746 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007747}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007748
7749
7750/****************************************************************/
7751/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007752/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007753
Gilles Peskine672a7712023-04-28 21:00:28 +02007754#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7755#include "entropy_poll.h"
7756#endif
7757
Gilles Peskine30524eb2020-11-13 17:02:26 +01007758/** Initialize the PSA random generator.
Paul Elliottd35dce62024-03-15 13:57:16 +00007759 *
7760 * Note: the mbedtls_threading_psa_rngdata_mutex should be held when calling
7761 * this function if mutexes are enabled.
Gilles Peskine30524eb2020-11-13 17:02:26 +01007762 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007763static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007764{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007765#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007766 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007767#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7768
Gilles Peskine30524eb2020-11-13 17:02:26 +01007769 /* Set default configuration if
7770 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007771 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007772 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007773 }
7774 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007775 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007776 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007777
Gilles Peskine449bd832023-01-11 14:50:10 +01007778 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007779#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7780 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7781 /* The PSA entropy injection feature depends on using NV seed as an entropy
7782 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007783 mbedtls_entropy_add_source(&rng->entropy,
7784 mbedtls_nv_seed_poll, NULL,
7785 MBEDTLS_ENTROPY_BLOCK_SIZE,
7786 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007787#endif
7788
Valerio Setti061d4e42024-02-26 12:52:44 +01007789 mbedtls_psa_drbg_init(&rng->drbg);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007790#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007791}
7792
7793/** Deinitialize the PSA random generator.
Paul Elliottd35dce62024-03-15 13:57:16 +00007794 *
7795 * Note: the mbedtls_threading_psa_rngdata_mutex should be held when calling
7796 * this function if mutexes are enabled.
Gilles Peskine30524eb2020-11-13 17:02:26 +01007797 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007798static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007799{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007800#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007801 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007802#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti061d4e42024-02-26 12:52:44 +01007803 mbedtls_psa_drbg_free(&rng->drbg);
Gilles Peskine449bd832023-01-11 14:50:10 +01007804 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007805#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007806}
7807
7808/** Seed the PSA random generator.
7809 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007810static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007811{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007812#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7813 /* Do nothing: the external RNG seeds itself. */
7814 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007815 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007816#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007817 const unsigned char drbg_seed[] = "PSA";
Valerio Setti061d4e42024-02-26 12:52:44 +01007818 int ret = mbedtls_psa_drbg_seed(&rng->drbg, &rng->entropy,
Gilles Peskine449bd832023-01-11 14:50:10 +01007819 drbg_seed, sizeof(drbg_seed) - 1);
7820 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007821#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007822}
7823
David Horstmann6e99bb22024-02-06 15:27:49 +00007824psa_status_t psa_generate_random(uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007825 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007826{
David Horstmann6e99bb22024-02-06 15:27:49 +00007827 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007828
David Horstmann6e99bb22024-02-06 15:27:49 +00007829 LOCAL_OUTPUT_DECLARE(output_external, output);
7830 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007831
David Horstmann6e99bb22024-02-06 15:27:49 +00007832 status = psa_generate_random_internal(output, output_size);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007833
David Horstmann4a48bec2024-03-13 15:42:31 +00007834#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
David Horstmann6e99bb22024-02-06 15:27:49 +00007835exit:
David Horstmanne097bbd2024-02-28 14:17:10 +00007836#endif
David Horstmann6e99bb22024-02-06 15:27:49 +00007837 LOCAL_OUTPUT_FREE(output_external, output);
7838 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007839}
7840
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007841#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007842psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7843 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007844{
Paul Elliott600472b2024-02-23 17:26:58 +00007845 if (psa_get_initialized()) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007846 return PSA_ERROR_NOT_PERMITTED;
7847 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007848
Gilles Peskine449bd832023-01-11 14:50:10 +01007849 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7850 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7851 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7852 return PSA_ERROR_INVALID_ARGUMENT;
7853 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007854
Gilles Peskine449bd832023-01-11 14:50:10 +01007855 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007856}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007857#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007858
Ronald Cron3772afe2021-02-08 16:10:05 +01007859/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007860 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007861 * \param type The key type
7862 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007863 *
7864 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007865 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007866 * \retval #PSA_ERROR_INVALID_ARGUMENT
7867 * The size in bits of the key is not valid.
7868 * \retval #PSA_ERROR_NOT_SUPPORTED
7869 * The type and/or the size in bits of the key or the combination of
7870 * the two is not supported.
7871 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007872static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007873 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007874{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007875 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007876
Gilles Peskine449bd832023-01-11 14:50:10 +01007877 if (key_type_is_raw_bytes(type)) {
7878 status = psa_validate_unstructured_key_bit_size(type, bits);
7879 if (status != PSA_SUCCESS) {
7880 return status;
7881 }
7882 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007883#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007884 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7885 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7886 return PSA_ERROR_NOT_SUPPORTED;
7887 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007888 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007889 return PSA_ERROR_NOT_SUPPORTED;
7890 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007891
Ronald Cron01b2aba2020-10-05 09:42:02 +02007892 /* Accept only byte-aligned keys, for the same reasons as
7893 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007894 if (bits % 8 != 0) {
7895 return PSA_ERROR_NOT_SUPPORTED;
7896 }
7897 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007898#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007899
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007900#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007901 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007902 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007903 return PSA_SUCCESS;
7904 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007905#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007906
Valerio Settia55f0422023-07-10 15:34:41 +02007907#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007908 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007909 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007910 return PSA_ERROR_NOT_SUPPORTED;
7911 }
7912 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007913#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007914 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007915 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007916 }
7917
Gilles Peskine449bd832023-01-11 14:50:10 +01007918 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007919}
7920
Ronald Cron55ed0592020-10-05 10:30:40 +02007921psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007922 const psa_key_attributes_t *attributes,
Gilles Peskinef36d7852024-06-06 21:11:44 +02007923 const psa_custom_key_parameters_t *custom,
7924 const uint8_t *custom_data,
7925 size_t custom_data_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01007926 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007927{
7928 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f107ae2024-02-28 01:26:46 +01007929 psa_key_type_t type = attributes->type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007930
Gilles Peskine7a18f962024-02-12 16:48:11 +01007931 /* Only used for RSA */
Gilles Peskinef36d7852024-06-06 21:11:44 +02007932 (void) custom;
7933 (void) custom_data;
7934 (void) custom_data_length;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007935
Gilles Peskine449bd832023-01-11 14:50:10 +01007936 if (key_type_is_raw_bytes(type)) {
David Horstmann93fa4e12024-03-12 15:02:28 +00007937 status = psa_generate_random_internal(key_buffer, key_buffer_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007938 if (status != PSA_SUCCESS) {
7939 return status;
7940 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007941
David Brown12ca5032021-02-11 11:02:00 -07007942#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007943 if (type == PSA_KEY_TYPE_DES) {
7944 psa_des_set_key_parity(key_buffer, key_buffer_size);
7945 }
David Brown8107e312021-02-12 08:08:46 -07007946#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007947 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007948
Valerio Setti76df8c12023-07-11 14:11:28 +02007949#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007950 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7951 return mbedtls_psa_rsa_generate_key(attributes,
Gilles Peskinef36d7852024-06-06 21:11:44 +02007952 custom_data, custom_data_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01007953 key_buffer,
7954 key_buffer_size,
7955 key_buffer_length);
7956 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007957#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007958
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007959#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007960 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7961 return mbedtls_psa_ecp_generate_key(attributes,
7962 key_buffer,
7963 key_buffer_size,
7964 key_buffer_length);
7965 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007966#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007967
Valerio Settia55f0422023-07-10 15:34:41 +02007968#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007969 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7970 return mbedtls_psa_ffdh_generate_key(attributes,
7971 key_buffer,
7972 key_buffer_size,
7973 key_buffer_length);
7974 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007975#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007976 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007977 (void) key_buffer_length;
7978 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007979 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007980
Gilles Peskine449bd832023-01-11 14:50:10 +01007981 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007982}
Darryl Green0c6575a2018-11-07 16:05:30 +00007983
Gilles Peskinef36d7852024-06-06 21:11:44 +02007984psa_status_t psa_generate_key_custom(const psa_key_attributes_t *attributes,
7985 const psa_custom_key_parameters_t *custom,
7986 const uint8_t *custom_data,
7987 size_t custom_data_length,
7988 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007989{
7990 psa_status_t status;
7991 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007992 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007993 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007994
Ronald Cron81709fc2020-11-14 12:10:32 +01007995 *key = MBEDTLS_SVC_KEY_ID_INIT;
7996
Gilles Peskine0f84d622019-09-12 19:03:13 +02007997 /* Reject any attempt to create a zero-length key so that we don't
7998 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007999 if (psa_get_key_bits(attributes) == 0) {
8000 return PSA_ERROR_INVALID_ARGUMENT;
8001 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02008002
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02008003 /* Reject any attempt to create a public key. */
Gilles Peskine2f107ae2024-02-28 01:26:46 +01008004 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008005 return PSA_ERROR_INVALID_ARGUMENT;
8006 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02008007
Gilles Peskine7a18f962024-02-12 16:48:11 +01008008#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine2f107ae2024-02-28 01:26:46 +01008009 if (attributes->type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
Gilles Peskinef36d7852024-06-06 21:11:44 +02008010 if (custom->flags != 0) {
Gilles Peskine7a18f962024-02-12 16:48:11 +01008011 return PSA_ERROR_INVALID_ARGUMENT;
8012 }
8013 } else
8014#endif
Gilles Peskine52504f82024-06-20 17:19:58 +02008015 if (!psa_custom_key_parameters_are_default(custom, custom_data_length)) {
Ronald Cron81709fc2020-11-14 12:10:32 +01008016 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine11792082019-08-06 18:36:36 +02008017 }
8018
Gilles Peskine449bd832023-01-11 14:50:10 +01008019 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
8020 &slot, &driver);
8021 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02008022 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008023 }
Gilles Peskine11792082019-08-06 18:36:36 +02008024
Ronald Cron977c2472020-10-13 08:32:21 +02008025 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05308026 * storage ( thus not in the case of generating a key in a secure element
8027 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
8028 * buffer to hold the generated key material. */
Valerio Setti70fa89c2024-08-14 05:12:45 +02008029 if (slot->key.bytes == 0) {
Gilles Peskine2f107ae2024-02-28 01:26:46 +01008030 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->lifetime) ==
Gilles Peskine449bd832023-01-11 14:50:10 +01008031 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01008032 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine2f107ae2024-02-28 01:26:46 +01008033 attributes->type, attributes->bits);
Gilles Peskine449bd832023-01-11 14:50:10 +01008034 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01008035 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008036 }
Ronald Cron3772afe2021-02-08 16:10:05 +01008037
8038 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine2f107ae2024-02-28 01:26:46 +01008039 attributes->type,
8040 attributes->bits);
Gilles Peskine449bd832023-01-11 14:50:10 +01008041 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02008042 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01008043 attributes, &key_buffer_size);
8044 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01008045 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008046 }
Ronald Cron977c2472020-10-13 08:32:21 +02008047 }
Ronald Cron977c2472020-10-13 08:32:21 +02008048
Gilles Peskine449bd832023-01-11 14:50:10 +01008049 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
8050 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02008051 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008052 }
Ronald Cron977c2472020-10-13 08:32:21 +02008053 }
8054
Gilles Peskine449bd832023-01-11 14:50:10 +01008055 status = psa_driver_wrapper_generate_key(attributes,
Gilles Peskinef36d7852024-06-06 21:11:44 +02008056 custom,
8057 custom_data, custom_data_length,
Gilles Peskine7a18f962024-02-12 16:48:11 +01008058 slot->key.data, slot->key.bytes,
8059 &slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01008060 if (status != PSA_SUCCESS) {
8061 psa_remove_key_data_from_memory(slot);
8062 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02008063
Gilles Peskine11792082019-08-06 18:36:36 +02008064exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008065 if (status == PSA_SUCCESS) {
8066 status = psa_finish_key_creation(slot, driver, key);
8067 }
8068 if (status != PSA_SUCCESS) {
8069 psa_fail_key_creation(slot, driver);
8070 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02008071
Gilles Peskine449bd832023-01-11 14:50:10 +01008072 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008073}
8074
Gilles Peskinef36d7852024-06-06 21:11:44 +02008075psa_status_t psa_generate_key_ext(const psa_key_attributes_t *attributes,
8076 const psa_key_production_parameters_t *params,
8077 size_t params_data_length,
8078 mbedtls_svc_key_id_t *key)
8079{
8080 return psa_generate_key_custom(
8081 attributes,
8082 (const psa_custom_key_parameters_t *) params,
8083 params->data, params_data_length,
8084 key);
8085}
8086
Gilles Peskinef0765fa2024-02-12 16:46:16 +01008087psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
8088 mbedtls_svc_key_id_t *key)
8089{
Gilles Peskinef36d7852024-06-06 21:11:44 +02008090 return psa_generate_key_custom(attributes,
8091 &default_custom_production,
8092 NULL, 0,
8093 key);
Gilles Peskinef0765fa2024-02-12 16:46:16 +01008094}
8095
Gilles Peskinee59236f2018-01-27 23:32:46 +01008096/****************************************************************/
8097/* Module setup */
8098/****************************************************************/
8099
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01008100#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01008101psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01008102 void (* entropy_init)(mbedtls_entropy_context *ctx),
8103 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01008104{
Paul Elliott8e151532024-02-23 17:35:29 +00008105 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8106
8107#if defined(MBEDTLS_THREADING_C)
8108 mbedtls_mutex_lock(&mbedtls_threading_psa_rngdata_mutex);
8109#endif /* defined(MBEDTLS_THREADING_C) */
8110
Gilles Peskine449bd832023-01-11 14:50:10 +01008111 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
Paul Elliott8e151532024-02-23 17:35:29 +00008112 status = PSA_ERROR_BAD_STATE;
8113 } else {
8114 global_data.rng.entropy_init = entropy_init;
8115 global_data.rng.entropy_free = entropy_free;
8116 status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01008117 }
Paul Elliott8e151532024-02-23 17:35:29 +00008118
8119#if defined(MBEDTLS_THREADING_C)
8120 mbedtls_mutex_unlock(&mbedtls_threading_psa_rngdata_mutex);
8121#endif /* defined(MBEDTLS_THREADING_C) */
8122
8123 return status;
Gilles Peskine5e769522018-11-20 21:59:56 +01008124}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01008125#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01008126
Gilles Peskine449bd832023-01-11 14:50:10 +01008127void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01008128{
Paul Elliott47cee8e2024-03-08 21:38:02 +00008129
Paul Elliott600472b2024-02-23 17:26:58 +00008130#if defined(MBEDTLS_THREADING_C)
8131 mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex);
8132#endif /* defined(MBEDTLS_THREADING_C) */
8133
Paul Elliott47cee8e2024-03-08 21:38:02 +00008134 /* Nothing to do to free transaction. */
8135 if (global_data.initialized & PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED) {
8136 global_data.initialized &= ~PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED;
Valerio Setti83e0de82023-11-24 12:13:05 +01008137 }
Paul Elliott600472b2024-02-23 17:26:58 +00008138
Paul Elliott47cee8e2024-03-08 21:38:02 +00008139 if (global_data.initialized & PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS_INITIALIZED) {
8140 psa_wipe_all_key_slots();
8141 global_data.initialized &= ~PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS_INITIALIZED;
8142 }
Ronald Cron9ba76912021-04-10 16:57:30 +02008143
Paul Elliott600472b2024-02-23 17:26:58 +00008144#if defined(MBEDTLS_THREADING_C)
8145 mbedtls_mutex_unlock(&mbedtls_threading_psa_globaldata_mutex);
8146#endif /* defined(MBEDTLS_THREADING_C) */
8147
Paul Elliott47cee8e2024-03-08 21:38:02 +00008148#if defined(MBEDTLS_THREADING_C)
8149 mbedtls_mutex_lock(&mbedtls_threading_psa_rngdata_mutex);
8150#endif /* defined(MBEDTLS_THREADING_C) */
8151
Gilles Peskinec6b69072018-11-20 21:42:52 +01008152 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01008153 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01008154 }
Paul Elliott47cee8e2024-03-08 21:38:02 +00008155 global_data.rng_state = RNG_NOT_INITIALIZED;
8156 mbedtls_platform_zeroize(&global_data.rng, sizeof(global_data.rng));
8157
8158#if defined(MBEDTLS_THREADING_C)
8159 mbedtls_mutex_unlock(&mbedtls_threading_psa_rngdata_mutex);
8160#endif /* defined(MBEDTLS_THREADING_C) */
8161
8162#if defined(MBEDTLS_THREADING_C)
8163 mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex);
8164#endif /* defined(MBEDTLS_THREADING_C) */
Ronald Cron9ba76912021-04-10 16:57:30 +02008165
8166 /* Terminate drivers */
Paul Elliott47cee8e2024-03-08 21:38:02 +00008167 if (global_data.initialized & PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS_INITIALIZED) {
8168 psa_driver_wrapper_free();
8169 global_data.initialized &= ~PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS_INITIALIZED;
8170 }
8171
8172#if defined(MBEDTLS_THREADING_C)
8173 mbedtls_mutex_unlock(&mbedtls_threading_psa_globaldata_mutex);
8174#endif /* defined(MBEDTLS_THREADING_C) */
8175
Gilles Peskinee59236f2018-01-27 23:32:46 +01008176}
8177
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008178#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
8179/** Recover a transaction that was interrupted by a power failure.
8180 *
8181 * This function is called during initialization, before psa_crypto_init()
8182 * returns. If this function returns a failure status, the initialization
8183 * fails.
8184 */
8185static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01008186 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008187{
Gilles Peskine449bd832023-01-11 14:50:10 +01008188 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008189 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
8190 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008191 /* TODO - fall through to the failure case until this
8192 * is implemented.
8193 * https://github.com/ARMmbed/mbed-crypto/issues/218
8194 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008195 default:
8196 /* We found an unsupported transaction in the storage.
8197 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008198 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008199 }
8200}
8201#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
8202
Paul Elliott47cee8e2024-03-08 21:38:02 +00008203static psa_status_t mbedtls_psa_crypto_init_subsystem(mbedtls_psa_crypto_subsystem subsystem)
8204{
8205 psa_status_t status = PSA_SUCCESS;
8206 uint8_t driver_wrappers_initialized = 0;
8207
8208 switch (subsystem) {
8209 case PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS:
8210
8211#if defined(MBEDTLS_THREADING_C)
8212 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex));
8213#endif /* defined(MBEDTLS_THREADING_C) */
8214
8215 if (!(global_data.initialized & PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS_INITIALIZED)) {
8216 /* Init drivers */
8217 status = psa_driver_wrapper_init();
8218
8219 /* Drivers need shutdown regardless of startup errors. */
8220 global_data.initialized |= PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS_INITIALIZED;
8221
8222
8223 }
8224#if defined(MBEDTLS_THREADING_C)
8225 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_unlock(
8226 &mbedtls_threading_psa_globaldata_mutex));
8227#endif /* defined(MBEDTLS_THREADING_C) */
8228
8229 break;
8230
8231 case PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS:
8232
8233#if defined(MBEDTLS_THREADING_C)
8234 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex));
8235#endif /* defined(MBEDTLS_THREADING_C) */
8236
8237 if (!(global_data.initialized & PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS_INITIALIZED)) {
8238 status = psa_initialize_key_slots();
8239
8240 /* Need to wipe keys even if initialization fails. */
8241 global_data.initialized |= PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS_INITIALIZED;
8242
8243 }
8244#if defined(MBEDTLS_THREADING_C)
8245 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_unlock(
8246 &mbedtls_threading_psa_globaldata_mutex));
8247#endif /* defined(MBEDTLS_THREADING_C) */
8248
8249 break;
8250
8251 case PSA_CRYPTO_SUBSYSTEM_RNG:
8252
8253#if defined(MBEDTLS_THREADING_C)
8254 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex));
8255#endif /* defined(MBEDTLS_THREADING_C) */
8256
8257 driver_wrappers_initialized =
8258 (global_data.initialized & PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS_INITIALIZED);
8259
8260#if defined(MBEDTLS_THREADING_C)
8261 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_unlock(
8262 &mbedtls_threading_psa_globaldata_mutex));
8263#endif /* defined(MBEDTLS_THREADING_C) */
8264
8265 /* Need to use separate mutex here, as initialisation can require
8266 * testing of init flags, which requires locking the global data
8267 * mutex. */
8268#if defined(MBEDTLS_THREADING_C)
8269 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(&mbedtls_threading_psa_rngdata_mutex));
8270#endif /* defined(MBEDTLS_THREADING_C) */
8271
8272 /* Initialize and seed the random generator. */
8273 if (global_data.rng_state == RNG_NOT_INITIALIZED && driver_wrappers_initialized) {
8274 mbedtls_psa_random_init(&global_data.rng);
8275 global_data.rng_state = RNG_INITIALIZED;
8276
8277 status = mbedtls_psa_random_seed(&global_data.rng);
8278 if (status == PSA_SUCCESS) {
8279 global_data.rng_state = RNG_SEEDED;
8280 }
8281 }
8282
8283#if defined(MBEDTLS_THREADING_C)
8284 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_unlock(
8285 &mbedtls_threading_psa_rngdata_mutex));
8286#endif /* defined(MBEDTLS_THREADING_C) */
8287
Paul Elliott47cee8e2024-03-08 21:38:02 +00008288 break;
8289
8290 case PSA_CRYPTO_SUBSYSTEM_TRANSACTION:
8291
8292#if defined(MBEDTLS_THREADING_C)
8293 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex));
8294#endif /* defined(MBEDTLS_THREADING_C) */
8295
8296 if (!(global_data.initialized & PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED)) {
8297#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
8298 status = psa_crypto_load_transaction();
8299 if (status == PSA_SUCCESS) {
8300 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
8301 if (status == PSA_SUCCESS) {
8302 global_data.initialized |= PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED;
8303 }
8304 status = psa_crypto_stop_transaction();
8305 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
8306 /* There's no transaction to complete. It's all good. */
8307 global_data.initialized |= PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED;
8308 status = PSA_SUCCESS;
8309 }
8310#else /* defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS) */
8311 global_data.initialized |= PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED;
8312 status = PSA_SUCCESS;
8313#endif /* defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS) */
8314 }
8315
8316#if defined(MBEDTLS_THREADING_C)
8317 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_unlock(
8318 &mbedtls_threading_psa_globaldata_mutex));
8319#endif /* defined(MBEDTLS_THREADING_C) */
8320
8321 break;
8322
8323 default:
8324 status = PSA_ERROR_CORRUPTION_DETECTED;
8325 }
8326
8327 /* Exit label only required when using threading macros. */
8328#if defined(MBEDTLS_THREADING_C)
8329exit:
8330#endif /* defined(MBEDTLS_THREADING_C) */
8331
8332 return status;
8333}
8334
Gilles Peskine449bd832023-01-11 14:50:10 +01008335psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01008336{
Gilles Peskine66fb1262018-12-10 16:29:04 +01008337 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008338
Paul Elliott47cee8e2024-03-08 21:38:02 +00008339 /* Double initialization is explicitly allowed. Early out if everything is
8340 * done. */
8341 if (psa_get_initialized()) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008342 return PSA_SUCCESS;
8343 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01008344
Paul Elliott47cee8e2024-03-08 21:38:02 +00008345 status = mbedtls_psa_crypto_init_subsystem(PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS);
Valerio Setti402cfba2023-11-13 10:24:32 +01008346 if (status != PSA_SUCCESS) {
8347 goto exit;
8348 }
8349
Paul Elliott47cee8e2024-03-08 21:38:02 +00008350 status = mbedtls_psa_crypto_init_subsystem(PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS);
Gilles Peskine449bd832023-01-11 14:50:10 +01008351 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01008352 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008353 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01008354
Paul Elliott47cee8e2024-03-08 21:38:02 +00008355 status = mbedtls_psa_crypto_init_subsystem(PSA_CRYPTO_SUBSYSTEM_RNG);
8356 if (status != PSA_SUCCESS) {
8357 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02008358 }
Gilles Peskinefc762652019-07-22 19:30:34 +02008359
Paul Elliott47cee8e2024-03-08 21:38:02 +00008360 status = mbedtls_psa_crypto_init_subsystem(PSA_CRYPTO_SUBSYSTEM_TRANSACTION);
Gilles Peskinee59236f2018-01-27 23:32:46 +01008361
8362exit:
Paul Elliott600472b2024-02-23 17:26:58 +00008363
Gilles Peskine449bd832023-01-11 14:50:10 +01008364 if (status != PSA_SUCCESS) {
8365 mbedtls_psa_crypto_free();
8366 }
Paul Elliott47cee8e2024-03-08 21:38:02 +00008367
Gilles Peskine449bd832023-01-11 14:50:10 +01008368 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008369}
8370
Yanray Wangffc3c482023-07-11 12:01:04 +08008371#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008372psa_status_t psa_crypto_driver_pake_get_password_len(
8373 const psa_crypto_driver_pake_inputs_t *inputs,
8374 size_t *password_len)
8375{
8376 if (inputs->password_len == 0) {
8377 return PSA_ERROR_BAD_STATE;
8378 }
8379
8380 *password_len = inputs->password_len;
8381
8382 return PSA_SUCCESS;
8383}
8384
8385psa_status_t psa_crypto_driver_pake_get_password(
8386 const psa_crypto_driver_pake_inputs_t *inputs,
8387 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
8388{
8389 if (inputs->password_len == 0) {
8390 return PSA_ERROR_BAD_STATE;
8391 }
8392
8393 if (buffer_size < inputs->password_len) {
8394 return PSA_ERROR_BUFFER_TOO_SMALL;
8395 }
8396
8397 memcpy(buffer, inputs->password, inputs->password_len);
8398 *buffer_length = inputs->password_len;
8399
8400 return PSA_SUCCESS;
8401}
8402
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008403psa_status_t psa_crypto_driver_pake_get_user_len(
8404 const psa_crypto_driver_pake_inputs_t *inputs,
8405 size_t *user_len)
8406{
8407 if (inputs->user_len == 0) {
8408 return PSA_ERROR_BAD_STATE;
8409 }
8410
8411 *user_len = inputs->user_len;
8412
8413 return PSA_SUCCESS;
8414}
8415
8416psa_status_t psa_crypto_driver_pake_get_user(
8417 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008418 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008419{
8420 if (inputs->user_len == 0) {
8421 return PSA_ERROR_BAD_STATE;
8422 }
8423
Przemek Stekielc0e62502023-03-14 11:49:36 +01008424 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008425 return PSA_ERROR_BUFFER_TOO_SMALL;
8426 }
8427
Przemek Stekielc0e62502023-03-14 11:49:36 +01008428 memcpy(user_id, inputs->user, inputs->user_len);
8429 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008430
8431 return PSA_SUCCESS;
8432}
8433
8434psa_status_t psa_crypto_driver_pake_get_peer_len(
8435 const psa_crypto_driver_pake_inputs_t *inputs,
8436 size_t *peer_len)
8437{
8438 if (inputs->peer_len == 0) {
8439 return PSA_ERROR_BAD_STATE;
8440 }
8441
8442 *peer_len = inputs->peer_len;
8443
8444 return PSA_SUCCESS;
8445}
8446
8447psa_status_t psa_crypto_driver_pake_get_peer(
8448 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008449 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008450{
8451 if (inputs->peer_len == 0) {
8452 return PSA_ERROR_BAD_STATE;
8453 }
8454
Przemek Stekielc0e62502023-03-14 11:49:36 +01008455 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008456 return PSA_ERROR_BUFFER_TOO_SMALL;
8457 }
8458
Przemek Stekielc0e62502023-03-14 11:49:36 +01008459 memcpy(peer_id, inputs->peer, inputs->peer_len);
8460 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008461
8462 return PSA_SUCCESS;
8463}
8464
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008465psa_status_t psa_crypto_driver_pake_get_cipher_suite(
8466 const psa_crypto_driver_pake_inputs_t *inputs,
8467 psa_pake_cipher_suite_t *cipher_suite)
8468{
8469 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
8470 return PSA_ERROR_BAD_STATE;
8471 }
8472
8473 *cipher_suite = inputs->cipher_suite;
8474
8475 return PSA_SUCCESS;
8476}
8477
Neil Armstronga7d08c32022-06-01 18:21:20 +02008478psa_status_t psa_pake_setup(
8479 psa_pake_operation_t *operation,
8480 const psa_pake_cipher_suite_t *cipher_suite)
8481{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008482 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008483
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008484 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008485 status = PSA_ERROR_BAD_STATE;
8486 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008487 }
8488
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008489 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01008490 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008491 status = PSA_ERROR_INVALID_ARGUMENT;
8492 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008493 }
8494
Przemek Stekiel51eac532022-12-07 11:04:51 +01008495 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
8496
Przemek Stekiele12ed362022-12-21 12:54:46 +01008497 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01008498 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
8499 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008500 operation->data.inputs.cipher_suite = *cipher_suite;
8501
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008502#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008503 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008504 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01008505 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008506
David Horstmann16f01512023-06-14 17:21:07 +01008507 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01008508 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008509 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008510#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008511 {
8512 status = PSA_ERROR_NOT_SUPPORTED;
8513 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008514 }
8515
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008516 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
8517
Przemek Stekiel51eac532022-12-07 11:04:51 +01008518 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008519exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008520 psa_pake_abort(operation);
8521 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008522}
8523
8524psa_status_t psa_pake_set_password_key(
8525 psa_pake_operation_t *operation,
8526 mbedtls_svc_key_id_t password)
8527{
Neil Armstrong5ae60962022-09-15 11:29:46 +02008528 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01008529 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
8530 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008531 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008532
Przemek Stekiel51eac532022-12-07 11:04:51 +01008533 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008534 status = PSA_ERROR_BAD_STATE;
8535 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008536 }
8537
Przemek Stekiel6c764412022-11-22 14:05:12 +01008538 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
8539 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008540 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008541 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008542 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008543 }
8544
Gilles Peskine7a5d9202024-02-28 01:18:23 +01008545 type = psa_get_key_type(&slot->attr);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008546
Przemek Stekiel51eac532022-12-07 11:04:51 +01008547 if (type != PSA_KEY_TYPE_PASSWORD &&
8548 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8549 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008550 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008551 }
8552
Przemek Stekiel51eac532022-12-07 11:04:51 +01008553 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8554 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008555 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008556 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008557 }
8558
8559 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8560 operation->data.inputs.password_len = slot->key.bytes;
Gilles Peskine7fad3ef2024-02-28 01:08:27 +01008561 operation->data.inputs.attributes = slot->attr;
8562
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008563exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008564 if (status != PSA_SUCCESS) {
8565 psa_pake_abort(operation);
8566 }
Ryan Everettbbedfce2024-02-14 18:22:09 +00008567 unlock_status = psa_unregister_read_under_mutex(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008568 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008569}
8570
8571psa_status_t psa_pake_set_user(
8572 psa_pake_operation_t *operation,
David Horstmann4f534ae2024-01-22 17:35:59 +00008573 const uint8_t *user_id_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008574 size_t user_id_len)
8575{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008576 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
David Horstmann4f534ae2024-01-22 17:35:59 +00008577 LOCAL_INPUT_DECLARE(user_id_external, user_id);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008578
8579 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008580 status = PSA_ERROR_BAD_STATE;
8581 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008582 }
8583
Przemek Stekiel51eac532022-12-07 11:04:51 +01008584 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008585 status = PSA_ERROR_INVALID_ARGUMENT;
8586 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008587 }
8588
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008589 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008590 status = PSA_ERROR_BAD_STATE;
8591 goto exit;
8592 }
8593
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008594 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8595 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008596 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8597 goto exit;
8598 }
8599
David Horstmann4f534ae2024-01-22 17:35:59 +00008600 LOCAL_INPUT_ALLOC(user_id_external, user_id_len, user_id);
8601
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008602 memcpy(operation->data.inputs.user, user_id, user_id_len);
8603 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008604
David Horstmann4f534ae2024-01-22 17:35:59 +00008605 status = PSA_SUCCESS;
8606
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008607exit:
David Horstmann4f534ae2024-01-22 17:35:59 +00008608 LOCAL_INPUT_FREE(user_id_external, user_id);
8609 if (status != PSA_SUCCESS) {
8610 psa_pake_abort(operation);
8611 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008612 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008613}
8614
8615psa_status_t psa_pake_set_peer(
8616 psa_pake_operation_t *operation,
David Horstmann4f534ae2024-01-22 17:35:59 +00008617 const uint8_t *peer_id_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008618 size_t peer_id_len)
8619{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008620 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
David Horstmann4f534ae2024-01-22 17:35:59 +00008621 LOCAL_INPUT_DECLARE(peer_id_external, peer_id);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008622
8623 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008624 status = PSA_ERROR_BAD_STATE;
8625 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008626 }
8627
Przemek Stekiel51eac532022-12-07 11:04:51 +01008628 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008629 status = PSA_ERROR_INVALID_ARGUMENT;
8630 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008631 }
8632
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008633 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008634 status = PSA_ERROR_BAD_STATE;
8635 goto exit;
8636 }
8637
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008638 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8639 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008640 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8641 goto exit;
8642 }
8643
David Horstmann4f534ae2024-01-22 17:35:59 +00008644 LOCAL_INPUT_ALLOC(peer_id_external, peer_id_len, peer_id);
8645
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008646 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8647 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008648
David Horstmann4f534ae2024-01-22 17:35:59 +00008649 status = PSA_SUCCESS;
8650
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008651exit:
David Horstmann4f534ae2024-01-22 17:35:59 +00008652 LOCAL_INPUT_FREE(peer_id_external, peer_id);
8653 if (status != PSA_SUCCESS) {
8654 psa_pake_abort(operation);
8655 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008656 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008657}
8658
8659psa_status_t psa_pake_set_role(
8660 psa_pake_operation_t *operation,
8661 psa_pake_role_t role)
8662{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008663 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008664
Przemek Stekiel51eac532022-12-07 11:04:51 +01008665 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008666 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008667 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008668 }
8669
Przemek Stekiel09104b82023-03-06 14:11:51 +01008670 switch (operation->alg) {
8671#if defined(PSA_WANT_ALG_JPAKE)
8672 case PSA_ALG_JPAKE:
8673 if (role == PSA_PAKE_ROLE_NONE) {
8674 return PSA_SUCCESS;
8675 }
8676 status = PSA_ERROR_INVALID_ARGUMENT;
8677 break;
8678#endif
8679 default:
8680 (void) role;
8681 status = PSA_ERROR_NOT_SUPPORTED;
8682 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008683 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008684exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008685 psa_pake_abort(operation);
8686 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008687}
8688
David Horstmanne7f21e62023-05-12 18:17:21 +01008689/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008690#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008691static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008692 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008693{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008694 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008695 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008696 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008697
David Horstmann024e5c52023-06-14 15:48:21 +01008698 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008699 is_x1 = (stage->outputs < 1);
8700 } else {
8701 is_x1 = (stage->inputs < 1);
8702 }
8703
David Horstmann74a3d8c2023-06-14 18:28:19 +01008704 key_share_step = is_x1 ?
8705 PSA_JPAKE_X1_STEP_KEY_SHARE :
8706 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008707 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008708 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8709 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8710 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8711 } else {
8712 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008713 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008714 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008715}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008716#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008717
Przemek Stekiel2797d372022-12-22 11:19:22 +01008718static psa_status_t psa_pake_complete_inputs(
8719 psa_pake_operation_t *operation)
8720{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008721 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008722 /* Create copy of the inputs on stack as inputs share memory
8723 with the driver context which will be setup by the driver. */
8724 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008725
Przemek Stekielfde11282023-03-13 16:06:09 +01008726 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008727 return PSA_ERROR_BAD_STATE;
8728 }
8729
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008730 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008731 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8732 return PSA_ERROR_BAD_STATE;
8733 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008734 }
8735
Przemek Stekiel18620a32023-01-17 16:34:52 +01008736 /* Clear driver context */
8737 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8738
8739 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008740
8741 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008742 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008743
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008744 /* User and peer are translated to role. */
8745 mbedtls_free(inputs.user);
8746 mbedtls_free(inputs.peer);
8747
Przemek Stekiel2797d372022-12-22 11:19:22 +01008748 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008749#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008750 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008751 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008752 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008753#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008754 {
8755 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008756 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008757 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008758 return status;
8759}
8760
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008761#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008762static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008763 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008764 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008765 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008766{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008767 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8768 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8769 step != PSA_PAKE_STEP_ZK_PROOF) {
8770 return PSA_ERROR_INVALID_ARGUMENT;
8771 }
8772
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008773 psa_jpake_computation_stage_t *computation_stage =
8774 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008775
David Horstmann5da95602023-06-08 15:37:12 +01008776 if (computation_stage->round != PSA_JPAKE_FIRST &&
8777 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008778 return PSA_ERROR_BAD_STATE;
8779 }
8780
David Horstmanne7f21e62023-05-12 18:17:21 +01008781 /* Check that the step we are given is the one we were expecting */
8782 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008783 return PSA_ERROR_BAD_STATE;
8784 }
8785
David Horstmanne7f21e62023-05-12 18:17:21 +01008786 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8787 computation_stage->inputs == 0 &&
8788 computation_stage->outputs == 0) {
8789 /* Start of the round, so function decides whether we are inputting
8790 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008791 computation_stage->io_mode = io_mode;
8792 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008793 /* Middle of the round so the mode we are in must match the function
8794 * called by the user */
8795 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008796 }
8797
8798 return PSA_SUCCESS;
8799}
8800
David Horstmanne7f21e62023-05-12 18:17:21 +01008801static psa_status_t psa_jpake_epilogue(
8802 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008803 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008804{
David Horstmanne7f21e62023-05-12 18:17:21 +01008805 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008806 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008807
David Horstmanne7f21e62023-05-12 18:17:21 +01008808 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8809 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008810 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008811 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008812 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008813 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008814 }
8815 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008816 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008817 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008818 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008819 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008820 }
8821 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008822 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8823 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008824 /* End of a round, move to the next round */
8825 stage->inputs = 0;
8826 stage->outputs = 0;
8827 stage->round++;
8828 }
8829 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008830 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008831 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008832 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008833 return PSA_SUCCESS;
8834}
David Horstmanne7f21e62023-05-12 18:17:21 +01008835
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008836#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008837
Neil Armstronga7d08c32022-06-01 18:21:20 +02008838psa_status_t psa_pake_output(
8839 psa_pake_operation_t *operation,
8840 psa_pake_step_t step,
David Horstmannc75639d2024-01-22 17:56:39 +00008841 uint8_t *output_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008842 size_t output_size,
8843 size_t *output_length)
8844{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008845 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008846 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
David Horstmannc75639d2024-01-22 17:56:39 +00008847 LOCAL_OUTPUT_DECLARE(output_external, output);
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008848 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008849
8850 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008851 status = psa_pake_complete_inputs(operation);
8852 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008853 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008854 }
8855 }
8856
8857 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008858 status = PSA_ERROR_BAD_STATE;
8859 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008860 }
8861
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008862 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008863 status = PSA_ERROR_INVALID_ARGUMENT;
8864 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008865 }
8866
Przemek Stekiele12ed362022-12-21 12:54:46 +01008867 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008868#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008869 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008870 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008871 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008872 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008873 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008874 driver_step = convert_jpake_computation_stage_to_driver_step(
8875 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008876 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008877#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008878 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008879 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008880 status = PSA_ERROR_NOT_SUPPORTED;
8881 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008882 }
8883
David Horstmannc75639d2024-01-22 17:56:39 +00008884 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
8885
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008886 status = psa_driver_wrapper_pake_output(operation, driver_step,
8887 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008888
8889 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008890 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008891 }
8892
8893 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008894#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008895 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008896 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008897 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008898 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008899 }
8900 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008901#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008902 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008903 status = PSA_ERROR_NOT_SUPPORTED;
8904 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008905 }
8906
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008907exit:
David Horstmannc75639d2024-01-22 17:56:39 +00008908 LOCAL_OUTPUT_FREE(output_external, output);
8909 if (status != PSA_SUCCESS) {
8910 psa_pake_abort(operation);
8911 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008912 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008913}
8914
8915psa_status_t psa_pake_input(
8916 psa_pake_operation_t *operation,
8917 psa_pake_step_t step,
David Horstmannc75639d2024-01-22 17:56:39 +00008918 const uint8_t *input_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008919 size_t input_length)
8920{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008921 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008922 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008923 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8924 operation->primitive,
8925 step);
David Horstmannc75639d2024-01-22 17:56:39 +00008926 LOCAL_INPUT_DECLARE(input_external, input);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008927
8928 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008929 status = psa_pake_complete_inputs(operation);
8930 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008931 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008932 }
8933 }
8934
8935 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008936 status = PSA_ERROR_BAD_STATE;
8937 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008938 }
8939
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008940 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008941 status = PSA_ERROR_INVALID_ARGUMENT;
8942 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008943 }
8944
Przemek Stekiele12ed362022-12-21 12:54:46 +01008945 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008946#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008947 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008948 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008949 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008950 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008951 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008952 driver_step = convert_jpake_computation_stage_to_driver_step(
8953 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008954 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008955#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008956 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008957 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008958 status = PSA_ERROR_NOT_SUPPORTED;
8959 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008960 }
8961
David Horstmannc75639d2024-01-22 17:56:39 +00008962 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008963 status = psa_driver_wrapper_pake_input(operation, driver_step,
8964 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008965
8966 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008967 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008968 }
8969
8970 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008971#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008972 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008973 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008974 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008975 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008976 }
8977 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008978#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008979 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008980 status = PSA_ERROR_NOT_SUPPORTED;
8981 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008982 }
8983
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008984exit:
David Horstmannc75639d2024-01-22 17:56:39 +00008985 LOCAL_INPUT_FREE(input_external, input);
8986 if (status != PSA_SUCCESS) {
8987 psa_pake_abort(operation);
8988 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008989 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008990}
8991
8992psa_status_t psa_pake_get_implicit_key(
8993 psa_pake_operation_t *operation,
8994 psa_key_derivation_operation_t *output)
8995{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008996 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008997 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008998 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008999 size_t shared_key_len = 0;
9000
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01009001 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009002 status = PSA_ERROR_BAD_STATE;
9003 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02009004 }
9005
Przemek Stekiel4aa99402023-02-27 13:00:57 +01009006#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01009007 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009008 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01009009 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01009010 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009011 status = PSA_ERROR_BAD_STATE;
9012 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01009013 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01009014 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01009015#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01009016 {
9017 status = PSA_ERROR_NOT_SUPPORTED;
9018 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01009019 }
9020
Przemek Stekiel0c781802022-11-29 14:53:13 +01009021 status = psa_driver_wrapper_pake_get_implicit_key(operation,
9022 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01009023 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01009024 &shared_key_len);
9025
9026 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009027 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01009028 }
9029
9030 status = psa_key_derivation_input_bytes(output,
9031 PSA_KEY_DERIVATION_INPUT_SECRET,
9032 shared_key,
9033 shared_key_len);
9034
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01009035 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009036exit:
9037 abort_status = psa_pake_abort(operation);
9038 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02009039}
9040
9041psa_status_t psa_pake_abort(
9042 psa_pake_operation_t *operation)
9043{
Przemek Stekield69dca92023-01-31 19:59:20 +01009044 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01009045
Przemek Stekield69dca92023-01-31 19:59:20 +01009046 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01009047 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02009048 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01009049
Przemek Stekiel26c909d2023-02-28 12:34:03 +01009050 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
9051 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009052 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01009053 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01009054 }
9055 if (operation->data.inputs.user != NULL) {
9056 mbedtls_free(operation->data.inputs.user);
9057 }
9058 if (operation->data.inputs.peer != NULL) {
9059 mbedtls_free(operation->data.inputs.peer);
9060 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01009061 }
Przemek Stekield69dca92023-01-31 19:59:20 +01009062 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01009063
Przemek Stekield69dca92023-01-31 19:59:20 +01009064 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02009065}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01009066#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02009067
David Horstmann00d7a042023-12-07 18:39:17 +00009068/* Memory copying test hooks. These are called before input copy, after input
9069 * copy, before output copy and after output copy, respectively.
9070 * They are used by memory-poisoning tests to temporarily unpoison buffers
9071 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00009072#if defined(MBEDTLS_TEST_HOOKS)
9073void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
9074void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
9075void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
9076void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
9077#endif
David Horstmannfde97392023-10-30 20:29:43 +00009078
David Horstmann1b7279a2023-11-15 15:18:30 +00009079/** Copy from an input buffer to a local copy.
9080 *
9081 * \param[in] input Pointer to input buffer.
9082 * \param[in] input_len Length of the input buffer.
9083 * \param[out] input_copy Pointer to a local copy in which to store the input data.
9084 * \param[out] input_copy_len Length of the local copy buffer.
9085 * \return #PSA_SUCCESS, if the buffer was successfully
9086 * copied.
9087 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
9088 * copy is too small to hold contents of the
9089 * input buffer.
9090 */
9091MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00009092psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
9093 uint8_t *input_copy, size_t input_copy_len)
9094{
9095 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00009096 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00009097 }
9098
David Horstmann372b8bb2023-11-24 16:21:04 +00009099#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00009100 if (psa_input_pre_copy_hook != NULL) {
9101 psa_input_pre_copy_hook(input, input_len);
9102 }
David Horstmann372b8bb2023-11-24 16:21:04 +00009103#endif
9104
David Horstmann777e7412023-11-15 17:33:47 +00009105 if (input_len > 0) {
9106 memcpy(input_copy, input, input_len);
9107 }
David Horstmannfde97392023-10-30 20:29:43 +00009108
David Horstmann372b8bb2023-11-24 16:21:04 +00009109#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00009110 if (psa_input_post_copy_hook != NULL) {
9111 psa_input_post_copy_hook(input, input_len);
9112 }
David Horstmann372b8bb2023-11-24 16:21:04 +00009113#endif
9114
David Horstmannfde97392023-10-30 20:29:43 +00009115 return PSA_SUCCESS;
9116}
9117
David Horstmann1b7279a2023-11-15 15:18:30 +00009118/** Copy from a local output buffer into a user-supplied one.
9119 *
9120 * \param[in] output_copy Pointer to a local buffer containing the output.
9121 * \param[in] output_copy_len Length of the local buffer.
9122 * \param[out] output Pointer to user-supplied output buffer.
9123 * \param[out] output_len Length of the user-supplied output buffer.
9124 * \return #PSA_SUCCESS, if the buffer was successfully
9125 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00009126 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00009127 * user-supplied output buffer is too small to
9128 * hold the contents of the local buffer.
9129 */
9130MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00009131psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
9132 uint8_t *output, size_t output_len)
9133{
9134 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00009135 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00009136 }
David Horstmann777e7412023-11-15 17:33:47 +00009137
David Horstmann372b8bb2023-11-24 16:21:04 +00009138#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00009139 if (psa_output_pre_copy_hook != NULL) {
9140 psa_output_pre_copy_hook(output, output_len);
9141 }
David Horstmann372b8bb2023-11-24 16:21:04 +00009142#endif
9143
David Horstmann777e7412023-11-15 17:33:47 +00009144 if (output_copy_len > 0) {
9145 memcpy(output, output_copy, output_copy_len);
9146 }
9147
David Horstmann372b8bb2023-11-24 16:21:04 +00009148#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00009149 if (psa_output_post_copy_hook != NULL) {
9150 psa_output_post_copy_hook(output, output_len);
9151 }
David Horstmann372b8bb2023-11-24 16:21:04 +00009152#endif
9153
David Horstmann8978f5c2023-10-30 20:37:12 +00009154 return PSA_SUCCESS;
9155}
9156
David Horstmannf1734052023-11-20 17:15:32 +00009157psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
9158 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00009159{
9160 psa_status_t status;
9161
David Horstmann9db14482023-11-23 15:50:37 +00009162 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00009163
David Horstmannc5cc1c32023-11-15 18:11:26 +00009164 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00009165 return PSA_SUCCESS;
9166 }
9167
David Horstmannf1734052023-11-20 17:15:32 +00009168 local_input->buffer = mbedtls_calloc(input_len, 1);
9169 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00009170 /* Since we dealt with the zero-length case above, we know that
9171 * a NULL return value means a failure of allocation. */
9172 return PSA_ERROR_INSUFFICIENT_MEMORY;
9173 }
David Horstmannf1734052023-11-20 17:15:32 +00009174 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00009175
David Horstmannf1734052023-11-20 17:15:32 +00009176 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00009177
9178 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00009179 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00009180 if (status != PSA_SUCCESS) {
9181 goto error;
9182 }
9183
9184 return PSA_SUCCESS;
9185
9186error:
David Horstmannf1734052023-11-20 17:15:32 +00009187 mbedtls_free(local_input->buffer);
9188 local_input->buffer = NULL;
9189 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00009190 return status;
9191}
9192
David Horstmannf1734052023-11-20 17:15:32 +00009193void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00009194{
David Horstmannf1734052023-11-20 17:15:32 +00009195 mbedtls_free(local_input->buffer);
9196 local_input->buffer = NULL;
9197 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00009198}
9199
David Horstmann89875a42023-11-20 12:54:09 +00009200psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
9201 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00009202{
David Horstmann9db14482023-11-23 15:50:37 +00009203 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00009204
David Horstmannc5cc1c32023-11-15 18:11:26 +00009205 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00009206 return PSA_SUCCESS;
9207 }
David Horstmann89875a42023-11-20 12:54:09 +00009208 local_output->buffer = mbedtls_calloc(output_len, 1);
9209 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00009210 /* Since we dealt with the zero-length case above, we know that
9211 * a NULL return value means a failure of allocation. */
9212 return PSA_ERROR_INSUFFICIENT_MEMORY;
9213 }
David Horstmann89875a42023-11-20 12:54:09 +00009214 local_output->length = output_len;
9215 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00009216
9217 return PSA_SUCCESS;
9218}
9219
David Horstmann89875a42023-11-20 12:54:09 +00009220psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00009221{
David Horstmannc335a4e2023-11-15 15:57:32 +00009222 psa_status_t status;
9223
David Horstmann89875a42023-11-20 12:54:09 +00009224 if (local_output->buffer == NULL) {
9225 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00009226 return PSA_SUCCESS;
9227 }
David Horstmann89875a42023-11-20 12:54:09 +00009228 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00009229 /* We have an internal copy but nothing to copy back to. */
9230 return PSA_ERROR_CORRUPTION_DETECTED;
9231 }
9232
David Horstmann89875a42023-11-20 12:54:09 +00009233 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
9234 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00009235 if (status != PSA_SUCCESS) {
9236 return status;
9237 }
David Horstmann9467ea32023-11-08 17:44:18 +00009238
David Horstmann89875a42023-11-20 12:54:09 +00009239 mbedtls_free(local_output->buffer);
9240 local_output->buffer = NULL;
9241 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00009242
9243 return PSA_SUCCESS;
9244}
9245
Gilles Peskinee59236f2018-01-27 23:32:46 +01009246#endif /* MBEDTLS_PSA_CRYPTO_C */