blob: f0434114ea39feb62f0f20bb362b5c0c69a54a3f [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 Peskine808b5412024-04-10 20:05:06 +02002322static int is_hash_supported(psa_algorithm_t alg)
2323{
2324 switch (alg) {
2325#if defined(PSA_WANT_ALG_MD5)
2326 case PSA_ALG_MD5:
2327 return 1;
2328#endif
2329#if defined(PSA_WANT_ALG_RIPEMD160)
2330 case PSA_ALG_RIPEMD160:
2331 return 1;
2332#endif
2333#if defined(PSA_WANT_ALG_SHA_1)
2334 case PSA_ALG_SHA_1:
2335 return 1;
2336#endif
2337#if defined(PSA_WANT_ALG_SHA_224)
2338 case PSA_ALG_SHA_224:
2339 return 1;
2340#endif
2341#if defined(PSA_WANT_ALG_SHA_256)
2342 case PSA_ALG_SHA_256:
2343 return 1;
2344#endif
2345#if defined(PSA_WANT_ALG_SHA_384)
2346 case PSA_ALG_SHA_384:
2347 return 1;
2348#endif
2349#if defined(PSA_WANT_ALG_SHA_512)
2350 case PSA_ALG_SHA_512:
2351 return 1;
2352#endif
2353#if defined(PSA_WANT_ALG_SHA3_224)
2354 case PSA_ALG_SHA3_224:
2355 return 1;
2356#endif
2357#if defined(PSA_WANT_ALG_SHA3_256)
2358 case PSA_ALG_SHA3_256:
2359 return 1;
2360#endif
2361#if defined(PSA_WANT_ALG_SHA3_384)
2362 case PSA_ALG_SHA3_384:
2363 return 1;
2364#endif
2365#if defined(PSA_WANT_ALG_SHA3_512)
2366 case PSA_ALG_SHA3_512:
2367 return 1;
2368#endif
2369 default:
2370 return 0;
2371 }
2372}
2373
Gilles Peskine449bd832023-01-11 14:50:10 +01002374psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002375{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002376 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 if (operation->id == 0) {
2378 return PSA_SUCCESS;
2379 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002380
Gilles Peskine449bd832023-01-11 14:50:10 +01002381 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002382 operation->id = 0;
2383
Gilles Peskine449bd832023-01-11 14:50:10 +01002384 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002385}
2386
Gilles Peskine449bd832023-01-11 14:50:10 +01002387psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2388 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002389{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002390 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002391
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002392 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002393 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002394 status = PSA_ERROR_BAD_STATE;
2395 goto exit;
2396 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002397
Gilles Peskine449bd832023-01-11 14:50:10 +01002398 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002399 status = PSA_ERROR_INVALID_ARGUMENT;
2400 goto exit;
2401 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002402
Gilles Peskinea7a480b2025-02-05 19:41:52 +01002403 /* Make sure the driver-dependent part of the operation is zeroed.
2404 * This is a guarantee we make to drivers. Initializing the operation
2405 * does not necessarily take care of it, since the context is a
2406 * union and initializing a union does not necessarily initialize
2407 * all of its members. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002409
Gilles Peskine449bd832023-01-11 14:50:10 +01002410 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002411
2412exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002413 if (status != PSA_SUCCESS) {
2414 psa_hash_abort(operation);
2415 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002416
2417 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002418}
2419
Gilles Peskine449bd832023-01-11 14:50:10 +01002420psa_status_t psa_hash_update(psa_hash_operation_t *operation,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002421 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002423{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002424 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002425 LOCAL_INPUT_DECLARE(input_external, input);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002426
Gilles Peskine449bd832023-01-11 14:50:10 +01002427 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002428 status = PSA_ERROR_BAD_STATE;
2429 goto exit;
2430 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002431
Steven Cooremanc8288352021-03-04 14:02:19 +01002432 /* Don't require hash implementations to behave correctly on a
2433 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 if (input_length == 0) {
2435 return PSA_SUCCESS;
2436 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002437
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002438 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002439 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002440
2441exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 if (status != PSA_SUCCESS) {
2443 psa_hash_abort(operation);
2444 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002445
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002446 LOCAL_INPUT_FREE(input_external, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002448}
2449
Thomas Daubney31d8c0b2024-01-18 15:26:59 +00002450static psa_status_t psa_hash_finish_internal(psa_hash_operation_t *operation,
Thomas Daubneyd2411562024-01-25 17:25:07 +00002451 uint8_t *hash,
2452 size_t hash_size,
2453 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002454{
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002455 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2456
Steven Cooremanfbe09282021-03-08 18:41:12 +01002457 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 if (operation->id == 0) {
2459 return PSA_ERROR_BAD_STATE;
2460 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002461
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002462 status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 operation, hash, hash_size, hash_length);
2464 psa_hash_abort(operation);
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002465
2466 return status;
2467}
2468
2469psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2470 uint8_t *hash_external,
2471 size_t hash_size,
2472 size_t *hash_length)
2473{
2474 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2475 LOCAL_OUTPUT_DECLARE(hash_external, hash);
2476
2477 LOCAL_OUTPUT_ALLOC(hash_external, hash_size, hash);
2478 status = psa_hash_finish_internal(operation, hash, hash_size, hash_length);
2479
David Horstmann4a48bec2024-03-13 15:42:31 +00002480#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002481exit:
Thomas Daubneydedd1002024-01-25 16:52:50 +00002482#endif
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002483 LOCAL_OUTPUT_FREE(hash_external, hash);
Gilles Peskine449bd832023-01-11 14:50:10 +01002484 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002485}
2486
Gilles Peskine449bd832023-01-11 14:50:10 +01002487psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002488 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002489 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002490{
Ronald Cron69a63422021-10-18 09:47:58 +02002491 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002492 size_t actual_hash_length;
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002493 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2494 LOCAL_INPUT_DECLARE(hash_external, hash);
2495
2496 status = psa_hash_finish_internal(
Gilles Peskine449bd832023-01-11 14:50:10 +01002497 operation,
2498 actual_hash, sizeof(actual_hash),
2499 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002500
Gilles Peskine449bd832023-01-11 14:50:10 +01002501 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002502 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002503 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002504
Gilles Peskine449bd832023-01-11 14:50:10 +01002505 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002506 status = PSA_ERROR_INVALID_SIGNATURE;
2507 goto exit;
2508 }
2509
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002510 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
Dave Rodgman78701152023-08-29 14:20:18 +01002511 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002512 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002513 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002514
2515exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2517 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002518 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002519 }
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002520 LOCAL_INPUT_FREE(hash_external, hash);
Gilles Peskine449bd832023-01-11 14:50:10 +01002521 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002522}
2523
Gilles Peskine449bd832023-01-11 14:50:10 +01002524psa_status_t psa_hash_compute(psa_algorithm_t alg,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002525 const uint8_t *input_external, size_t input_length,
2526 uint8_t *hash_external, size_t hash_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002527 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002528{
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002529 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2530 LOCAL_INPUT_DECLARE(input_external, input);
2531 LOCAL_OUTPUT_DECLARE(hash_external, hash);
2532
Steven Cooremanfbe09282021-03-08 18:41:12 +01002533 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002534 if (!PSA_ALG_IS_HASH(alg)) {
2535 return PSA_ERROR_INVALID_ARGUMENT;
2536 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002537
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002538 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2539 LOCAL_OUTPUT_ALLOC(hash_external, hash_size, hash);
2540 status = psa_driver_wrapper_hash_compute(alg, input, input_length,
Thomas Daubneyd2411562024-01-25 17:25:07 +00002541 hash, hash_size, hash_length);
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002542
David Horstmann4a48bec2024-03-13 15:42:31 +00002543#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002544exit:
Thomas Daubneydedd1002024-01-25 16:52:50 +00002545#endif
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002546 LOCAL_INPUT_FREE(input_external, input);
2547 LOCAL_OUTPUT_FREE(hash_external, hash);
2548 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002549}
2550
Gilles Peskine449bd832023-01-11 14:50:10 +01002551psa_status_t psa_hash_compare(psa_algorithm_t alg,
Thomas Daubney51ffac92024-01-18 15:46:26 +00002552 const uint8_t *input_external, size_t input_length,
2553 const uint8_t *hash_external, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002554{
Ronald Cron69a63422021-10-18 09:47:58 +02002555 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002556 size_t actual_hash_length;
Thomas Daubney51ffac92024-01-18 15:46:26 +00002557 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2558
2559 LOCAL_INPUT_DECLARE(input_external, input);
2560 LOCAL_INPUT_DECLARE(hash_external, hash);
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002561
Gilles Peskine449bd832023-01-11 14:50:10 +01002562 if (!PSA_ALG_IS_HASH(alg)) {
Thomas Daubney51ffac92024-01-18 15:46:26 +00002563 status = PSA_ERROR_INVALID_ARGUMENT;
2564 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002566
Thomas Daubney51ffac92024-01-18 15:46:26 +00002567 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2568 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 alg, input, input_length,
2570 actual_hash, sizeof(actual_hash),
2571 &actual_hash_length);
2572 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002573 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002574 }
2575 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002576 status = PSA_ERROR_INVALID_SIGNATURE;
2577 goto exit;
2578 }
Thomas Daubney51ffac92024-01-18 15:46:26 +00002579
2580 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
Dave Rodgman78701152023-08-29 14:20:18 +01002581 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002582 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002583 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002584
2585exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
Thomas Daubney51ffac92024-01-18 15:46:26 +00002587
2588 LOCAL_INPUT_FREE(input_external, input);
2589 LOCAL_INPUT_FREE(hash_external, hash);
2590
Gilles Peskine449bd832023-01-11 14:50:10 +01002591 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002592}
2593
Gilles Peskine449bd832023-01-11 14:50:10 +01002594psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2595 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002596{
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 if (source_operation->id == 0 ||
2598 target_operation->id != 0) {
2599 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002600 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002601
Gilles Peskinea7a480b2025-02-05 19:41:52 +01002602 /* Make sure the driver-dependent part of the operation is zeroed.
2603 * This is a guarantee we make to drivers. Initializing the operation
2604 * does not necessarily take care of it, since the context is a
2605 * union and initializing a union does not necessarily initialize
2606 * all of its members. */
2607 memset(&target_operation->ctx, 0, sizeof(target_operation->ctx));
2608
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2610 target_operation);
2611 if (status != PSA_SUCCESS) {
2612 psa_hash_abort(target_operation);
2613 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002614
Gilles Peskine449bd832023-01-11 14:50:10 +01002615 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002616}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002617
2618
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002619/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002620/* MAC */
2621/****************************************************************/
2622
Gilles Peskine449bd832023-01-11 14:50:10 +01002623psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002624{
Steven Cooremane6804192021-03-19 18:28:56 +01002625 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002626 if (operation->id == 0) {
2627 return PSA_SUCCESS;
2628 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002629
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002631 operation->mac_size = 0;
2632 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002633 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002634
Gilles Peskine449bd832023-01-11 14:50:10 +01002635 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002636}
2637
Ronald Cron2dff3b22021-06-17 16:33:22 +02002638static psa_status_t psa_mac_finalize_alg_and_key_validation(
2639 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002640 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002641 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002642{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002643 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 psa_key_type_t key_type = psa_get_key_type(attributes);
2645 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002646
Gilles Peskine449bd832023-01-11 14:50:10 +01002647 if (!PSA_ALG_IS_MAC(alg)) {
2648 return PSA_ERROR_INVALID_ARGUMENT;
2649 }
Steven Cooremane6804192021-03-19 18:28:56 +01002650
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002651 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002652 status = psa_mac_key_can_do(alg, key_type);
2653 if (status != PSA_SUCCESS) {
2654 return status;
2655 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002656
Steven Cooremand1a68f12021-05-10 11:13:41 +02002657 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002659
Gilles Peskine449bd832023-01-11 14:50:10 +01002660 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002661 /* A very short MAC is too short for security since it can be
2662 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2663 * so we make this our minimum, even though 32 bits is still
2664 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002665 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002666 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002667
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2669 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002670 /* It's impossible to "truncate" to a larger length than the full length
2671 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002672 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002673 }
2674
Gilles Peskine449bd832023-01-11 14:50:10 +01002675 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002676 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2677 * that is disabled in the compile-time configuration. The result can
2678 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2679 * configuration into account. In this case, force a return of
2680 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2681 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2682 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2683 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2684 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002685 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002686 }
2687
Gilles Peskine449bd832023-01-11 14:50:10 +01002688 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002689}
2690
Gilles Peskine449bd832023-01-11 14:50:10 +01002691static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2692 mbedtls_svc_key_id_t key,
2693 psa_algorithm_t alg,
2694 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002695{
2696 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2697 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002698 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002699
2700 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002702 status = PSA_ERROR_BAD_STATE;
2703 goto exit;
2704 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002705
Gilles Peskinea7a480b2025-02-05 19:41:52 +01002706 /* Make sure the driver-dependent part of the operation is zeroed.
2707 * This is a guarantee we make to drivers. Initializing the operation
2708 * does not necessarily take care of it, since the context is a
2709 * union and initializing a union does not necessarily initialize
2710 * all of its members. */
2711 memset(&operation->ctx, 0, sizeof(operation->ctx));
2712
Gilles Peskine8c9def32018-02-08 10:02:12 +01002713 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002714 key,
2715 &slot,
2716 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2717 alg);
2718 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002719 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002720 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002721
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002722 status = psa_mac_finalize_alg_and_key_validation(alg, &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002723 &operation->mac_size);
2724 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002725 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002727
2728 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002729 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002730 if (is_sign) {
2731 status = psa_driver_wrapper_mac_sign_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002732 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002733 slot->key.data,
2734 slot->key.bytes,
2735 alg);
2736 } else {
2737 status = psa_driver_wrapper_mac_verify_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002738 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002739 slot->key.data,
2740 slot->key.bytes,
2741 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002742 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002743
Gilles Peskinefbfac682018-07-08 20:51:54 +02002744exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002745 if (status != PSA_SUCCESS) {
2746 psa_mac_abort(operation);
2747 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002748
Ryan Everettfb9857f2024-02-14 12:16:41 +00002749 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002750
Gilles Peskine449bd832023-01-11 14:50:10 +01002751 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002752}
2753
Gilles Peskine449bd832023-01-11 14:50:10 +01002754psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2755 mbedtls_svc_key_id_t key,
2756 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002757{
Gilles Peskine449bd832023-01-11 14:50:10 +01002758 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002759}
2760
Gilles Peskine449bd832023-01-11 14:50:10 +01002761psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2762 mbedtls_svc_key_id_t key,
2763 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002764{
Gilles Peskine449bd832023-01-11 14:50:10 +01002765 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002766}
2767
Gilles Peskine449bd832023-01-11 14:50:10 +01002768psa_status_t psa_mac_update(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002769 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002771{
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002772 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2773 LOCAL_INPUT_DECLARE(input_external, input);
2774
Gilles Peskine449bd832023-01-11 14:50:10 +01002775 if (operation->id == 0) {
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002776 status = PSA_ERROR_BAD_STATE;
2777 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002778 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002779
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002780 /* Don't require hash implementations to behave correctly on a
2781 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 if (input_length == 0) {
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002783 status = PSA_SUCCESS;
2784 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002785 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002786
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002787 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2788 status = psa_driver_wrapper_mac_update(operation, input, input_length);
2789
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 if (status != PSA_SUCCESS) {
2791 psa_mac_abort(operation);
2792 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002793
David Horstmann4a48bec2024-03-13 15:42:31 +00002794#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002795exit:
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002796#endif
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002797 LOCAL_INPUT_FREE(input_external, input);
2798
Gilles Peskine449bd832023-01-11 14:50:10 +01002799 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002800}
2801
Gilles Peskine449bd832023-01-11 14:50:10 +01002802psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002803 uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002804 size_t mac_size,
2805 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002806{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002807 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2808 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002809 LOCAL_OUTPUT_DECLARE(mac_external, mac);
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002810 LOCAL_OUTPUT_ALLOC(mac_external, mac_size, mac);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002811
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002813 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002814 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002815 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002816
Gilles Peskine449bd832023-01-11 14:50:10 +01002817 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002818 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002819 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002820 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002821
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002822 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2823 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002825 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002826 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002827 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002828
Gilles Peskine449bd832023-01-11 14:50:10 +01002829 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002830 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002831 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002832 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002833
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002834
Gilles Peskine449bd832023-01-11 14:50:10 +01002835 status = psa_driver_wrapper_mac_sign_finish(operation,
2836 mac, operation->mac_size,
2837 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002838
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002839exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002840 /* In case of success, set the potential excess room in the output buffer
2841 * to an invalid value, to avoid potentially leaking a longer MAC.
2842 * In case of error, set the output length and content to a safe default,
2843 * such that in case the caller misses an error check, the output would be
2844 * an unachievable MAC.
2845 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002846 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002847 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002848 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002849 }
mohammad16036df908f2018-04-02 08:34:15 -07002850
Thomas Daubney03f1ea32024-02-01 16:16:27 +00002851 if (mac != NULL) {
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002852 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
2853 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002854
Gilles Peskine449bd832023-01-11 14:50:10 +01002855 abort_status = psa_mac_abort(operation);
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002856 LOCAL_OUTPUT_FREE(mac_external, mac);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002857
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002859}
2860
Gilles Peskine449bd832023-01-11 14:50:10 +01002861psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002862 const uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002863 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002864{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002865 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2866 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002867 LOCAL_INPUT_DECLARE(mac_external, mac);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002868
Gilles Peskine449bd832023-01-11 14:50:10 +01002869 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002870 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002871 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002872 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002873
Gilles Peskine449bd832023-01-11 14:50:10 +01002874 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002875 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002876 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002877 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002878
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002880 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002881 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002882 }
2883
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002884 LOCAL_INPUT_ALLOC(mac_external, mac_length, mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01002885 status = psa_driver_wrapper_mac_verify_finish(operation,
2886 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002887
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002888exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002889 abort_status = psa_mac_abort(operation);
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002890 LOCAL_INPUT_FREE(mac_external, mac);
mohammad16036df908f2018-04-02 08:34:15 -07002891
Gilles Peskine449bd832023-01-11 14:50:10 +01002892 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002893}
2894
Gilles Peskine449bd832023-01-11 14:50:10 +01002895static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2896 psa_algorithm_t alg,
2897 const uint8_t *input,
2898 size_t input_length,
2899 uint8_t *mac,
2900 size_t mac_size,
2901 size_t *mac_length,
2902 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002903{
2904 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002905 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2906 psa_key_slot_t *slot;
2907 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002908
Ronald Cron51131b52021-06-17 17:17:20 +02002909 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002910 key,
2911 &slot,
2912 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2913 alg);
2914 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002915 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002916 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002917
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002918 status = psa_mac_finalize_alg_and_key_validation(alg, &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 &operation_mac_size);
2920 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002921 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002922 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002923
Gilles Peskine449bd832023-01-11 14:50:10 +01002924 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002925 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002926 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002927 }
2928
2929 status = psa_driver_wrapper_mac_compute(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002930 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 slot->key.data, slot->key.bytes,
2932 alg,
2933 input, input_length,
2934 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002935
2936exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002937 /* In case of success, set the potential excess room in the output buffer
2938 * to an invalid value, to avoid potentially leaking a longer MAC.
2939 * In case of error, set the output length and content to a safe default,
2940 * such that in case the caller misses an error check, the output would be
2941 * an unachievable MAC.
2942 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002943 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002944 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002945 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002946 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002947
2948 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002949
Ryan Everetta103ec92024-01-31 13:59:57 +00002950 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002951
Gilles Peskine449bd832023-01-11 14:50:10 +01002952 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002953}
2954
Gilles Peskine449bd832023-01-11 14:50:10 +01002955psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002956 psa_algorithm_t alg,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002957 const uint8_t *input_external,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002958 size_t input_length,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002959 uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002960 size_t mac_size,
2961 size_t *mac_length)
2962{
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002963 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2964 LOCAL_INPUT_DECLARE(input_external, input);
2965 LOCAL_OUTPUT_DECLARE(mac_external, mac);
2966
2967 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2968 LOCAL_OUTPUT_ALLOC(mac_external, mac_size, mac);
2969 status = psa_mac_compute_internal(key, alg,
Thomas Daubney7480a742024-01-30 11:29:47 +00002970 input, input_length,
2971 mac, mac_size, mac_length, 1);
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002972
David Horstmann4a48bec2024-03-13 15:42:31 +00002973#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002974exit:
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002975#endif
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002976 LOCAL_INPUT_FREE(input_external, input);
2977 LOCAL_OUTPUT_FREE(mac_external, mac);
2978
2979 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002980}
2981
2982psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2983 psa_algorithm_t alg,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002984 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002985 size_t input_length,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002986 const uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002987 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002988{
2989 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002990 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2991 size_t actual_mac_length;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002992 LOCAL_INPUT_DECLARE(input_external, input);
2993 LOCAL_INPUT_DECLARE(mac_external, mac);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002994
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002995 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002996 status = psa_mac_compute_internal(key, alg,
2997 input, input_length,
2998 actual_mac, sizeof(actual_mac),
2999 &actual_mac_length, 0);
3000 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01003001 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003002 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01003003
Gilles Peskine449bd832023-01-11 14:50:10 +01003004 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02003005 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01003006 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02003007 }
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00003008
3009 LOCAL_INPUT_ALLOC(mac_external, mac_length, mac);
Dave Rodgman78701152023-08-29 14:20:18 +01003010 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02003011 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01003012 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02003013 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01003014
3015exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003016 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00003017 LOCAL_INPUT_FREE(input_external, input);
3018 LOCAL_INPUT_FREE(mac_external, mac);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01003019
Gilles Peskine449bd832023-01-11 14:50:10 +01003020 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01003021}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003022
Gilles Peskinee59236f2018-01-27 23:32:46 +01003023/****************************************************************/
3024/* Asymmetric cryptography */
3025/****************************************************************/
3026
Gilles Peskine449bd832023-01-11 14:50:10 +01003027static psa_status_t psa_sign_verify_check_alg(int input_is_message,
3028 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003029{
Gilles Peskine449bd832023-01-11 14:50:10 +01003030 if (input_is_message) {
3031 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
3032 return PSA_ERROR_INVALID_ARGUMENT;
3033 }
Gilles Peskine808b5412024-04-10 20:05:06 +02003034 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003035
Gilles Peskine808b5412024-04-10 20:05:06 +02003036 psa_algorithm_t hash_alg = 0;
3037 if (PSA_ALG_IS_SIGN_HASH(alg)) {
3038 hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
3039 }
3040
3041 /* Now hash_alg==0 if alg by itself doesn't need a hash.
3042 * This is good enough for sign-hash, but a guaranteed failure for
3043 * sign-message which needs to hash first for all algorithms
3044 * supported at the moment. */
3045
3046 if (hash_alg == 0 && input_is_message) {
3047 return PSA_ERROR_INVALID_ARGUMENT;
3048 }
3049 if (hash_alg == PSA_ALG_ANY_HASH) {
3050 return PSA_ERROR_INVALID_ARGUMENT;
3051 }
3052 /* Give up immediately if the hash is not supported. This has
3053 * several advantages:
3054 * - For mechanisms that don't use the hash at all (e.g.
3055 * ECDSA verification, randomized ECDSA signature), without
3056 * this check, the operation would succeed even though it has
3057 * been given an invalid argument. This would not be insecure
3058 * since the hash was not necessary, but it would be weird.
3059 * - For mechanisms that do use the hash, we avoid an error
3060 * deep inside the execution. In principle this doesn't matter,
3061 * but there is a little more risk of a bug in error handling
3062 * deep inside than in this preliminary check.
3063 * - When calling a driver, the driver might be capable of using
3064 * a hash that the core doesn't support. This could potentially
3065 * result in a buffer overflow if the hash is larger than the
3066 * maximum hash size assumed by the core.
3067 * - Returning a consistent error makes it possible to test
3068 * not-supported hashes in a consistent way.
3069 */
3070 if (hash_alg != 0 && !is_hash_supported(hash_alg)) {
3071 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003072 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003073
Gilles Peskine449bd832023-01-11 14:50:10 +01003074 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003075}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003076
Gilles Peskine449bd832023-01-11 14:50:10 +01003077static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
3078 int input_is_message,
3079 psa_algorithm_t alg,
3080 const uint8_t *input,
3081 size_t input_length,
3082 uint8_t *signature,
3083 size_t signature_size,
3084 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003085{
3086 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3087 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3088 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003089
3090 *signature_length = 0;
3091
Gilles Peskine449bd832023-01-11 14:50:10 +01003092 status = psa_sign_verify_check_alg(input_is_message, alg);
3093 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003094 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003095 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003096
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003097 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02003098 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003099 * buffer can in principle be empty since it doesn't actually have
3100 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003101 if (signature_size == 0) {
3102 return PSA_ERROR_BUFFER_TOO_SMALL;
3103 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003104
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003105 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 key, &slot,
3107 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
3108 PSA_KEY_USAGE_SIGN_HASH,
3109 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003110
Gilles Peskine449bd832023-01-11 14:50:10 +01003111 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003112 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003114
Gilles Peskine449bd832023-01-11 14:50:10 +01003115 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003116 status = PSA_ERROR_INVALID_ARGUMENT;
3117 goto exit;
3118 }
3119
Gilles Peskine449bd832023-01-11 14:50:10 +01003120 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003121 status = psa_driver_wrapper_sign_message(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003122 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003123 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003124 signature, signature_size, signature_length);
3125 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003126
3127 status = psa_driver_wrapper_sign_hash(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003128 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003129 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003130 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003131 }
3132
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003133
3134exit:
Paul Elliott59200a22023-02-21 15:07:40 +00003135 psa_wipe_tag_output_buffer(signature, status, signature_size,
3136 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003137
Ryan Everetta103ec92024-01-31 13:59:57 +00003138 unlock_status = psa_unregister_read_under_mutex(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003139
Gilles Peskine449bd832023-01-11 14:50:10 +01003140 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003141}
3142
Gilles Peskine449bd832023-01-11 14:50:10 +01003143static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
3144 int input_is_message,
3145 psa_algorithm_t alg,
3146 const uint8_t *input,
3147 size_t input_length,
3148 const uint8_t *signature,
3149 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003150{
3151 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3152 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3153 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003154
Gilles Peskine449bd832023-01-11 14:50:10 +01003155 status = psa_sign_verify_check_alg(input_is_message, alg);
3156 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003157 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003158 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003159
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003160 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003161 key, &slot,
3162 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
3163 PSA_KEY_USAGE_VERIFY_HASH,
3164 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003165
Gilles Peskine449bd832023-01-11 14:50:10 +01003166 if (status != PSA_SUCCESS) {
3167 return status;
3168 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003169
Gilles Peskine449bd832023-01-11 14:50:10 +01003170 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003171 status = psa_driver_wrapper_verify_message(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003172 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003173 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003174 signature, signature_length);
3175 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003176 status = psa_driver_wrapper_verify_hash(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003177 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003178 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003179 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003180 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003181
Ryan Everetta103ec92024-01-31 13:59:57 +00003182 unlock_status = psa_unregister_read_under_mutex(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003183
Gilles Peskine449bd832023-01-11 14:50:10 +01003184 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003185
3186}
3187
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003188psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003189 const psa_key_attributes_t *attributes,
3190 const uint8_t *key_buffer,
3191 size_t key_buffer_size,
3192 psa_algorithm_t alg,
3193 const uint8_t *input,
3194 size_t input_length,
3195 uint8_t *signature,
3196 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01003197 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003198{
3199 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003200
Gilles Peskine449bd832023-01-11 14:50:10 +01003201 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003202 size_t hash_length;
3203 uint8_t hash[PSA_HASH_MAX_SIZE];
3204
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003205 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003206 PSA_ALG_SIGN_GET_HASH(alg),
3207 input, input_length,
3208 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003209
Gilles Peskine449bd832023-01-11 14:50:10 +01003210 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003211 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003212 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003213
3214 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003215 attributes, key_buffer, key_buffer_size,
3216 alg, hash, hash_length,
3217 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003218 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003219
Gilles Peskine449bd832023-01-11 14:50:10 +01003220 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003221}
3222
Gilles Peskine449bd832023-01-11 14:50:10 +01003223psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3224 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003225 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003226 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003227 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003228 size_t signature_size,
3229 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003230{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003231 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3232 LOCAL_INPUT_DECLARE(input_external, input);
3233 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3234
3235 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3236 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3237 status = psa_sign_internal(key, 1, alg, input, input_length, signature,
3238 signature_size, signature_length);
3239
David Horstmann4a48bec2024-03-13 15:42:31 +00003240#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003241exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003242#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003243 LOCAL_INPUT_FREE(input_external, input);
3244 LOCAL_OUTPUT_FREE(signature_external, signature);
3245 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003246}
3247
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003248psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003249 const psa_key_attributes_t *attributes,
3250 const uint8_t *key_buffer,
3251 size_t key_buffer_size,
3252 psa_algorithm_t alg,
3253 const uint8_t *input,
3254 size_t input_length,
3255 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003256 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003257{
3258 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003259
Gilles Peskine449bd832023-01-11 14:50:10 +01003260 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003261 size_t hash_length;
3262 uint8_t hash[PSA_HASH_MAX_SIZE];
3263
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003264 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003265 PSA_ALG_SIGN_GET_HASH(alg),
3266 input, input_length,
3267 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003268
Gilles Peskine449bd832023-01-11 14:50:10 +01003269 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003270 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003271 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003272
3273 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003274 attributes, key_buffer, key_buffer_size,
3275 alg, hash, hash_length,
3276 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003277 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003278
Gilles Peskine449bd832023-01-11 14:50:10 +01003279 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003280}
3281
Gilles Peskine449bd832023-01-11 14:50:10 +01003282psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3283 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003284 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003285 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003286 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003287 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003288{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003289 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3290 LOCAL_INPUT_DECLARE(input_external, input);
3291 LOCAL_INPUT_DECLARE(signature_external, signature);
3292
3293 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3294 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3295 status = psa_verify_internal(key, 1, alg, input, input_length, signature,
3296 signature_length);
3297
David Horstmann4a48bec2024-03-13 15:42:31 +00003298#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003299exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003300#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003301 LOCAL_INPUT_FREE(input_external, input);
3302 LOCAL_INPUT_FREE(signature_external, signature);
3303
3304 return status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003305}
3306
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003307psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003308 const psa_key_attributes_t *attributes,
3309 const uint8_t *key_buffer, size_t key_buffer_size,
3310 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003311 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003312{
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003313 if (attributes->type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003314 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3315 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003316#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003317 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3318 return mbedtls_psa_rsa_sign_hash(
3319 attributes,
3320 key_buffer, key_buffer_size,
3321 alg, hash, hash_length,
3322 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003323#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3324 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003325 } else {
3326 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003327 }
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003328 } else if (PSA_KEY_TYPE_IS_ECC(attributes->type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003329 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003330#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003331 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3332 return mbedtls_psa_ecdsa_sign_hash(
3333 attributes,
3334 key_buffer, key_buffer_size,
3335 alg, hash, hash_length,
3336 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003337#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3338 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003339 } else {
3340 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003341 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003342 }
Ronald Cron4501c982021-03-19 20:09:32 +01003343
Gilles Peskine449bd832023-01-11 14:50:10 +01003344 (void) key_buffer;
3345 (void) key_buffer_size;
3346 (void) hash;
3347 (void) hash_length;
3348 (void) signature;
3349 (void) signature_size;
3350 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003351
Gilles Peskine449bd832023-01-11 14:50:10 +01003352 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003353}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003354
Gilles Peskine449bd832023-01-11 14:50:10 +01003355psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3356 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003357 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003358 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003359 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003360 size_t signature_size,
3361 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003362{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003363 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3364 LOCAL_INPUT_DECLARE(hash_external, hash);
3365 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3366
3367 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3368 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3369 status = psa_sign_internal(key, 0, alg, hash, hash_length, signature,
3370 signature_size, signature_length);
3371
David Horstmann4a48bec2024-03-13 15:42:31 +00003372#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003373exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003374#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003375 LOCAL_INPUT_FREE(hash_external, hash);
3376 LOCAL_OUTPUT_FREE(signature_external, signature);
3377
3378 return status;
itayzafrir5c753392018-05-08 11:18:38 +03003379}
3380
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003381psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003382 const psa_key_attributes_t *attributes,
3383 const uint8_t *key_buffer, size_t key_buffer_size,
3384 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003385 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003386{
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003387 if (PSA_KEY_TYPE_IS_RSA(attributes->type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003388 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3389 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003390#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003391 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3392 return mbedtls_psa_rsa_verify_hash(
3393 attributes,
3394 key_buffer, key_buffer_size,
3395 alg, hash, hash_length,
3396 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003397#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3398 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003399 } else {
3400 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003401 }
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003402 } else if (PSA_KEY_TYPE_IS_ECC(attributes->type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003403 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003404#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003405 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3406 return mbedtls_psa_ecdsa_verify_hash(
3407 attributes,
3408 key_buffer, key_buffer_size,
3409 alg, hash, hash_length,
3410 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003411#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3412 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003413 } else {
3414 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003415 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003416 }
Ronald Cron4501c982021-03-19 20:09:32 +01003417
Gilles Peskine449bd832023-01-11 14:50:10 +01003418 (void) key_buffer;
3419 (void) key_buffer_size;
3420 (void) hash;
3421 (void) hash_length;
3422 (void) signature;
3423 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003424
Gilles Peskine449bd832023-01-11 14:50:10 +01003425 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003426}
3427
Gilles Peskine449bd832023-01-11 14:50:10 +01003428psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3429 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003430 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003431 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003432 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003433 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003434{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003435 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3436 LOCAL_INPUT_DECLARE(hash_external, hash);
3437 LOCAL_INPUT_DECLARE(signature_external, signature);
3438
3439 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3440 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3441 status = psa_verify_internal(key, 0, alg, hash, hash_length, signature,
3442 signature_length);
3443
David Horstmann4a48bec2024-03-13 15:42:31 +00003444#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003445exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003446#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003447 LOCAL_INPUT_FREE(hash_external, hash);
3448 LOCAL_INPUT_FREE(signature_external, signature);
3449
3450 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01003451}
3452
Gilles Peskine449bd832023-01-11 14:50:10 +01003453psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3454 psa_algorithm_t alg,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003455 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003456 size_t input_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003457 const uint8_t *salt_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003458 size_t salt_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003459 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003460 size_t output_size,
3461 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003462{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003463 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003464 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003465 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003466
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003467 LOCAL_INPUT_DECLARE(input_external, input);
3468 LOCAL_INPUT_DECLARE(salt_external, salt);
3469 LOCAL_OUTPUT_DECLARE(output_external, output);
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003470
Darryl Green5cc689a2018-07-24 15:34:10 +01003471 (void) input;
3472 (void) input_length;
3473 (void) salt;
3474 (void) output;
3475 (void) output_size;
3476
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003477 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003478
Gilles Peskine449bd832023-01-11 14:50:10 +01003479 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3480 return PSA_ERROR_INVALID_ARGUMENT;
3481 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003482
Valerio Setti5bb454a2024-01-15 10:43:16 +01003483 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003484 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3485 if (status != PSA_SUCCESS) {
3486 return status;
3487 }
3488 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3489 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003490 status = PSA_ERROR_INVALID_ARGUMENT;
3491 goto exit;
3492 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003493
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003494 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3495 LOCAL_INPUT_ALLOC(salt_external, salt_length, salt);
3496 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmann93fa4e12024-03-12 15:02:28 +00003497
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003498 status = psa_driver_wrapper_asymmetric_encrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003499 &slot->attr, slot->key.data, slot->key.bytes,
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003500 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003501 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003502exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00003503 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003504
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003505 LOCAL_INPUT_FREE(input_external, input);
3506 LOCAL_INPUT_FREE(salt_external, salt);
3507 LOCAL_OUTPUT_FREE(output_external, output);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003508
Gilles Peskine449bd832023-01-11 14:50:10 +01003509 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003510}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003511
Gilles Peskine449bd832023-01-11 14:50:10 +01003512psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3513 psa_algorithm_t alg,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003514 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003515 size_t input_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003516 const uint8_t *salt_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003517 size_t salt_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003518 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003519 size_t output_size,
3520 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003521{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003522 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003523 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003524 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003525
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003526 LOCAL_INPUT_DECLARE(input_external, input);
3527 LOCAL_INPUT_DECLARE(salt_external, salt);
3528 LOCAL_OUTPUT_DECLARE(output_external, output);
3529
Darryl Green5cc689a2018-07-24 15:34:10 +01003530 (void) input;
3531 (void) input_length;
3532 (void) salt;
3533 (void) output;
3534 (void) output_size;
3535
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003536 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003537
Gilles Peskine449bd832023-01-11 14:50:10 +01003538 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3539 return PSA_ERROR_INVALID_ARGUMENT;
3540 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003541
Valerio Setti5bb454a2024-01-15 10:43:16 +01003542 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003543 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3544 if (status != PSA_SUCCESS) {
3545 return status;
3546 }
3547 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003548 status = PSA_ERROR_INVALID_ARGUMENT;
3549 goto exit;
3550 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003551
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003552 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3553 LOCAL_INPUT_ALLOC(salt_external, salt_length, salt);
3554 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmann93fa4e12024-03-12 15:02:28 +00003555
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003556 status = psa_driver_wrapper_asymmetric_decrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003557 &slot->attr, slot->key.data, slot->key.bytes,
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003558 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003559 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003560
3561exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00003562 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003563
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003564 LOCAL_INPUT_FREE(input_external, input);
3565 LOCAL_INPUT_FREE(salt_external, salt);
3566 LOCAL_OUTPUT_FREE(output_external, output);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003567
Gilles Peskine449bd832023-01-11 14:50:10 +01003568 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003569}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003570
Paul Elliott9fe12f62022-11-30 19:16:02 +00003571/****************************************************************/
3572/* Asymmetric interruptible cryptography */
3573/****************************************************************/
3574
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003575static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3576
Paul Elliott9fe12f62022-11-30 19:16:02 +00003577void psa_interruptible_set_max_ops(uint32_t max_ops)
3578{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003579 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003580}
3581
3582uint32_t psa_interruptible_get_max_ops(void)
3583{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003584 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003585}
3586
Paul Elliott9fe12f62022-11-30 19:16:02 +00003587uint32_t psa_sign_hash_get_num_ops(
3588 const psa_sign_hash_interruptible_operation_t *operation)
3589{
Paul Elliott296ede92022-12-15 17:00:30 +00003590 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003591}
3592
3593uint32_t psa_verify_hash_get_num_ops(
3594 const psa_verify_hash_interruptible_operation_t *operation)
3595{
Paul Elliott296ede92022-12-15 17:00:30 +00003596 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003597}
3598
Paul Elliott59ad9452022-12-18 15:09:02 +00003599static psa_status_t psa_sign_hash_abort_internal(
3600 psa_sign_hash_interruptible_operation_t *operation)
3601{
3602 if (operation->id == 0) {
3603 /* The object has (apparently) been initialized but it is not (yet)
3604 * in use. It's ok to call abort on such an object, and there's
3605 * nothing to do. */
3606 return PSA_SUCCESS;
3607 }
3608
3609 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3610
3611 status = psa_driver_wrapper_sign_hash_abort(operation);
3612
3613 operation->id = 0;
3614
Paul Elliotte6145dc2023-02-07 12:51:21 +00003615 /* Do not clear either the error_occurred or num_ops elements here as they
3616 * only want to be cleared by the application calling abort, not by abort
3617 * being called at completion of an operation. */
3618
Paul Elliott59ad9452022-12-18 15:09:02 +00003619 return status;
3620}
3621
Paul Elliott9fe12f62022-11-30 19:16:02 +00003622psa_status_t psa_sign_hash_start(
3623 psa_sign_hash_interruptible_operation_t *operation,
3624 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
David Horstmann4a523a62024-03-11 13:32:16 +00003625 const uint8_t *hash_external, size_t hash_length)
Paul Elliott9fe12f62022-11-30 19:16:02 +00003626{
3627 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3628 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3629 psa_key_slot_t *slot;
3630
David Horstmann4a523a62024-03-11 13:32:16 +00003631 LOCAL_INPUT_DECLARE(hash_external, hash);
3632
Paul Elliottc9774412023-02-06 15:14:07 +00003633 /* Check that start has not been previously called, or operation has not
3634 * previously errored. */
3635 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003636 return PSA_ERROR_BAD_STATE;
3637 }
3638
Gilles Peskinea7a480b2025-02-05 19:41:52 +01003639 /* Make sure the driver-dependent part of the operation is zeroed.
3640 * This is a guarantee we make to drivers. Initializing the operation
3641 * does not necessarily take care of it, since the context is a
3642 * union and initializing a union does not necessarily initialize
3643 * all of its members. */
3644 memset(&operation->ctx, 0, sizeof(operation->ctx));
3645
Paul Elliott9fe12f62022-11-30 19:16:02 +00003646 status = psa_sign_verify_check_alg(0, alg);
3647 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003648 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003649 return status;
3650 }
3651
3652 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3653 PSA_KEY_USAGE_SIGN_HASH,
3654 alg);
3655
3656 if (status != PSA_SUCCESS) {
3657 goto exit;
3658 }
3659
3660 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3661 status = PSA_ERROR_INVALID_ARGUMENT;
3662 goto exit;
3663 }
3664
David Horstmann4a523a62024-03-11 13:32:16 +00003665 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3666
Paul Elliott296ede92022-12-15 17:00:30 +00003667 /* Ensure ops count gets reset, in case of operation re-use. */
3668 operation->num_ops = 0;
3669
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003670 status = psa_driver_wrapper_sign_hash_start(operation, &slot->attr,
Paul Elliott9fe12f62022-11-30 19:16:02 +00003671 slot->key.data,
3672 slot->key.bytes, alg,
3673 hash, hash_length);
3674exit:
3675
3676 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003677 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003678 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003679 }
3680
Ryan Everettdcc03d52024-02-14 15:44:13 +00003681 unlock_status = psa_unregister_read_under_mutex(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003682
Paul Elliottc9774412023-02-06 15:14:07 +00003683 if (unlock_status != PSA_SUCCESS) {
3684 operation->error_occurred = 1;
3685 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003686
David Horstmann4a523a62024-03-11 13:32:16 +00003687 LOCAL_INPUT_FREE(hash_external, hash);
3688
Paul Elliottc9774412023-02-06 15:14:07 +00003689 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003690}
3691
3692
3693psa_status_t psa_sign_hash_complete(
3694 psa_sign_hash_interruptible_operation_t *operation,
David Horstmann4a523a62024-03-11 13:32:16 +00003695 uint8_t *signature_external, size_t signature_size,
Paul Elliott9fe12f62022-11-30 19:16:02 +00003696 size_t *signature_length)
3697{
3698 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3699
David Horstmann4a523a62024-03-11 13:32:16 +00003700 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3701
Paul Elliott9fe12f62022-11-30 19:16:02 +00003702 *signature_length = 0;
3703
Paul Elliottc9774412023-02-06 15:14:07 +00003704 /* Check that start has been called first, and that operation has not
3705 * previously errored. */
3706 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003707 status = PSA_ERROR_BAD_STATE;
3708 goto exit;
3709 }
3710
Paul Elliott096abc42023-02-03 18:33:23 +00003711 /* Immediately reject a zero-length signature buffer. This guarantees that
3712 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003713 if (signature_size == 0) {
3714 status = PSA_ERROR_BUFFER_TOO_SMALL;
3715 goto exit;
3716 }
3717
David Horstmann4a523a62024-03-11 13:32:16 +00003718 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3719
Paul Elliott9fe12f62022-11-30 19:16:02 +00003720 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3721 signature_size,
3722 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003723
Paul Elliott296ede92022-12-15 17:00:30 +00003724 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003725 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003726
Paul Elliottebe225c2023-02-10 14:32:53 +00003727exit:
3728
David Horstmannc5064c82024-03-11 17:02:03 +00003729 if (signature != NULL) {
3730 psa_wipe_tag_output_buffer(signature, status, signature_size,
3731 *signature_length);
3732 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003733
Paul Elliott53bb3122023-02-10 14:22:22 +00003734 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003735 if (status != PSA_SUCCESS) {
3736 operation->error_occurred = 1;
3737 }
3738
Paul Elliott59ad9452022-12-18 15:09:02 +00003739 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003740 }
3741
David Horstmann4a523a62024-03-11 13:32:16 +00003742 LOCAL_OUTPUT_FREE(signature_external, signature);
3743
Paul Elliott9fe12f62022-11-30 19:16:02 +00003744 return status;
3745}
3746
3747psa_status_t psa_sign_hash_abort(
3748 psa_sign_hash_interruptible_operation_t *operation)
3749{
Paul Elliott59ad9452022-12-18 15:09:02 +00003750 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3751
3752 status = psa_sign_hash_abort_internal(operation);
3753
3754 /* We clear the number of ops done here, so that it is not cleared when
3755 * the operation fails or succeeds, only on manual abort. */
3756 operation->num_ops = 0;
3757
Paul Elliottc9774412023-02-06 15:14:07 +00003758 /* Likewise, failure state. */
3759 operation->error_occurred = 0;
3760
Paul Elliott59ad9452022-12-18 15:09:02 +00003761 return status;
3762}
3763
3764static psa_status_t psa_verify_hash_abort_internal(
3765 psa_verify_hash_interruptible_operation_t *operation)
3766{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003767 if (operation->id == 0) {
3768 /* The object has (apparently) been initialized but it is not (yet)
3769 * in use. It's ok to call abort on such an object, and there's
3770 * nothing to do. */
3771 return PSA_SUCCESS;
3772 }
3773
Paul Elliott59ad9452022-12-18 15:09:02 +00003774 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3775
3776 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003777
3778 operation->id = 0;
3779
Paul Elliotte6145dc2023-02-07 12:51:21 +00003780 /* Do not clear either the error_occurred or num_ops elements here as they
3781 * only want to be cleared by the application calling abort, not by abort
3782 * being called at completion of an operation. */
3783
Paul Elliott59ad9452022-12-18 15:09:02 +00003784 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003785}
3786
3787psa_status_t psa_verify_hash_start(
3788 psa_verify_hash_interruptible_operation_t *operation,
3789 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
David Horstmann0fea6a52024-03-11 13:41:05 +00003790 const uint8_t *hash_external, size_t hash_length,
3791 const uint8_t *signature_external, size_t signature_length)
Paul Elliott9fe12f62022-11-30 19:16:02 +00003792{
3793 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3794 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3795 psa_key_slot_t *slot;
3796
David Horstmann0fea6a52024-03-11 13:41:05 +00003797 LOCAL_INPUT_DECLARE(hash_external, hash);
3798 LOCAL_INPUT_DECLARE(signature_external, signature);
3799
Paul Elliottc9774412023-02-06 15:14:07 +00003800 /* Check that start has not been previously called, or operation has not
3801 * previously errored. */
3802 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003803 return PSA_ERROR_BAD_STATE;
3804 }
3805
Gilles Peskinea7a480b2025-02-05 19:41:52 +01003806 /* Make sure the driver-dependent part of the operation is zeroed.
3807 * This is a guarantee we make to drivers. Initializing the operation
3808 * does not necessarily take care of it, since the context is a
3809 * union and initializing a union does not necessarily initialize
3810 * all of its members. */
3811 memset(&operation->ctx, 0, sizeof(operation->ctx));
3812
Paul Elliott9fe12f62022-11-30 19:16:02 +00003813 status = psa_sign_verify_check_alg(0, alg);
3814 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003815 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003816 return status;
3817 }
3818
3819 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3820 PSA_KEY_USAGE_VERIFY_HASH,
3821 alg);
3822
3823 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003824 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003825 return status;
3826 }
3827
David Horstmann0fea6a52024-03-11 13:41:05 +00003828 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3829 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3830
Paul Elliott296ede92022-12-15 17:00:30 +00003831 /* Ensure ops count gets reset, in case of operation re-use. */
3832 operation->num_ops = 0;
3833
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003834 status = psa_driver_wrapper_verify_hash_start(operation, &slot->attr,
Paul Elliott9fe12f62022-11-30 19:16:02 +00003835 slot->key.data,
3836 slot->key.bytes,
3837 alg, hash, hash_length,
3838 signature, signature_length);
David Horstmann4a48bec2024-03-13 15:42:31 +00003839#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
David Horstmann0fea6a52024-03-11 13:41:05 +00003840exit:
3841#endif
Paul Elliott9fe12f62022-11-30 19:16:02 +00003842
3843 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003844 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003845 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003846 }
3847
Ryan Everett291267f2024-02-14 15:59:15 +00003848 unlock_status = psa_unregister_read_under_mutex(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003849
Paul Elliottc9774412023-02-06 15:14:07 +00003850 if (unlock_status != PSA_SUCCESS) {
3851 operation->error_occurred = 1;
3852 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003853
David Horstmann0fea6a52024-03-11 13:41:05 +00003854 LOCAL_INPUT_FREE(hash_external, hash);
3855 LOCAL_INPUT_FREE(signature_external, signature);
3856
Paul Elliottc9774412023-02-06 15:14:07 +00003857 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003858}
3859
3860psa_status_t psa_verify_hash_complete(
3861 psa_verify_hash_interruptible_operation_t *operation)
3862{
3863 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3864
Paul Elliottc9774412023-02-06 15:14:07 +00003865 /* Check that start has been called first, and that operation has not
3866 * previously errored. */
3867 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003868 status = PSA_ERROR_BAD_STATE;
3869 goto exit;
3870 }
3871
3872 status = psa_driver_wrapper_verify_hash_complete(operation);
3873
Paul Elliott296ede92022-12-15 17:00:30 +00003874 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003875 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003876 operation);
3877
Paul Elliottebe225c2023-02-10 14:32:53 +00003878exit:
3879
Paul Elliott9fe12f62022-11-30 19:16:02 +00003880 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003881 if (status != PSA_SUCCESS) {
3882 operation->error_occurred = 1;
3883 }
3884
Paul Elliott59ad9452022-12-18 15:09:02 +00003885 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003886 }
3887
3888 return status;
3889}
3890
3891psa_status_t psa_verify_hash_abort(
3892 psa_verify_hash_interruptible_operation_t *operation)
3893{
Paul Elliott59ad9452022-12-18 15:09:02 +00003894 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003895
Paul Elliott59ad9452022-12-18 15:09:02 +00003896 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003897
Paul Elliott59ad9452022-12-18 15:09:02 +00003898 /* We clear the number of ops done here, so that it is not cleared when
3899 * the operation fails or succeeds, only on manual abort. */
3900 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003901
Paul Elliottc9774412023-02-06 15:14:07 +00003902 /* Likewise, failure state. */
3903 operation->error_occurred = 0;
3904
Paul Elliott59ad9452022-12-18 15:09:02 +00003905 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003906}
3907
Paul Elliott588f8ed2022-12-02 18:10:26 +00003908/****************************************************************/
3909/* Asymmetric interruptible cryptography internal */
3910/* implementations */
3911/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003912
Paul Elliott588f8ed2022-12-02 18:10:26 +00003913void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3914{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003915
Paul Elliott588f8ed2022-12-02 18:10:26 +00003916#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3917 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3918 defined(MBEDTLS_ECP_RESTARTABLE)
3919
3920 /* Internal implementation uses zero to indicate infinite number max ops,
3921 * therefore avoid this value, and set to minimum possible. */
3922 if (max_ops == 0) {
3923 max_ops = 1;
3924 }
3925
Paul Elliott588f8ed2022-12-02 18:10:26 +00003926 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003927#else
3928 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003929#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3930 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3931 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3932}
3933
Paul Elliott588f8ed2022-12-02 18:10:26 +00003934uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003935 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003936{
3937#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3938 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3939 defined(MBEDTLS_ECP_RESTARTABLE)
3940
Paul Elliott93d9ca82023-02-15 18:14:21 +00003941 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003942#else
3943 (void) operation;
3944 return 0;
3945#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3946 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3947 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3948}
3949
3950uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003951 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003952{
3953 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3954 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3955 defined(MBEDTLS_ECP_RESTARTABLE)
3956
Paul Elliott93d9ca82023-02-15 18:14:21 +00003957 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003958#else
3959 (void) operation;
3960 return 0;
3961#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3962 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3963 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3964}
3965
Gilles Peskine8a8aa592024-11-20 16:13:10 +01003966/* Detect supported interruptible sign/verify mechanisms precisely.
3967 * This is not strictly needed: we could accept everything, and let the
3968 * code fail later during complete() if the mechanism is unsupported
3969 * (e.g. attempting deterministic ECDSA when only the randomized variant
3970 * is available). But it's easier for applications and especially for our
3971 * test code to detect all not-supported errors during start().
3972 *
3973 * Note that this function ignores the hash component. The core code
3974 * is supposed to check the hash part by calling is_hash_supported().
3975 */
3976static inline int can_do_interruptible_sign_verify(psa_algorithm_t alg)
3977{
3978#if defined(MBEDTLS_ECP_RESTARTABLE)
3979#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3980 if (PSA_ALG_IS_DETERMINISTIC_ECDSA(alg)) {
3981 return 1;
3982 }
3983#endif
3984#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA)
3985 if (PSA_ALG_IS_RANDOMIZED_ECDSA(alg)) {
3986 return 1;
3987 }
3988#endif
3989#endif /* defined(MBEDTLS_ECP_RESTARTABLE) */
3990 (void) alg;
3991 return 0;
3992}
3993
Paul Elliott588f8ed2022-12-02 18:10:26 +00003994psa_status_t mbedtls_psa_sign_hash_start(
3995 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3996 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3997 size_t key_buffer_size, psa_algorithm_t alg,
3998 const uint8_t *hash, size_t hash_length)
3999{
4000 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00004001 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004002
Gilles Peskineabf9f1a2024-12-16 23:23:04 +01004003 if (!PSA_KEY_TYPE_IS_ECC_KEY_PAIR(attributes->type)) {
Paul Elliott068fe072023-01-16 13:59:15 +00004004 return PSA_ERROR_NOT_SUPPORTED;
4005 }
Gilles Peskineabf9f1a2024-12-16 23:23:04 +01004006 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(attributes->type);
4007 if (!PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
4008 return PSA_ERROR_INVALID_ARGUMENT;
4009 }
Paul Elliott068fe072023-01-16 13:59:15 +00004010
Gilles Peskine8a8aa592024-11-20 16:13:10 +01004011 if (!can_do_interruptible_sign_verify(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00004012 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00004013 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004014
4015#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00004016 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4017 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00004018
Paul Elliotta1c94092023-02-15 16:38:04 +00004019 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
4020
Paul Elliott93d9ca82023-02-15 18:14:21 +00004021 /* Ensure num_ops is zero'ed in case of context re-use. */
4022 operation->num_ops = 0;
4023
Gilles Peskine2f107ae2024-02-28 01:26:46 +01004024 status = mbedtls_psa_ecp_load_representation(attributes->type,
4025 attributes->bits,
Paul Elliott068fe072023-01-16 13:59:15 +00004026 key_buffer,
4027 key_buffer_size,
4028 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004029
Paul Elliott068fe072023-01-16 13:59:15 +00004030 if (status != PSA_SUCCESS) {
4031 return status;
4032 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004033
Paul Elliott1bc59df2023-02-05 13:41:57 +00004034 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00004035 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004036
Paul Elliott068fe072023-01-16 13:59:15 +00004037 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02004038 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00004039 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004040
Paul Elliott0290a762023-02-09 14:30:24 +00004041 /* We only need to store the same length of hash as the private key size
4042 * here, it would be truncated by the internal implementation anyway. */
4043 required_hash_length = (hash_length < operation->coordinate_bytes ?
4044 hash_length : operation->coordinate_bytes);
4045
Paul Elliottba70ad42023-02-15 18:23:53 +00004046 if (required_hash_length > sizeof(operation->hash)) {
4047 /* Shouldn't happen, but better safe than sorry. */
4048 return PSA_ERROR_CORRUPTION_DETECTED;
4049 }
4050
Paul Elliott0290a762023-02-09 14:30:24 +00004051 memcpy(operation->hash, hash, required_hash_length);
4052 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004053
4054 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004055
4056#else
Paul Elliott068fe072023-01-16 13:59:15 +00004057 (void) operation;
4058 (void) key_buffer;
4059 (void) key_buffer_size;
4060 (void) alg;
4061 (void) hash;
4062 (void) hash_length;
4063 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00004064 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004065
Paul Elliott068fe072023-01-16 13:59:15 +00004066 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004067#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4068 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4069 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004070}
4071
4072psa_status_t mbedtls_psa_sign_hash_complete(
4073 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
4074 uint8_t *signature, size_t signature_size,
4075 size_t *signature_length)
4076{
Paul Elliott588f8ed2022-12-02 18:10:26 +00004077#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4078 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4079 defined(MBEDTLS_ECP_RESTARTABLE)
4080
Paul Elliotta1c94092023-02-15 16:38:04 +00004081 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00004082 mbedtls_mpi r;
4083 mbedtls_mpi s;
4084
Paul Elliott46845252023-02-03 14:59:11 +00004085 mbedtls_mpi_init(&r);
4086 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004087
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004088 /* Ensure max_ops is set to the current value (or default). */
4089 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4090
Paul Elliotta1c94092023-02-15 16:38:04 +00004091 if (signature_size < 2 * operation->coordinate_bytes) {
4092 status = PSA_ERROR_BUFFER_TOO_SMALL;
4093 goto exit;
4094 }
4095
Paul Elliott588f8ed2022-12-02 18:10:26 +00004096 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00004097
Paul Elliott588f8ed2022-12-02 18:10:26 +00004098#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
4099 status = mbedtls_to_psa_error(
4100 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00004101 &r,
4102 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004103 &operation->ctx->d,
4104 operation->hash,
4105 operation->hash_length,
4106 operation->md_alg,
4107 mbedtls_psa_get_random,
4108 MBEDTLS_PSA_RANDOM_STATE,
4109 &operation->restart_ctx));
4110#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00004111 status = PSA_ERROR_NOT_SUPPORTED;
4112 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004113#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
4114 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00004115 status = mbedtls_to_psa_error(
4116 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00004117 &r,
4118 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004119 &operation->ctx->d,
4120 operation->hash,
4121 operation->hash_length,
4122 mbedtls_psa_get_random,
4123 MBEDTLS_PSA_RANDOM_STATE,
4124 mbedtls_psa_get_random,
4125 MBEDTLS_PSA_RANDOM_STATE,
4126 &operation->restart_ctx));
4127 }
4128
Paul Elliottf8e5b562023-02-19 18:43:45 +00004129 /* Hide the fact that the restart context only holds a delta of number of
4130 * ops done during the last operation, not an absolute value. */
4131 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4132
Paul Elliott724bd252023-02-08 12:35:08 +00004133 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00004134 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00004135 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004136 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004137 operation->coordinate_bytes)
4138 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00004139
4140 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00004141 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004142 }
4143
4144 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00004145 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004146 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004147 operation->coordinate_bytes,
4148 operation->coordinate_bytes)
4149 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00004150
4151 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00004152 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004153 }
4154
Paul Elliott1bc59df2023-02-05 13:41:57 +00004155 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004156
Paul Elliott724bd252023-02-08 12:35:08 +00004157 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004158 }
Paul Elliott724bd252023-02-08 12:35:08 +00004159
4160exit:
4161
4162 mbedtls_mpi_free(&r);
4163 mbedtls_mpi_free(&s);
4164 return status;
4165
Paul Elliott588f8ed2022-12-02 18:10:26 +00004166 #else
4167
4168 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004169 (void) signature;
4170 (void) signature_size;
4171 (void) signature_length;
4172
4173 return PSA_ERROR_NOT_SUPPORTED;
4174
4175#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4176 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4177 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4178}
4179
4180psa_status_t mbedtls_psa_sign_hash_abort(
4181 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
4182{
4183
4184#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4185 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4186 defined(MBEDTLS_ECP_RESTARTABLE)
4187
4188 if (operation->ctx) {
4189 mbedtls_ecdsa_free(operation->ctx);
4190 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004191 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004192 }
4193
4194 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4195
Paul Elliott93d9ca82023-02-15 18:14:21 +00004196 operation->num_ops = 0;
4197
Paul Elliott588f8ed2022-12-02 18:10:26 +00004198 return PSA_SUCCESS;
4199
4200#else
4201
4202 (void) operation;
4203
4204 return PSA_ERROR_NOT_SUPPORTED;
4205
4206#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4207 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4208 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4209}
4210
4211psa_status_t mbedtls_psa_verify_hash_start(
4212 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
4213 const psa_key_attributes_t *attributes,
4214 const uint8_t *key_buffer, size_t key_buffer_size,
4215 psa_algorithm_t alg,
4216 const uint8_t *hash, size_t hash_length,
4217 const uint8_t *signature, size_t signature_length)
4218{
4219 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00004220 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00004221 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004222
Gilles Peskine2f107ae2024-02-28 01:26:46 +01004223 if (!PSA_KEY_TYPE_IS_ECC(attributes->type)) {
Paul Elliott068fe072023-01-16 13:59:15 +00004224 return PSA_ERROR_NOT_SUPPORTED;
4225 }
Gilles Peskineabf9f1a2024-12-16 23:23:04 +01004226 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(attributes->type);
4227 if (!PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
4228 return PSA_ERROR_INVALID_ARGUMENT;
4229 }
Paul Elliott068fe072023-01-16 13:59:15 +00004230
Gilles Peskine8a8aa592024-11-20 16:13:10 +01004231 if (!can_do_interruptible_sign_verify(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00004232 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00004233 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004234
4235#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00004236 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4237 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00004238
Paul Elliotta1c94092023-02-15 16:38:04 +00004239 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
4240 mbedtls_mpi_init(&operation->r);
4241 mbedtls_mpi_init(&operation->s);
4242
Paul Elliott93d9ca82023-02-15 18:14:21 +00004243 /* Ensure num_ops is zero'ed in case of context re-use. */
4244 operation->num_ops = 0;
4245
Gilles Peskine2f107ae2024-02-28 01:26:46 +01004246 status = mbedtls_psa_ecp_load_representation(attributes->type,
4247 attributes->bits,
Paul Elliott068fe072023-01-16 13:59:15 +00004248 key_buffer,
4249 key_buffer_size,
4250 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004251
Paul Elliott068fe072023-01-16 13:59:15 +00004252 if (status != PSA_SUCCESS) {
4253 return status;
4254 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004255
Paul Elliottc569fc22023-02-10 13:02:54 +00004256 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004257
Paul Elliott1bc59df2023-02-05 13:41:57 +00004258 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004259 return PSA_ERROR_INVALID_SIGNATURE;
4260 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004261
Paul Elliott068fe072023-01-16 13:59:15 +00004262 status = mbedtls_to_psa_error(
4263 mbedtls_mpi_read_binary(&operation->r,
4264 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004265 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004266
Paul Elliott068fe072023-01-16 13:59:15 +00004267 if (status != PSA_SUCCESS) {
4268 return status;
4269 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004270
Paul Elliott068fe072023-01-16 13:59:15 +00004271 status = mbedtls_to_psa_error(
4272 mbedtls_mpi_read_binary(&operation->s,
4273 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004274 coordinate_bytes,
4275 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004276
Paul Elliott068fe072023-01-16 13:59:15 +00004277 if (status != PSA_SUCCESS) {
4278 return status;
4279 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004280
Paul Elliott2c9843f2023-02-15 17:32:42 +00004281 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004282
Paul Elliott2c9843f2023-02-15 17:32:42 +00004283 if (status != PSA_SUCCESS) {
4284 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004285 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004286
Paul Elliott0290a762023-02-09 14:30:24 +00004287 /* We only need to store the same length of hash as the private key size
4288 * here, it would be truncated by the internal implementation anyway. */
4289 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4290 coordinate_bytes);
4291
Paul Elliottba70ad42023-02-15 18:23:53 +00004292 if (required_hash_length > sizeof(operation->hash)) {
4293 /* Shouldn't happen, but better safe than sorry. */
4294 return PSA_ERROR_CORRUPTION_DETECTED;
4295 }
4296
Paul Elliott0290a762023-02-09 14:30:24 +00004297 memcpy(operation->hash, hash, required_hash_length);
4298 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004299
4300 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004301#else
Paul Elliott068fe072023-01-16 13:59:15 +00004302 (void) operation;
4303 (void) key_buffer;
4304 (void) key_buffer_size;
4305 (void) alg;
4306 (void) hash;
4307 (void) hash_length;
4308 (void) signature;
4309 (void) signature_length;
4310 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004311 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004312 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004313
Paul Elliott068fe072023-01-16 13:59:15 +00004314 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004315#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4316 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4317 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004318}
4319
4320psa_status_t mbedtls_psa_verify_hash_complete(
4321 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4322{
4323
4324#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4325 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4326 defined(MBEDTLS_ECP_RESTARTABLE)
4327
Paul Elliottf8e5b562023-02-19 18:43:45 +00004328 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4329
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004330 /* Ensure max_ops is set to the current value (or default). */
4331 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4332
Paul Elliottf8e5b562023-02-19 18:43:45 +00004333 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004334 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4335 operation->hash,
4336 operation->hash_length,
4337 &operation->ctx->Q,
4338 &operation->r,
4339 &operation->s,
4340 &operation->restart_ctx));
4341
Paul Elliottf8e5b562023-02-19 18:43:45 +00004342 /* Hide the fact that the restart context only holds a delta of number of
4343 * ops done during the last operation, not an absolute value. */
4344 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4345
4346 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004347#else
4348 (void) operation;
4349
4350 return PSA_ERROR_NOT_SUPPORTED;
4351
4352#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4353 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4354 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4355}
4356
4357psa_status_t mbedtls_psa_verify_hash_abort(
4358 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4359{
4360
4361#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4362 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4363 defined(MBEDTLS_ECP_RESTARTABLE)
4364
4365 if (operation->ctx) {
4366 mbedtls_ecdsa_free(operation->ctx);
4367 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004368 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004369 }
4370
4371 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4372
Paul Elliott93d9ca82023-02-15 18:14:21 +00004373 operation->num_ops = 0;
4374
Paul Elliott588f8ed2022-12-02 18:10:26 +00004375 mbedtls_mpi_free(&operation->r);
4376 mbedtls_mpi_free(&operation->s);
4377
4378 return PSA_SUCCESS;
4379
4380#else
4381 (void) operation;
4382
4383 return PSA_ERROR_NOT_SUPPORTED;
4384
4385#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4386 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4387 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4388}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004389
David Horstmann6e99bb22024-02-06 15:27:49 +00004390static psa_status_t psa_generate_random_internal(uint8_t *output,
4391 size_t output_size)
4392{
4393 GUARD_MODULE_INITIALIZED;
4394
David Horstmann6e99bb22024-02-06 15:27:49 +00004395#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4396
David Horstmanndb909142024-03-12 16:07:08 +00004397 psa_status_t status;
David Horstmann6e99bb22024-02-06 15:27:49 +00004398 size_t output_length = 0;
4399 status = mbedtls_psa_external_get_random(&global_data.rng,
4400 output, output_size,
4401 &output_length);
4402 if (status != PSA_SUCCESS) {
David Horstmanndb909142024-03-12 16:07:08 +00004403 return status;
David Horstmann6e99bb22024-02-06 15:27:49 +00004404 }
4405 /* Breaking up a request into smaller chunks is currently not supported
4406 * for the external RNG interface. */
4407 if (output_length != output_size) {
David Horstmanndb909142024-03-12 16:07:08 +00004408 return PSA_ERROR_INSUFFICIENT_ENTROPY;
David Horstmann6e99bb22024-02-06 15:27:49 +00004409 }
David Horstmanndb909142024-03-12 16:07:08 +00004410 return PSA_SUCCESS;
David Horstmann6e99bb22024-02-06 15:27:49 +00004411
4412#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4413
4414 while (output_size > 0) {
David Horstmann93fa4e12024-03-12 15:02:28 +00004415 int ret = MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED;
David Horstmann6e99bb22024-02-06 15:27:49 +00004416 size_t request_size =
4417 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4418 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4419 output_size);
David Horstmann93fa4e12024-03-12 15:02:28 +00004420#if defined(MBEDTLS_CTR_DRBG_C)
4421 ret = mbedtls_ctr_drbg_random(&global_data.rng.drbg, output, request_size);
4422#elif defined(MBEDTLS_HMAC_DRBG_C)
4423 ret = mbedtls_hmac_drbg_random(&global_data.rng.drbg, output, request_size);
4424#endif /* !MBEDTLS_CTR_DRBG_C && !MBEDTLS_HMAC_DRBG_C */
David Horstmann6e99bb22024-02-06 15:27:49 +00004425 if (ret != 0) {
David Horstmann93fa4e12024-03-12 15:02:28 +00004426 return mbedtls_to_psa_error(ret);
David Horstmann6e99bb22024-02-06 15:27:49 +00004427 }
4428 output_size -= request_size;
4429 output += request_size;
4430 }
David Horstmann93fa4e12024-03-12 15:02:28 +00004431 return PSA_SUCCESS;
David Horstmann6e99bb22024-02-06 15:27:49 +00004432#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
David Horstmann6e99bb22024-02-06 15:27:49 +00004433}
4434
4435
mohammad1603503973b2018-03-12 15:59:30 +02004436/****************************************************************/
4437/* Symmetric cryptography */
4438/****************************************************************/
4439
Gilles Peskine449bd832023-01-11 14:50:10 +01004440static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4441 mbedtls_svc_key_id_t key,
4442 psa_algorithm_t alg,
4443 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004444{
4445 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4446 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004447 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4449 PSA_KEY_USAGE_ENCRYPT :
4450 PSA_KEY_USAGE_DECRYPT);
Ronald Cronab99ac22020-10-01 16:38:28 +02004451
4452 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004453 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004454 status = PSA_ERROR_BAD_STATE;
4455 goto exit;
4456 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004457
Gilles Peskine449bd832023-01-11 14:50:10 +01004458 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004459 status = PSA_ERROR_INVALID_ARGUMENT;
4460 goto exit;
4461 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004462
Gilles Peskine449bd832023-01-11 14:50:10 +01004463 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4464 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004465 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004467
Ronald Cron49fafa92021-03-10 08:34:23 +01004468 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004469 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004470 * so we only set it (in the driver wrapper) after resources have been
4471 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004472 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004473 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004474 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004475 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004476 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004477 }
4478 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004479
Gilles Peskinea7a480b2025-02-05 19:41:52 +01004480
4481 /* Make sure the driver-dependent part of the operation is zeroed.
4482 * This is a guarantee we make to drivers. Initializing the operation
4483 * does not necessarily take care of it, since the context is a
4484 * union and initializing a union does not necessarily initialize
4485 * all of its members. */
4486 memset(&operation->ctx, 0, sizeof(operation->ctx));
4487
Ronald Cronab99ac22020-10-01 16:38:28 +02004488 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004489 if (cipher_operation == MBEDTLS_ENCRYPT) {
4490 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004491 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01004492 slot->key.data,
4493 slot->key.bytes,
4494 alg);
4495 } else {
4496 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004497 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 slot->key.data,
4499 slot->key.bytes,
4500 alg);
4501 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004502
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004503exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004504 if (status != PSA_SUCCESS) {
4505 psa_cipher_abort(operation);
4506 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004507
Ryan Everettc0053cc2024-02-14 16:27:13 +00004508 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004509
Gilles Peskine449bd832023-01-11 14:50:10 +01004510 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004511}
4512
Gilles Peskine449bd832023-01-11 14:50:10 +01004513psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4514 mbedtls_svc_key_id_t key,
4515 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004516{
Gilles Peskine449bd832023-01-11 14:50:10 +01004517 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004518}
4519
Gilles Peskine449bd832023-01-11 14:50:10 +01004520psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4521 mbedtls_svc_key_id_t key,
4522 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004523{
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004525}
4526
Gilles Peskine449bd832023-01-11 14:50:10 +01004527psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
Gabor Mezei358eb212024-02-07 18:10:13 +01004528 uint8_t *iv_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 size_t iv_size,
4530 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004531{
Ronald Cron6d051732020-10-01 14:10:20 +02004532 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Sergeybef1f632023-03-06 15:25:06 -07004533 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004534
Gabor Mezei358eb212024-02-07 18:10:13 +01004535 LOCAL_OUTPUT_DECLARE(iv_external, iv);
4536
Gilles Peskine449bd832023-01-11 14:50:10 +01004537 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004538 status = PSA_ERROR_BAD_STATE;
4539 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004540 }
4541
Gilles Peskine449bd832023-01-11 14:50:10 +01004542 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004543 status = PSA_ERROR_BAD_STATE;
4544 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004545 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004546
Ronald Cron2fb90522021-07-05 12:31:44 +02004547 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004548 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004549 status = PSA_ERROR_BUFFER_TOO_SMALL;
4550 goto exit;
4551 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004552
Gilles Peskine449bd832023-01-11 14:50:10 +01004553 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004554 status = PSA_ERROR_GENERIC_ERROR;
4555 goto exit;
4556 }
4557
Gabor Mezei358eb212024-02-07 18:10:13 +01004558 LOCAL_OUTPUT_ALLOC(iv_external, default_iv_length, iv);
4559
Gabor Mezei1b5b58d2024-03-04 17:15:08 +01004560 status = psa_generate_random_internal(iv, default_iv_length);
Gilles Peskine449bd832023-01-11 14:50:10 +01004561 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004562 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004563 }
Ronald Cron5618a392021-03-26 09:52:26 +01004564
Gilles Peskine449bd832023-01-11 14:50:10 +01004565 status = psa_driver_wrapper_cipher_set_iv(operation,
Gabor Mezei358eb212024-02-07 18:10:13 +01004566 iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004567
4568exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004569 if (status == PSA_SUCCESS) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004570 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004571 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004572 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004573 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004574 psa_cipher_abort(operation);
Gabor Mezei358eb212024-02-07 18:10:13 +01004575 if (iv != NULL) {
4576 mbedtls_platform_zeroize(iv, default_iv_length);
4577 }
Ronald Cron2fb90522021-07-05 12:31:44 +02004578 }
Ronald Cron6d051732020-10-01 14:10:20 +02004579
Gabor Mezei358eb212024-02-07 18:10:13 +01004580 LOCAL_OUTPUT_FREE(iv_external, iv);
Gilles Peskine449bd832023-01-11 14:50:10 +01004581 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004582}
4583
Gilles Peskine449bd832023-01-11 14:50:10 +01004584psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004585 const uint8_t *iv_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004586 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004587{
Ronald Cron6d051732020-10-01 14:10:20 +02004588 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004589
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004590 LOCAL_INPUT_DECLARE(iv_external, iv);
4591
Gilles Peskine449bd832023-01-11 14:50:10 +01004592 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004593 status = PSA_ERROR_BAD_STATE;
4594 goto exit;
4595 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004596
Gilles Peskine449bd832023-01-11 14:50:10 +01004597 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004598 status = PSA_ERROR_BAD_STATE;
4599 goto exit;
4600 }
Ronald Crona0d68172021-03-26 10:15:08 +01004601
Gilles Peskine449bd832023-01-11 14:50:10 +01004602 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004603 status = PSA_ERROR_INVALID_ARGUMENT;
4604 goto exit;
4605 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004606
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004607 LOCAL_INPUT_ALLOC(iv_external, iv_length, iv);
4608
Gilles Peskine449bd832023-01-11 14:50:10 +01004609 status = psa_driver_wrapper_cipher_set_iv(operation,
4610 iv,
4611 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004612
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004613exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004614 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004615 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004616 } else {
4617 psa_cipher_abort(operation);
4618 }
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004619
4620 LOCAL_INPUT_FREE(iv_external, iv);
4621
Gilles Peskine449bd832023-01-11 14:50:10 +01004622 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004623}
4624
Gilles Peskine449bd832023-01-11 14:50:10 +01004625psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
Gabor Mezei212eb082024-01-24 16:56:00 +01004626 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 size_t input_length,
Gabor Mezei212eb082024-01-24 16:56:00 +01004628 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 size_t output_size,
4630 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004631{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004632 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004633
Gabor Mezei212eb082024-01-24 16:56:00 +01004634 LOCAL_INPUT_DECLARE(input_external, input);
4635 LOCAL_OUTPUT_DECLARE(output_external, output);
4636
Gilles Peskine449bd832023-01-11 14:50:10 +01004637 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004638 status = PSA_ERROR_BAD_STATE;
4639 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004640 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004641
Gilles Peskine449bd832023-01-11 14:50:10 +01004642 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004643 status = PSA_ERROR_BAD_STATE;
4644 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004645 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004646
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004647 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gabor Mezei0b041162024-02-29 10:08:16 +00004648 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004649
Gilles Peskine449bd832023-01-11 14:50:10 +01004650 status = psa_driver_wrapper_cipher_update(operation,
4651 input,
4652 input_length,
4653 output,
4654 output_size,
4655 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004656
4657exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004658 if (status != PSA_SUCCESS) {
4659 psa_cipher_abort(operation);
4660 }
Ronald Cron6d051732020-10-01 14:10:20 +02004661
Gabor Mezei212eb082024-01-24 16:56:00 +01004662 LOCAL_INPUT_FREE(input_external, input);
4663 LOCAL_OUTPUT_FREE(output_external, output);
4664
Gilles Peskine449bd832023-01-11 14:50:10 +01004665 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004666}
4667
Gilles Peskine449bd832023-01-11 14:50:10 +01004668psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
Gabor Mezei212eb082024-01-24 16:56:00 +01004669 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 size_t output_size,
4671 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004672{
David Saadab4ecc272019-02-14 13:48:10 +02004673 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004674
Gabor Mezei212eb082024-01-24 16:56:00 +01004675 LOCAL_OUTPUT_DECLARE(output_external, output);
4676
Gilles Peskine449bd832023-01-11 14:50:10 +01004677 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004678 status = PSA_ERROR_BAD_STATE;
4679 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004680 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004681
Gilles Peskine449bd832023-01-11 14:50:10 +01004682 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004683 status = PSA_ERROR_BAD_STATE;
4684 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004685 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004686
Gabor Mezei0b041162024-02-29 10:08:16 +00004687 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004688
Gilles Peskine449bd832023-01-11 14:50:10 +01004689 status = psa_driver_wrapper_cipher_finish(operation,
4690 output,
4691 output_size,
4692 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004693
4694exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004695 if (status == PSA_SUCCESS) {
Gabor Mezei212eb082024-01-24 16:56:00 +01004696 status = psa_cipher_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01004697 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004698 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004699 (void) psa_cipher_abort(operation);
Steven Cooremanef8575e2020-09-11 11:44:50 +02004700 }
Gabor Mezei212eb082024-01-24 16:56:00 +01004701
4702 LOCAL_OUTPUT_FREE(output_external, output);
4703
4704 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004705}
4706
Gilles Peskine449bd832023-01-11 14:50:10 +01004707psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004708{
Gilles Peskine449bd832023-01-11 14:50:10 +01004709 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004710 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004711 * in use. It's ok to call abort on such an object, and there's
4712 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004714 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004715
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004717
Ronald Cron49fafa92021-03-10 08:34:23 +01004718 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004719 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004720 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004721
Gilles Peskine449bd832023-01-11 14:50:10 +01004722 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004723}
4724
Gilles Peskine449bd832023-01-11 14:50:10 +01004725psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4726 psa_algorithm_t alg,
David Horstmann36df4b22023-12-13 15:55:25 +00004727 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004728 size_t input_length,
David Horstmann36df4b22023-12-13 15:55:25 +00004729 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004730 size_t output_size,
4731 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004732{
4733 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004734 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004735 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004736 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4737 size_t default_iv_length = 0;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004738
David Horstmann62a56d92023-12-14 18:12:47 +00004739 LOCAL_INPUT_DECLARE(input_external, input);
4740 LOCAL_OUTPUT_DECLARE(output_external, output);
4741
Gilles Peskine449bd832023-01-11 14:50:10 +01004742 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004743 status = PSA_ERROR_INVALID_ARGUMENT;
4744 goto exit;
4745 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004746
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4748 PSA_KEY_USAGE_ENCRYPT,
4749 alg);
4750 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004751 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004752 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004753
Gilles Peskine449bd832023-01-11 14:50:10 +01004754 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4755 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004756 status = PSA_ERROR_GENERIC_ERROR;
4757 goto exit;
4758 }
4759
Gilles Peskine449bd832023-01-11 14:50:10 +01004760 if (default_iv_length > 0) {
4761 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004762 status = PSA_ERROR_BUFFER_TOO_SMALL;
4763 goto exit;
4764 }
4765
David Horstmann6e99bb22024-02-06 15:27:49 +00004766 status = psa_generate_random_internal(local_iv, default_iv_length);
Gilles Peskine449bd832023-01-11 14:50:10 +01004767 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004768 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004769 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004770 }
4771
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004772 LOCAL_INPUT_ALLOC(input_external, input_length, input);
4773 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
4774
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004775 status = psa_driver_wrapper_cipher_encrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004776 &slot->attr, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004777 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004778 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004779 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004780
4781exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004782 unlock_status = psa_unregister_read_under_mutex(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004783 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004784 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004785 }
Ronald Cron23919522021-07-08 19:00:07 +02004786
Gilles Peskine449bd832023-01-11 14:50:10 +01004787 if (status == PSA_SUCCESS) {
4788 if (default_iv_length > 0) {
4789 memcpy(output, local_iv, default_iv_length);
4790 }
4791 *output_length += default_iv_length;
4792 } else {
4793 *output_length = 0;
4794 }
4795
David Horstmann62a56d92023-12-14 18:12:47 +00004796 LOCAL_INPUT_FREE(input_external, input);
4797 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004798
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004800}
4801
Gilles Peskine449bd832023-01-11 14:50:10 +01004802psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4803 psa_algorithm_t alg,
Gabor Mezei212eb082024-01-24 16:56:00 +01004804 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004805 size_t input_length,
Gabor Mezei212eb082024-01-24 16:56:00 +01004806 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004807 size_t output_size,
4808 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004809{
4810 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004811 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004812 psa_key_slot_t *slot = NULL;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004813
Gabor Mezei212eb082024-01-24 16:56:00 +01004814 LOCAL_INPUT_DECLARE(input_external, input);
4815 LOCAL_OUTPUT_DECLARE(output_external, output);
4816
Gilles Peskine449bd832023-01-11 14:50:10 +01004817 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004818 status = PSA_ERROR_INVALID_ARGUMENT;
4819 goto exit;
4820 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004821
Gilles Peskine449bd832023-01-11 14:50:10 +01004822 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4823 PSA_KEY_USAGE_DECRYPT,
4824 alg);
4825 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004826 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004827 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004828
Gilles Peskineb47c3b32024-06-26 13:16:33 +02004829 if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004830 status = PSA_ERROR_INVALID_ARGUMENT;
4831 goto exit;
4832 }
4833
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004834 LOCAL_INPUT_ALLOC(input_external, input_length, input);
4835 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
4836
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004837 status = psa_driver_wrapper_cipher_decrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004838 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004839 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004840 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004841
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004842exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004843 unlock_status = psa_unregister_read_under_mutex(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004844 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004845 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004846 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004847
Gilles Peskine449bd832023-01-11 14:50:10 +01004848 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004849 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 }
Ronald Cron23919522021-07-08 19:00:07 +02004851
Gabor Mezei212eb082024-01-24 16:56:00 +01004852 LOCAL_INPUT_FREE(input_external, input);
4853 LOCAL_OUTPUT_FREE(output_external, output);
4854
Gilles Peskine449bd832023-01-11 14:50:10 +01004855 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004856}
4857
4858
mohammad16035955c982018-04-26 00:53:03 +03004859/****************************************************************/
4860/* AEAD */
4861/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004862
Paul Elliottbaff51c2021-09-28 17:44:45 +01004863/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004864static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004865{
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004867}
4868
4869/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004870static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4871 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004872{
Gilles Peskine449bd832023-01-11 14:50:10 +01004873 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004874
Gilles Peskine449bd832023-01-11 14:50:10 +01004875 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004876#if defined(PSA_WANT_ALG_GCM)
4877 case PSA_ALG_GCM:
4878 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004879 * arbitrarily large nonces. Please note that we do not generally
4880 * recommend the usage of nonces of greater length than
4881 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4882 * size, which can then lead to collisions if you encrypt a very
4883 * large number of messages.*/
4884 if (nonce_length != 0) {
4885 return PSA_SUCCESS;
4886 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004887 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004888#endif /* PSA_WANT_ALG_GCM */
4889#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004890 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004891 if (nonce_length >= 7 && nonce_length <= 13) {
4892 return PSA_SUCCESS;
4893 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004894 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004895#endif /* PSA_WANT_ALG_CCM */
4896#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004897 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004898 if (nonce_length == 12) {
4899 return PSA_SUCCESS;
4900 } else if (nonce_length == 8) {
4901 return PSA_ERROR_NOT_SUPPORTED;
4902 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004903 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004904#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004905 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004906 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004908 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004909
Gilles Peskine449bd832023-01-11 14:50:10 +01004910 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004911}
4912
Gilles Peskine449bd832023-01-11 14:50:10 +01004913static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004914{
Gilles Peskine449bd832023-01-11 14:50:10 +01004915 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4916 return PSA_ERROR_INVALID_ARGUMENT;
4917 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004918
Gilles Peskine449bd832023-01-11 14:50:10 +01004919 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004920}
4921
Gilles Peskine449bd832023-01-11 14:50:10 +01004922psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4923 psa_algorithm_t alg,
David Horstmann9d09a022023-11-28 19:25:00 +00004924 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004925 size_t nonce_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004926 const uint8_t *additional_data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004927 size_t additional_data_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004928 const uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004929 size_t plaintext_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004930 uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004931 size_t ciphertext_size,
4932 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004933{
Ronald Cron215633c2021-03-16 17:15:37 +01004934 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4935 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004936
David Horstmann9d09a022023-11-28 19:25:00 +00004937 LOCAL_INPUT_DECLARE(nonce_external, nonce);
4938 LOCAL_INPUT_DECLARE(additional_data_external, additional_data);
4939 LOCAL_INPUT_DECLARE(plaintext_external, plaintext);
4940 LOCAL_OUTPUT_DECLARE(ciphertext_external, ciphertext);
4941
mohammad1603f08a5502018-06-03 15:05:47 +03004942 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004943
Gilles Peskine449bd832023-01-11 14:50:10 +01004944 status = psa_aead_check_algorithm(alg);
4945 if (status != PSA_SUCCESS) {
4946 return status;
4947 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004948
Ronald Cron9a986162021-03-26 12:40:07 +01004949 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004950 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4951 if (status != PSA_SUCCESS) {
4952 return status;
4953 }
mohammad16035955c982018-04-26 00:53:03 +03004954
David Horstmann9d09a022023-11-28 19:25:00 +00004955 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
4956 LOCAL_INPUT_ALLOC(additional_data_external, additional_data_length, additional_data);
4957 LOCAL_INPUT_ALLOC(plaintext_external, plaintext_length, plaintext);
4958 LOCAL_OUTPUT_ALLOC(ciphertext_external, ciphertext_size, ciphertext);
4959
Gilles Peskine449bd832023-01-11 14:50:10 +01004960 status = psa_aead_check_nonce_length(alg, nonce_length);
4961 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004962 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004963 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004964
Ronald Cronde822812021-03-17 16:08:20 +01004965 status = psa_driver_wrapper_aead_encrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004966 &slot->attr, slot->key.data, slot->key.bytes,
Ronald Cron215633c2021-03-16 17:15:37 +01004967 alg,
4968 nonce, nonce_length,
4969 additional_data, additional_data_length,
4970 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004971 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004972
Gilles Peskine449bd832023-01-11 14:50:10 +01004973 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4974 memset(ciphertext, 0, ciphertext_size);
4975 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004976
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004977exit:
David Horstmann9d09a022023-11-28 19:25:00 +00004978 LOCAL_INPUT_FREE(nonce_external, nonce);
4979 LOCAL_INPUT_FREE(additional_data_external, additional_data);
4980 LOCAL_INPUT_FREE(plaintext_external, plaintext);
4981 LOCAL_OUTPUT_FREE(ciphertext_external, ciphertext);
4982
Ryan Everetta103ec92024-01-31 13:59:57 +00004983 psa_unregister_read_under_mutex(slot);
mohammad16035955c982018-04-26 00:53:03 +03004984
Gilles Peskine449bd832023-01-11 14:50:10 +01004985 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004986}
4987
Gilles Peskine449bd832023-01-11 14:50:10 +01004988psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4989 psa_algorithm_t alg,
David Horstmann7f2e0402023-11-28 19:43:53 +00004990 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004991 size_t nonce_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004992 const uint8_t *additional_data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004993 size_t additional_data_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004994 const uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004995 size_t ciphertext_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004996 uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004997 size_t plaintext_size,
4998 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004999{
Ronald Cron215633c2021-03-16 17:15:37 +01005000 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5001 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02005002
David Horstmann7f2e0402023-11-28 19:43:53 +00005003 LOCAL_INPUT_DECLARE(nonce_external, nonce);
5004 LOCAL_INPUT_DECLARE(additional_data_external, additional_data);
5005 LOCAL_INPUT_DECLARE(ciphertext_external, ciphertext);
5006 LOCAL_OUTPUT_DECLARE(plaintext_external, plaintext);
5007
Gilles Peskineee652a32018-06-01 19:23:52 +02005008 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03005009
Gilles Peskine449bd832023-01-11 14:50:10 +01005010 status = psa_aead_check_algorithm(alg);
5011 if (status != PSA_SUCCESS) {
5012 return status;
5013 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01005014
Ronald Cron9a986162021-03-26 12:40:07 +01005015 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01005016 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
5017 if (status != PSA_SUCCESS) {
5018 return status;
5019 }
mohammad16035955c982018-04-26 00:53:03 +03005020
David Horstmann7f2e0402023-11-28 19:43:53 +00005021 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
5022 LOCAL_INPUT_ALLOC(additional_data_external, additional_data_length,
5023 additional_data);
5024 LOCAL_INPUT_ALLOC(ciphertext_external, ciphertext_length, ciphertext);
5025 LOCAL_OUTPUT_ALLOC(plaintext_external, plaintext_size, plaintext);
5026
Gilles Peskine449bd832023-01-11 14:50:10 +01005027 status = psa_aead_check_nonce_length(alg, nonce_length);
5028 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01005029 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005030 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01005031
Ronald Cronde822812021-03-17 16:08:20 +01005032 status = psa_driver_wrapper_aead_decrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01005033 &slot->attr, slot->key.data, slot->key.bytes,
Ronald Cron215633c2021-03-16 17:15:37 +01005034 alg,
5035 nonce, nonce_length,
5036 additional_data, additional_data_length,
5037 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01005038 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02005039
Gilles Peskine449bd832023-01-11 14:50:10 +01005040 if (status != PSA_SUCCESS && plaintext_size != 0) {
5041 memset(plaintext, 0, plaintext_size);
5042 }
mohammad160360a64d02018-06-03 17:20:42 +03005043
Paul Elliottbb0f9e12021-09-28 11:14:27 +01005044exit:
David Horstmann7f2e0402023-11-28 19:43:53 +00005045 LOCAL_INPUT_FREE(nonce_external, nonce);
5046 LOCAL_INPUT_FREE(additional_data_external, additional_data);
5047 LOCAL_INPUT_FREE(ciphertext_external, ciphertext);
5048 LOCAL_OUTPUT_FREE(plaintext_external, plaintext);
5049
Ryan Everetta103ec92024-01-31 13:59:57 +00005050 psa_unregister_read_under_mutex(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01005051
Gilles Peskine449bd832023-01-11 14:50:10 +01005052 return status;
mohammad16035955c982018-04-26 00:53:03 +03005053}
5054
Gilles Peskine449bd832023-01-11 14:50:10 +01005055static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
5056{
5057 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01005058
Gilles Peskine449bd832023-01-11 14:50:10 +01005059 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02005060#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005061 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01005062 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005063 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
5064 return PSA_ERROR_INVALID_ARGUMENT;
5065 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01005066 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02005067#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01005068
Przemek Stekiel86679c72022-10-06 17:06:56 +02005069#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01005071 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005072 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
5073 return PSA_ERROR_INVALID_ARGUMENT;
5074 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01005075 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02005076#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01005077
Przemek Stekiel86679c72022-10-06 17:06:56 +02005078#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01005079 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01005080 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005081 if (tag_len != 16) {
5082 return PSA_ERROR_INVALID_ARGUMENT;
5083 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01005084 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02005085#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01005086
5087 default:
5088 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01005089 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01005090 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005091 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01005092}
5093
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005094/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005095static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
5096 int is_encrypt,
5097 mbedtls_svc_key_id_t key,
5098 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01005099{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005100 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5101 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
5102 psa_key_slot_t *slot = NULL;
5103 psa_key_usage_t key_usage = 0;
5104
Gilles Peskine449bd832023-01-11 14:50:10 +01005105 status = psa_aead_check_algorithm(alg);
5106 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005107 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 }
Paul Elliottc2b71442021-06-24 18:17:52 +01005109
Gilles Peskine449bd832023-01-11 14:50:10 +01005110 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005111 status = PSA_ERROR_BAD_STATE;
5112 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01005113 }
5114
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 if (operation->nonce_set || operation->lengths_set ||
5116 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005117 status = PSA_ERROR_BAD_STATE;
5118 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01005119 }
5120
Gilles Peskinea7a480b2025-02-05 19:41:52 +01005121 /* Make sure the driver-dependent part of the operation is zeroed.
5122 * This is a guarantee we make to drivers. Initializing the operation
5123 * does not necessarily take care of it, since the context is a
5124 * union and initializing a union does not necessarily initialize
5125 * all of its members. */
5126 memset(&operation->ctx, 0, sizeof(operation->ctx));
5127
Gilles Peskine449bd832023-01-11 14:50:10 +01005128 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005129 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005130 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005131 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005132 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005133
Gilles Peskine449bd832023-01-11 14:50:10 +01005134 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
5135 alg);
5136 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005137 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005138 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005139
Gilles Peskine449bd832023-01-11 14:50:10 +01005140 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02005141 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005142 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02005143
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 if (is_encrypt) {
5145 status = psa_driver_wrapper_aead_encrypt_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01005146 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01005147 slot->key.data,
5148 slot->key.bytes,
5149 alg);
5150 } else {
5151 status = psa_driver_wrapper_aead_decrypt_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01005152 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01005153 slot->key.data,
5154 slot->key.bytes,
5155 alg);
5156 }
5157 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005158 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005159 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005160
Gilles Peskine7a5d9202024-02-28 01:18:23 +01005161 operation->key_type = psa_get_key_type(&slot->attr);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005162
5163exit:
Ryan Everett9af70e52024-02-14 18:38:56 +00005164 unlock_status = psa_unregister_read_under_mutex(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005165
Gilles Peskine449bd832023-01-11 14:50:10 +01005166 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005167 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01005169 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 } else {
5171 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005172 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005173
Gilles Peskine449bd832023-01-11 14:50:10 +01005174 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01005175}
5176
Paul Elliott302ff6b2021-04-20 18:10:30 +01005177/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005178psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
5179 mbedtls_svc_key_id_t key,
5180 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005181{
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005183}
5184
5185/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005186psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
5187 mbedtls_svc_key_id_t key,
5188 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005189{
Gilles Peskine449bd832023-01-11 14:50:10 +01005190 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005191}
5192
David Horstmannfed23772023-12-19 17:49:20 +00005193static psa_status_t psa_aead_set_nonce_internal(psa_aead_operation_t *operation,
5194 const uint8_t *nonce,
5195 size_t nonce_length)
5196{
5197 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5198
5199 if (operation->id == 0) {
5200 status = PSA_ERROR_BAD_STATE;
5201 goto exit;
5202 }
5203
5204 if (operation->nonce_set) {
5205 status = PSA_ERROR_BAD_STATE;
5206 goto exit;
5207 }
5208
5209 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
5210 if (status != PSA_SUCCESS) {
5211 status = PSA_ERROR_INVALID_ARGUMENT;
5212 goto exit;
5213 }
5214
5215 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
5216 nonce_length);
5217
5218exit:
5219 if (status == PSA_SUCCESS) {
5220 operation->nonce_set = 1;
5221 } else {
5222 psa_aead_abort(operation);
5223 }
5224
5225 return status;
5226}
5227
Paul Elliott302ff6b2021-04-20 18:10:30 +01005228/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01005229psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
David Horstmannd3cad8b2023-12-11 14:46:04 +00005230 uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005231 size_t nonce_size,
5232 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005233{
5234 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01005235 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07005236 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005237
David Horstmannd3cad8b2023-12-11 14:46:04 +00005238 LOCAL_OUTPUT_DECLARE(nonce_external, nonce);
5239 LOCAL_OUTPUT_ALLOC(nonce_external, nonce_size, nonce);
5240
Paul Elliott8eb9daf2021-06-04 16:42:21 +01005241 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005242
Gilles Peskine449bd832023-01-11 14:50:10 +01005243 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005244 status = PSA_ERROR_BAD_STATE;
5245 goto exit;
5246 }
5247
Gilles Peskine449bd832023-01-11 14:50:10 +01005248 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005249 status = PSA_ERROR_BAD_STATE;
5250 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005251 }
5252
Paul Elliotte193ea82021-10-01 13:00:16 +01005253 /* For CCM, this size may not be correct according to the PSA
5254 * specification. The PSA Crypto 1.0.1 specification states:
5255 *
5256 * CCM encodes the plaintext length pLen in L octets, with L the smallest
5257 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
5258 *
5259 * However this restriction that L has to be the smallest integer is not
5260 * applied in practice, and it is not implementable here since the
5261 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005262 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
5263 operation->alg);
5264 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005265 status = PSA_ERROR_BUFFER_TOO_SMALL;
5266 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005267 }
5268
David Horstmann6e99bb22024-02-06 15:27:49 +00005269 status = psa_generate_random_internal(local_nonce, required_nonce_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01005270 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005271 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005272 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01005273
David Horstmannfed23772023-12-19 17:49:20 +00005274 status = psa_aead_set_nonce_internal(operation, local_nonce,
5275 required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005276
Paul Elliott39dc6b82021-05-11 19:16:09 +01005277exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005278 if (status == PSA_SUCCESS) {
5279 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005280 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01005281 } else {
5282 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01005283 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005284
David Horstmannd3cad8b2023-12-11 14:46:04 +00005285 LOCAL_OUTPUT_FREE(nonce_external, nonce);
5286
Gilles Peskine449bd832023-01-11 14:50:10 +01005287 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005288}
5289
5290/* Set the nonce for a multipart authenticated encryption or decryption
5291 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005292psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
David Horstmann8f0ef512023-12-11 15:17:11 +00005293 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005294 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005295{
David Horstmannfed23772023-12-19 17:49:20 +00005296 psa_status_t status;
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005297
David Horstmann8f0ef512023-12-11 15:17:11 +00005298 LOCAL_INPUT_DECLARE(nonce_external, nonce);
5299 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
Paul Elliottcee785c2021-05-20 14:29:20 +01005300
David Horstmannfed23772023-12-19 17:49:20 +00005301 status = psa_aead_set_nonce_internal(operation, nonce, nonce_length);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005302
David Horstmann18dc0322023-12-20 16:16:43 +00005303/* Exit label is only needed for buffer copying, prevent unused warnings. */
David Horstmann4a48bec2024-03-13 15:42:31 +00005304#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Paul Elliott39dc6b82021-05-11 19:16:09 +01005305exit:
David Horstmann18dc0322023-12-20 16:16:43 +00005306#endif
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005307
David Horstmann8f0ef512023-12-11 15:17:11 +00005308 LOCAL_INPUT_FREE(nonce_external, nonce);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005309
Gilles Peskine449bd832023-01-11 14:50:10 +01005310 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005311}
5312
5313/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005314psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
5315 size_t ad_length,
5316 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005317{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005318 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5319
Gilles Peskine449bd832023-01-11 14:50:10 +01005320 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005321 status = PSA_ERROR_BAD_STATE;
5322 goto exit;
5323 }
5324
Gilles Peskine449bd832023-01-11 14:50:10 +01005325 if (operation->lengths_set || operation->ad_started ||
5326 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005327 status = PSA_ERROR_BAD_STATE;
5328 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005329 }
5330
Gilles Peskine449bd832023-01-11 14:50:10 +01005331 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005332#if defined(PSA_WANT_ALG_GCM)
5333 case PSA_ALG_GCM:
5334 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01005335 * bits. Without the guard this code will generate warnings on 32bit
5336 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01005337#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01005338 if (((uint64_t) ad_length) >> 61 != 0 ||
5339 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005340 status = PSA_ERROR_INVALID_ARGUMENT;
5341 goto exit;
5342 }
Paul Elliott325d3742021-09-27 17:56:28 +01005343#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005344 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005345#endif /* PSA_WANT_ALG_GCM */
5346#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005347 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01005348 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005349 status = PSA_ERROR_INVALID_ARGUMENT;
5350 goto exit;
5351 }
5352 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005353#endif /* PSA_WANT_ALG_CCM */
5354#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005355 case PSA_ALG_CHACHA20_POLY1305:
5356 /* No length restrictions for ChaChaPoly. */
5357 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005358#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005359 default:
5360 break;
5361 }
Paul Elliott325d3742021-09-27 17:56:28 +01005362
Gilles Peskine449bd832023-01-11 14:50:10 +01005363 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
5364 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005365
Paul Elliott39dc6b82021-05-11 19:16:09 +01005366exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005367 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005368 operation->ad_remaining = ad_length;
5369 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01005370 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005371 } else {
5372 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01005373 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005374
Gilles Peskine449bd832023-01-11 14:50:10 +01005375 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005376}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005377
5378/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005379psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
David Horstmann25dac6e2023-12-11 15:23:13 +00005380 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005382{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005383 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5384
David Horstmann25dac6e2023-12-11 15:23:13 +00005385 LOCAL_INPUT_DECLARE(input_external, input);
5386 LOCAL_INPUT_ALLOC(input_external, input_length, input);
5387
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005389 status = PSA_ERROR_BAD_STATE;
5390 goto exit;
5391 }
5392
Gilles Peskine449bd832023-01-11 14:50:10 +01005393 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005394 status = PSA_ERROR_BAD_STATE;
5395 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005396 }
5397
Paul Elliott304766f2024-04-26 18:30:11 +01005398 /* No input to add (zero length), nothing to do. */
5399 if (input_length == 0) {
5400 status = PSA_SUCCESS;
5401 goto exit;
5402 }
5403
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 if (operation->lengths_set) {
5405 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005406 status = PSA_ERROR_INVALID_ARGUMENT;
5407 goto exit;
5408 }
5409
5410 operation->ad_remaining -= input_length;
5411 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005412#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005413 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005414 status = PSA_ERROR_BAD_STATE;
5415 goto exit;
5416 }
5417#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005418
Gilles Peskine449bd832023-01-11 14:50:10 +01005419 status = psa_driver_wrapper_aead_update_ad(operation, input,
5420 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005421
Paul Elliott39dc6b82021-05-11 19:16:09 +01005422exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005424 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005425 } else {
5426 psa_aead_abort(operation);
5427 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005428
David Horstmann25dac6e2023-12-11 15:23:13 +00005429 LOCAL_INPUT_FREE(input_external, input);
5430
Gilles Peskine449bd832023-01-11 14:50:10 +01005431 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005432}
5433
5434/* Encrypt or decrypt a message fragment in an active multipart AEAD
5435 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005436psa_status_t psa_aead_update(psa_aead_operation_t *operation,
David Horstmann2914fac2023-12-11 15:28:37 +00005437 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005438 size_t input_length,
David Horstmann2914fac2023-12-11 15:28:37 +00005439 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005440 size_t output_size,
5441 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005442{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005443 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005444
David Horstmann2914fac2023-12-11 15:28:37 +00005445
5446 LOCAL_INPUT_DECLARE(input_external, input);
5447 LOCAL_OUTPUT_DECLARE(output_external, output);
5448
5449 LOCAL_INPUT_ALLOC(input_external, input_length, input);
5450 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
5451
Paul Elliott302ff6b2021-04-20 18:10:30 +01005452 *output_length = 0;
5453
Gilles Peskine449bd832023-01-11 14:50:10 +01005454 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005455 status = PSA_ERROR_BAD_STATE;
5456 goto exit;
5457 }
5458
Gilles Peskine449bd832023-01-11 14:50:10 +01005459 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005460 status = PSA_ERROR_BAD_STATE;
5461 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005462 }
5463
Gilles Peskine449bd832023-01-11 14:50:10 +01005464 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005465 /* Additional data length was supplied, but not all the additional
5466 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005467 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005468 status = PSA_ERROR_INVALID_ARGUMENT;
5469 goto exit;
5470 }
5471
5472 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005473 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005474 status = PSA_ERROR_INVALID_ARGUMENT;
5475 goto exit;
5476 }
5477
5478 operation->body_remaining -= input_length;
5479 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005480#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005481 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005482 status = PSA_ERROR_BAD_STATE;
5483 goto exit;
5484 }
5485#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005486
Gilles Peskine449bd832023-01-11 14:50:10 +01005487 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5488 output, output_size,
5489 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005490
Paul Elliott39dc6b82021-05-11 19:16:09 +01005491exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005492 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005493 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005494 } else {
5495 psa_aead_abort(operation);
5496 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005497
David Horstmann2914fac2023-12-11 15:28:37 +00005498 LOCAL_INPUT_FREE(input_external, input);
5499 LOCAL_OUTPUT_FREE(output_external, output);
5500
Gilles Peskine449bd832023-01-11 14:50:10 +01005501 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005502}
5503
Gilles Peskine449bd832023-01-11 14:50:10 +01005504static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005505{
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 if (operation->id == 0 || !operation->nonce_set) {
5507 return PSA_ERROR_BAD_STATE;
5508 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005509
Gilles Peskine449bd832023-01-11 14:50:10 +01005510 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5511 operation->body_remaining != 0)) {
5512 return PSA_ERROR_INVALID_ARGUMENT;
5513 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005514
Gilles Peskine449bd832023-01-11 14:50:10 +01005515 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005516}
5517
Paul Elliott302ff6b2021-04-20 18:10:30 +01005518/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005519psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
David Horstmann6db0e732023-12-11 15:35:59 +00005520 uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005521 size_t ciphertext_size,
5522 size_t *ciphertext_length,
David Horstmann6db0e732023-12-11 15:35:59 +00005523 uint8_t *tag_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005524 size_t tag_size,
5525 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005526{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005527 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5528
David Horstmann6db0e732023-12-11 15:35:59 +00005529 LOCAL_OUTPUT_DECLARE(ciphertext_external, ciphertext);
5530 LOCAL_OUTPUT_DECLARE(tag_external, tag);
5531
5532 LOCAL_OUTPUT_ALLOC(ciphertext_external, ciphertext_size, ciphertext);
5533 LOCAL_OUTPUT_ALLOC(tag_external, tag_size, tag);
5534
Paul Elliott302ff6b2021-04-20 18:10:30 +01005535 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005536 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005537
Gilles Peskine449bd832023-01-11 14:50:10 +01005538 status = psa_aead_final_checks(operation);
5539 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005540 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005541 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005542
Gilles Peskine449bd832023-01-11 14:50:10 +01005543 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005544 status = PSA_ERROR_BAD_STATE;
5545 goto exit;
5546 }
5547
Gilles Peskine449bd832023-01-11 14:50:10 +01005548 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5549 ciphertext_size,
5550 ciphertext_length,
5551 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005552
Paul Elliott39dc6b82021-05-11 19:16:09 +01005553exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005554
5555
Paul Elliottf47b0952021-05-21 18:02:33 +01005556 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005557 * the zero tag size, make sure the tag is set to something implausible.
5558 * Even if the operation succeeds, make sure we clear the rest of the
5559 * buffer to prevent potential leakage of anything previously placed in
5560 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005561 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005562
Gilles Peskine449bd832023-01-11 14:50:10 +01005563 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005564
David Horstmann6db0e732023-12-11 15:35:59 +00005565 LOCAL_OUTPUT_FREE(ciphertext_external, ciphertext);
5566 LOCAL_OUTPUT_FREE(tag_external, tag);
5567
Gilles Peskine449bd832023-01-11 14:50:10 +01005568 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005569}
5570
5571/* Finish authenticating and decrypting a message in a multipart AEAD
5572 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005573psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
David Horstmanne000a0a2023-12-11 16:37:04 +00005574 uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005575 size_t plaintext_size,
5576 size_t *plaintext_length,
David Horstmanne000a0a2023-12-11 16:37:04 +00005577 const uint8_t *tag_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005578 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005579{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005580 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5581
David Horstmanne000a0a2023-12-11 16:37:04 +00005582 LOCAL_OUTPUT_DECLARE(plaintext_external, plaintext);
5583 LOCAL_INPUT_DECLARE(tag_external, tag);
5584
5585 LOCAL_OUTPUT_ALLOC(plaintext_external, plaintext_size, plaintext);
5586 LOCAL_INPUT_ALLOC(tag_external, tag_length, tag);
5587
Paul Elliott302ff6b2021-04-20 18:10:30 +01005588 *plaintext_length = 0;
5589
Gilles Peskine449bd832023-01-11 14:50:10 +01005590 status = psa_aead_final_checks(operation);
5591 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005592 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005593 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005594
Gilles Peskine449bd832023-01-11 14:50:10 +01005595 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005596 status = PSA_ERROR_BAD_STATE;
5597 goto exit;
5598 }
5599
Gilles Peskine449bd832023-01-11 14:50:10 +01005600 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5601 plaintext_size,
5602 plaintext_length,
5603 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005604
5605exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005606 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005607
David Horstmanne000a0a2023-12-11 16:37:04 +00005608 LOCAL_OUTPUT_FREE(plaintext_external, plaintext);
5609 LOCAL_INPUT_FREE(tag_external, tag);
5610
Gilles Peskine449bd832023-01-11 14:50:10 +01005611 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005612}
5613
5614/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005615psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005616{
5617 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5618
Gilles Peskine449bd832023-01-11 14:50:10 +01005619 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005620 /* The object has (apparently) been initialized but it is not (yet)
5621 * in use. It's ok to call abort on such an object, and there's
5622 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005623 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005624 }
5625
Gilles Peskine449bd832023-01-11 14:50:10 +01005626 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005627
Gilles Peskine449bd832023-01-11 14:50:10 +01005628 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005629
Gilles Peskine449bd832023-01-11 14:50:10 +01005630 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005631}
5632
Gilles Peskinee59236f2018-01-27 23:32:46 +01005633/****************************************************************/
Gilles Peskinecdb37812025-02-05 18:02:49 +01005634/* Key derivation: output generation */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005635/****************************************************************/
5636
Przemek Stekiel69c46792022-06-10 12:59:51 +02005637#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005638 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005639 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305640 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305641 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005642#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005643#endif /* At least one builtin KDF */
5644
Przemek Stekiel69c46792022-06-10 12:59:51 +02005645#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005646 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5647 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5648static psa_status_t psa_key_derivation_start_hmac(
5649 psa_mac_operation_t *operation,
5650 psa_algorithm_t hash_alg,
5651 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005652 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005653{
5654 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5655 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005656 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5657 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5658 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005659
Steven Cooreman72f736a2021-05-07 14:14:37 +02005660 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005661 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005662
Gilles Peskine449bd832023-01-11 14:50:10 +01005663 status = psa_driver_wrapper_mac_sign_setup(operation,
5664 &attributes,
5665 hmac_key, hmac_key_length,
5666 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005667
Gilles Peskine449bd832023-01-11 14:50:10 +01005668 psa_reset_key_attributes(&attributes);
5669 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005670}
5671#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005672
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005673#define HKDF_STATE_INIT 0 /* no input yet */
5674#define HKDF_STATE_STARTED 1 /* got salt */
5675#define HKDF_STATE_KEYED 2 /* got key */
5676#define HKDF_STATE_OUTPUT 3 /* output started */
5677
Gilles Peskinecbe66502019-05-16 16:59:18 +02005678static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005679 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005680{
Gilles Peskine449bd832023-01-11 14:50:10 +01005681 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5682 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5683 } else {
5684 return operation->alg;
5685 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005686}
5687
Gilles Peskine449bd832023-01-11 14:50:10 +01005688psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005689{
5690 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005691 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5692 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005693 /* The object has (apparently) been initialized but it is not
5694 * in use. It's ok to call abort on such an object, and there's
5695 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005696 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005697#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005698 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5699 mbedtls_free(operation->ctx.hkdf.info);
5700 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5701 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005702#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005703#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5704 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005705 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5706 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5707 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5708 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005709 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005710 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005711 }
5712
Gilles Peskine449bd832023-01-11 14:50:10 +01005713 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005714 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005715 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005716 }
5717
Gilles Peskine449bd832023-01-11 14:50:10 +01005718 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005719 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005720 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005721 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005722#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005723 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005724 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005725 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005726 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005727#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005728 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005729
5730 /* We leave the fields Ai and output_block to be erased safely by the
5731 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005732 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005733#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5734 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005735#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005736 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5737 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5738 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5739 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005740#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305741#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305742 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305743 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005744 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305745 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305746 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305747
5748 status = PSA_SUCCESS;
5749 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305750#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005751 {
5752 status = PSA_ERROR_BAD_STATE;
5753 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005754 mbedtls_platform_zeroize(operation, sizeof(*operation));
5755 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005756}
5757
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005758psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005759 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005760{
Gilles Peskine449bd832023-01-11 14:50:10 +01005761 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005762 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005763 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005764 }
5765
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005766 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005767 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005768}
5769
Gilles Peskine449bd832023-01-11 14:50:10 +01005770psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5771 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005772{
Gilles Peskine449bd832023-01-11 14:50:10 +01005773 if (operation->alg == 0) {
5774 return PSA_ERROR_BAD_STATE;
5775 }
5776 if (capacity > operation->capacity) {
5777 return PSA_ERROR_INVALID_ARGUMENT;
5778 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005779 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005780 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005781}
5782
Przemek Stekiel69c46792022-06-10 12:59:51 +02005783#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005784/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005785static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5786 psa_algorithm_t kdf_alg,
5787 uint8_t *output,
5788 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005789{
Gilles Peskine449bd832023-01-11 14:50:10 +01005790 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5791 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005792 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005793 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005794#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005795 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005796#else
5797 const uint8_t last_block = 0xff;
5798#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005799
Gilles Peskine449bd832023-01-11 14:50:10 +01005800 if (hkdf->state < HKDF_STATE_KEYED ||
5801 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005802#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005803 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005804#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005805 )) {
5806 return PSA_ERROR_BAD_STATE;
5807 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005808 hkdf->state = HKDF_STATE_OUTPUT;
5809
Gilles Peskine449bd832023-01-11 14:50:10 +01005810 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005811 /* Copy what remains of the current block */
5812 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005813 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005814 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005815 }
5816 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005817 output += n;
5818 output_length -= n;
5819 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005820 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005821 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005822 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005823 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005824 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005825 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005826 * object was corrupted or if this function is called directly
5827 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005828 if (hkdf->block_number == last_block) {
5829 return PSA_ERROR_BAD_STATE;
5830 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005831
5832 /* We need a new block */
5833 ++hkdf->block_number;
5834 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005835
Gilles Peskine449bd832023-01-11 14:50:10 +01005836 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5837 hash_alg,
5838 hkdf->prk,
5839 hash_length);
5840 if (status != PSA_SUCCESS) {
5841 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005842 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005843
5844 if (hkdf->block_number != 1) {
5845 status = psa_mac_update(&hkdf->hmac,
5846 hkdf->output_block,
5847 hash_length);
5848 if (status != PSA_SUCCESS) {
5849 return status;
5850 }
5851 }
5852 status = psa_mac_update(&hkdf->hmac,
5853 hkdf->info,
5854 hkdf->info_length);
5855 if (status != PSA_SUCCESS) {
5856 return status;
5857 }
5858 status = psa_mac_update(&hkdf->hmac,
5859 &hkdf->block_number, 1);
5860 if (status != PSA_SUCCESS) {
5861 return status;
5862 }
5863 status = psa_mac_sign_finish(&hkdf->hmac,
5864 hkdf->output_block,
5865 sizeof(hkdf->output_block),
5866 &hmac_output_length);
5867 if (status != PSA_SUCCESS) {
5868 return status;
5869 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005870 }
5871
Gilles Peskine449bd832023-01-11 14:50:10 +01005872 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005873}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005874#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005875
John Durkop07cc04a2020-11-16 22:08:34 -08005876#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5877 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005878static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5879 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005880 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005881{
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5883 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005884 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5885 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005886 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005887
Janos Follath7742fee2019-06-17 12:58:10 +01005888 /* We can't be wanting more output after block 0xff, otherwise
5889 * the capacity check in psa_key_derivation_output_bytes() would have
5890 * prevented this call. It could happen only if the operation
5891 * object was corrupted or if this function is called directly
5892 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005893 if (tls12_prf->block_number == 0xff) {
5894 return PSA_ERROR_CORRUPTION_DETECTED;
5895 }
Janos Follath7742fee2019-06-17 12:58:10 +01005896
5897 /* We need a new block */
5898 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005899 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005900
5901 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5902 *
5903 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5904 *
5905 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5906 * HMAC_hash(secret, A(2) + seed) +
5907 * HMAC_hash(secret, A(3) + seed) + ...
5908 *
5909 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005910 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005911 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005912 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005913 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005914 * is currently extracted as `output_block` and where i is
5915 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005916 */
5917
Gilles Peskine449bd832023-01-11 14:50:10 +01005918 status = psa_key_derivation_start_hmac(&hmac,
5919 hash_alg,
5920 tls12_prf->secret,
5921 tls12_prf->secret_length);
5922 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005923 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005924 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005925
5926 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005927 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005928 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5929 * the variable seed and in this instance means it in the context of the
5930 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005931 status = psa_mac_update(&hmac,
5932 tls12_prf->label,
5933 tls12_prf->label_length);
5934 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005935 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005936 }
5937 status = psa_mac_update(&hmac,
5938 tls12_prf->seed,
5939 tls12_prf->seed_length);
5940 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005941 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005942 }
5943 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005944 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005945 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5946 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005947 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005948 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005949 }
5950
Gilles Peskine449bd832023-01-11 14:50:10 +01005951 status = psa_mac_sign_finish(&hmac,
5952 tls12_prf->Ai, hash_length,
5953 &hmac_output_length);
5954 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005955 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005956 }
5957 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005958 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005959 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005960
5961 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005962 status = psa_key_derivation_start_hmac(&hmac,
5963 hash_alg,
5964 tls12_prf->secret,
5965 tls12_prf->secret_length);
5966 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005967 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005968 }
5969 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5970 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005971 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005972 }
5973 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5974 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005975 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005976 }
5977 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5978 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005979 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005980 }
5981 status = psa_mac_sign_finish(&hmac,
5982 tls12_prf->output_block, hash_length,
5983 &hmac_output_length);
5984 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005985 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005986 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005987
Janos Follath7742fee2019-06-17 12:58:10 +01005988
5989cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005990 cleanup_status = psa_mac_abort(&hmac);
5991 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005992 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005993 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005994
Gilles Peskine449bd832023-01-11 14:50:10 +01005995 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005996}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005997
Janos Follath844eb0e2019-06-19 12:10:49 +01005998static psa_status_t psa_key_derivation_tls12_prf_read(
5999 psa_tls12_prf_key_derivation_t *tls12_prf,
6000 psa_algorithm_t alg,
6001 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01006002 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01006003{
Gilles Peskine449bd832023-01-11 14:50:10 +01006004 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
6005 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01006006 psa_status_t status;
6007 uint8_t offset, length;
6008
Gilles Peskine449bd832023-01-11 14:50:10 +01006009 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02006010 case PSA_TLS12_PRF_STATE_LABEL_SET:
6011 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
6012 break;
6013 case PSA_TLS12_PRF_STATE_OUTPUT:
6014 break;
6015 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006016 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02006017 }
6018
Gilles Peskine449bd832023-01-11 14:50:10 +01006019 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01006020 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 if (tls12_prf->left_in_block == 0) {
6022 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
6023 alg);
6024 if (status != PSA_SUCCESS) {
6025 return status;
6026 }
Janos Follath844eb0e2019-06-19 12:10:49 +01006027
6028 continue;
6029 }
6030
Gilles Peskine449bd832023-01-11 14:50:10 +01006031 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01006032 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006033 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01006034 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01006035 }
Janos Follath844eb0e2019-06-19 12:10:49 +01006036
6037 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01006038 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01006039 output += length;
6040 output_length -= length;
6041 tls12_prf->left_in_block -= length;
6042 }
6043
Gilles Peskine449bd832023-01-11 14:50:10 +01006044 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01006045}
John Durkop07cc04a2020-11-16 22:08:34 -08006046#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
6047 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02006048
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006049#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6050static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
6051 psa_tls12_ecjpake_to_pms_t *ecjpake,
6052 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01006053 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006054{
6055 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006056 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006057
Gilles Peskine449bd832023-01-11 14:50:10 +01006058 if (output_length != 32) {
6059 return PSA_ERROR_INVALID_ARGUMENT;
6060 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006061
Gilles Peskine449bd832023-01-11 14:50:10 +01006062 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
6063 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
6064 &output_size);
6065 if (status != PSA_SUCCESS) {
6066 return status;
6067 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006068
Gilles Peskine449bd832023-01-11 14:50:10 +01006069 if (output_size != output_length) {
6070 return PSA_ERROR_GENERIC_ERROR;
6071 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006072
Gilles Peskine449bd832023-01-11 14:50:10 +01006073 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006074}
6075#endif
6076
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306077#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306078static psa_status_t psa_key_derivation_pbkdf2_generate_block(
6079 psa_pbkdf2_key_derivation_t *pbkdf2,
6080 psa_algorithm_t prf_alg,
6081 uint8_t prf_output_length,
6082 psa_key_attributes_t *attributes)
6083{
6084 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05306085 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306086 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05306087 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05306088 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306089 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05306090 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306091
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05306092 mac_operation.is_sign = 1;
6093 mac_operation.mac_size = prf_output_length;
6094 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306095
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05306096 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
6097 attributes,
6098 pbkdf2->password,
6099 pbkdf2->password_length,
6100 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306101 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05306102 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306103 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05306104 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
6105 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05306106 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05306107 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05306108 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05306109 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05306110 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05306111 }
6112 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
6113 &mac_output_length);
6114 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05306115 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05306116 }
6117
6118 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05306119 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05306120 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05306121 }
6122
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05306123 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306124
6125 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05306126 /* We are passing prf_output_length as mac_size because the driver
6127 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306128 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306129 status = psa_driver_wrapper_mac_compute(attributes,
6130 pbkdf2->password,
6131 pbkdf2->password_length,
6132 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05306133 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306134 &mac_output_length);
6135 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05306136 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306137 }
6138
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05306139 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306140 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05306141
6142cleanup:
6143 /* Zeroise buffers to clear sensitive data from memory. */
6144 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
6145 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306146}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05306147
6148static psa_status_t psa_key_derivation_pbkdf2_read(
6149 psa_pbkdf2_key_derivation_t *pbkdf2,
6150 psa_algorithm_t kdf_alg,
6151 uint8_t *output,
6152 size_t output_length)
6153{
6154 psa_status_t status;
6155 psa_algorithm_t prf_alg;
6156 uint8_t prf_output_length;
6157 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
6158 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
6159 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
6160
6161 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6162 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
6163 prf_output_length = PSA_HASH_LENGTH(prf_alg);
6164 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05306165 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6166 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306167 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05306168 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05306169 } else {
6170 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05306171 }
6172
6173 switch (pbkdf2->state) {
6174 case PSA_PBKDF2_STATE_PASSWORD_SET:
6175 /* Initially we need a new block so bytes_used is equal to block size*/
6176 pbkdf2->bytes_used = prf_output_length;
6177 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
6178 break;
6179 case PSA_PBKDF2_STATE_OUTPUT:
6180 break;
6181 default:
6182 return PSA_ERROR_BAD_STATE;
6183 }
6184
6185 while (output_length != 0) {
6186 uint8_t n = prf_output_length - pbkdf2->bytes_used;
6187 if (n > output_length) {
6188 n = (uint8_t) output_length;
6189 }
6190 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
6191 output += n;
6192 output_length -= n;
6193 pbkdf2->bytes_used += n;
6194
6195 if (output_length == 0) {
6196 break;
6197 }
6198
6199 /* We need a new block */
6200 pbkdf2->bytes_used = 0;
6201 pbkdf2->block_number++;
6202
6203 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
6204 prf_output_length,
6205 &attributes);
6206 if (status != PSA_SUCCESS) {
6207 return status;
6208 }
6209 }
6210
6211 return PSA_SUCCESS;
6212}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306213#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306214
Janos Follath6c6c8fc2019-06-17 12:38:20 +01006215psa_status_t psa_key_derivation_output_bytes(
6216 psa_key_derivation_operation_t *operation,
Ryan Everettf943e222024-01-19 14:46:39 +00006217 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01006218 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006219{
6220 psa_status_t status;
Ryan Everettf943e222024-01-19 14:46:39 +00006221 LOCAL_OUTPUT_DECLARE(output_external, output);
6222
Gilles Peskine449bd832023-01-11 14:50:10 +01006223 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02006224
Gilles Peskine449bd832023-01-11 14:50:10 +01006225 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006226 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006227 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006228 }
6229
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006231 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006232 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02006233 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
6234 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006235 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02006236 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006237 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006238 }
Ryan Everettf943e222024-01-19 14:46:39 +00006239
6240 LOCAL_OUTPUT_ALLOC(output_external, output_length, output);
Ryan Everettda9227d2024-01-25 11:37:22 +00006241 if (output_length > operation->capacity) {
6242 operation->capacity = 0;
6243 /* Go through the error path to wipe all confidential data now
6244 * that the operation object is useless. */
6245 status = PSA_ERROR_INSUFFICIENT_DATA;
6246 goto exit;
6247 }
6248
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006249 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006250
Przemek Stekiel69c46792022-06-10 12:59:51 +02006251#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006252 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6253 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
6254 output, output_length);
6255 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006256#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006257#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6258 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006259 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6260 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6261 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
6262 kdf_alg, output,
6263 output_length);
6264 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006265#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
6266 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006267#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006268 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006269 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01006270 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
6271 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006272#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306273#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306274 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05306275 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
6276 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05306277 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306278#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006279
Gilles Peskineeab56e42018-07-12 17:12:33 +02006280 {
Steven Cooreman74afe472021-02-10 17:19:22 +01006281 (void) kdf_alg;
Ryan Everettf943e222024-01-19 14:46:39 +00006282 status = PSA_ERROR_BAD_STATE;
6283 LOCAL_OUTPUT_FREE(output_external, output);
6284
6285 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006286 }
6287
6288exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006289 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006290 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006291 * This allows us to differentiate between exhausted operations and
6292 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
6293 * operations. */
6294 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006295 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006296 operation->alg = alg;
Ryan Everettee5920a2024-02-09 15:09:28 +00006297 if (output != NULL) {
6298 memset(output, '!', output_length);
6299 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006300 }
Ryan Everettda9227d2024-01-25 11:37:22 +00006301
6302 LOCAL_OUTPUT_FREE(output_external, output);
Gilles Peskine449bd832023-01-11 14:50:10 +01006303 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006304}
6305
David Brown7807bf72021-02-09 16:28:23 -07006306#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006307static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02006308{
Gilles Peskine449bd832023-01-11 14:50:10 +01006309 if (data_size >= 8) {
6310 mbedtls_des_key_set_parity(data);
6311 }
6312 if (data_size >= 16) {
6313 mbedtls_des_key_set_parity(data + 8);
6314 }
6315 if (data_size >= 24) {
6316 mbedtls_des_key_set_parity(data + 16);
6317 }
Gilles Peskine08542d82018-07-19 17:05:42 +02006318}
David Brown7807bf72021-02-09 16:28:23 -07006319#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02006320
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006321/*
Gilles Peskine449bd832023-01-11 14:50:10 +01006322 * ECC keys on a Weierstrass elliptic curve require the generation
6323 * of a private key which is an integer
6324 * in the range [1, N - 1], where N is the boundary of the private key domain:
6325 * N is the prime p for Diffie-Hellman, or the order of the
6326 * curve’s base point for ECC.
6327 *
6328 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
6329 * This function generates the private key using the following process:
6330 *
6331 * 1. Draw a byte string of length ceiling(m/8) bytes.
6332 * 2. If m is not a multiple of 8, set the most significant
6333 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
6334 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
6335 * 4. If k > N - 2, discard the result and return to step 1.
6336 * 5. Output k + 1 as the private key.
6337 *
6338 * This method allows compliance to NIST standards, specifically the methods titled
6339 * Key-Pair Generation by Testing Candidates in the following publications:
6340 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
6341 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
6342 * Diffie-Hellman keys.
6343 *
6344 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
6345 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
6346 *
6347 * Note: Function allocates memory for *data buffer, so given *data should be
6348 * always NULL.
6349 */
Valerio Setti86587ab2023-06-27 13:09:30 +02006350#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
6351#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006352static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006353 psa_key_slot_t *slot,
6354 size_t bits,
6355 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006356 uint8_t **data
6357 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006358{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006359 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006360 mbedtls_mpi k;
6361 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006362 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006363 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006364 size_t m;
Gilles Peskinece726b22025-03-06 19:27:50 +01006365 size_t m_bytes = 0;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006366
Gilles Peskine449bd832023-01-11 14:50:10 +01006367 mbedtls_mpi_init(&k);
6368 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006369
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006370 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01006371 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006372 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01006373 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006374
Gilles Peskine449bd832023-01-11 14:50:10 +01006375 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006376 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01006377 goto cleanup;
6378 }
6379
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006380 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01006381 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006382
Gilles Peskine449bd832023-01-11 14:50:10 +01006383 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006384
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006385 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006386 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006387 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006388
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006389 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006390
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006391 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006392 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006393
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006394 /* Note: This function is always called with *data == NULL and it
6395 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006396 *data = mbedtls_calloc(1, m_bytes);
6397 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006398 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006399 goto cleanup;
6400 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006401
Gilles Peskine449bd832023-01-11 14:50:10 +01006402 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006403 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006404 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006405 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01006406 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006407
6408 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006409 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006410 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006411 * (8 * ceiling(m/8) - m) bits of the first byte in
6412 * the string to zero.
6413 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006414 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006415 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006416 }
6417
6418 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01006419 * big-endian byte string.
6420 */
6421 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006422
6423 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01006424 * Result of comparison is returned. When it indicates error
6425 * then this function is called again.
6426 */
6427 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006428 }
6429
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006430 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006431 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6432 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006433cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006434 if (ret != 0) {
6435 status = mbedtls_to_psa_error(ret);
6436 }
6437 if (status != PSA_SUCCESS) {
Gilles Peskine184cac12025-03-06 12:42:30 +01006438 mbedtls_zeroize_and_free(*data, m_bytes);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006439 *data = NULL;
6440 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006441 mbedtls_mpi_free(&k);
6442 mbedtls_mpi_free(&diff_N_2);
6443 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006444}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006445
6446/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6447 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6448 *
6449 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6450 * draw a 32-byte string and process it as specified in
6451 * Elliptic Curves for Security [RFC7748] §5.
6452 *
6453 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6454 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6455 *
6456 * Note: Function allocates memory for *data buffer, so given *data should be
6457 * always NULL.
6458 */
6459
6460static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6461 size_t bits,
6462 psa_key_derivation_operation_t *operation,
6463 uint8_t **data
6464 )
6465{
6466 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006467 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006468
Gilles Peskine449bd832023-01-11 14:50:10 +01006469 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006470 case 255:
6471 output_length = 32;
6472 break;
6473 case 448:
6474 output_length = 56;
6475 break;
6476 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006477 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006478 break;
6479 }
6480
Gilles Peskine449bd832023-01-11 14:50:10 +01006481 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006482
Gilles Peskine449bd832023-01-11 14:50:10 +01006483 if (*data == NULL) {
6484 return PSA_ERROR_INSUFFICIENT_MEMORY;
6485 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006486
Gilles Peskine449bd832023-01-11 14:50:10 +01006487 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006488
Gilles Peskine449bd832023-01-11 14:50:10 +01006489 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006490 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006491 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006492
Gilles Peskine449bd832023-01-11 14:50:10 +01006493 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006494 case 255:
6495 (*data)[0] &= 248;
6496 (*data)[31] &= 127;
6497 (*data)[31] |= 64;
6498 break;
6499 case 448:
6500 (*data)[0] &= 252;
6501 (*data)[55] |= 128;
6502 break;
6503 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006504 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006505 break;
6506 }
6507
6508 return status;
6509}
Valerio Setti86587ab2023-06-27 13:09:30 +02006510#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6511static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6512 psa_key_slot_t *slot, size_t bits,
6513 psa_key_derivation_operation_t *operation, uint8_t **data)
6514{
6515 (void) slot;
6516 (void) bits;
6517 (void) operation;
6518 (void) data;
6519 return PSA_ERROR_NOT_SUPPORTED;
6520}
6521
6522static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6523 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6524{
6525 (void) bits;
6526 (void) operation;
6527 (void) data;
6528 return PSA_ERROR_NOT_SUPPORTED;
6529}
6530#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6531#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006532
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006533static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006534 psa_key_slot_t *slot,
6535 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006536 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006537{
6538 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006539 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306540 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006541 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006542
Gilles Peskine449bd832023-01-11 14:50:10 +01006543 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6544 return PSA_ERROR_INVALID_ARGUMENT;
6545 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006546
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006547#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006548 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006549 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6550 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6551 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006552 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006553 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6554 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006555 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006556 }
6557 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006558 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006559 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6560 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006561 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006562 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006563 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006564 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006565#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006566 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006567 if (key_type_is_raw_bytes(slot->attr.type)) {
6568 if (bits % 8 != 0) {
6569 return PSA_ERROR_INVALID_ARGUMENT;
6570 }
6571 data = mbedtls_calloc(1, bytes);
6572 if (data == NULL) {
6573 return PSA_ERROR_INSUFFICIENT_MEMORY;
6574 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006575
Gilles Peskine449bd832023-01-11 14:50:10 +01006576 status = psa_key_derivation_output_bytes(operation, data, bytes);
6577 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006578 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006579 }
David Brown12ca5032021-02-11 11:02:00 -07006580#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006581 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6582 psa_des_set_key_parity(data, bytes);
6583 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006584#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006585 } else {
6586 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006587 }
Ronald Crondd04d422020-11-28 15:14:42 +01006588
Ronald Cronbf33c932020-11-28 18:06:53 +01006589 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006590
Gilles Peskine2f107ae2024-02-28 01:26:46 +01006591 if (psa_key_lifetime_is_external(slot->attr.lifetime)) {
Gilles Peskine7a5d9202024-02-28 01:18:23 +01006592 status = psa_driver_wrapper_get_key_buffer_size(&slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01006593 &storage_size);
6594 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306595 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006596 }
Archanad8a83dc2021-06-14 10:04:16 +05306597 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006598 status = psa_allocate_buffer_to_slot(slot, storage_size);
6599 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306600 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006601 }
Archanad8a83dc2021-06-14 10:04:16 +05306602
Gilles Peskine7a5d9202024-02-28 01:18:23 +01006603 status = psa_driver_wrapper_import_key(&slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01006604 data, bytes,
6605 slot->key.data,
6606 slot->key.bytes,
6607 &slot->key.bytes, &bits);
6608 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006609 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006610 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006611
6612exit:
Gilles Peskine184cac12025-03-06 12:42:30 +01006613 mbedtls_zeroize_and_free(data, bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01006614 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006615}
6616
Gilles Peskinef36d7852024-06-06 21:11:44 +02006617static const psa_custom_key_parameters_t default_custom_production =
Gilles Peskine4a85ff32024-07-18 18:52:59 +02006618 PSA_CUSTOM_KEY_PARAMETERS_INIT;
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006619
Gilles Peskine52504f82024-06-20 17:19:58 +02006620int psa_custom_key_parameters_are_default(
Gilles Peskinef36d7852024-06-06 21:11:44 +02006621 const psa_custom_key_parameters_t *custom,
6622 size_t custom_data_length)
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006623{
Gilles Peskinef36d7852024-06-06 21:11:44 +02006624 if (custom->flags != 0) {
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006625 return 0;
6626 }
Gilles Peskinef36d7852024-06-06 21:11:44 +02006627 if (custom_data_length != 0) {
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006628 return 0;
6629 }
6630 return 1;
6631}
6632
Gilles Peskinef36d7852024-06-06 21:11:44 +02006633psa_status_t psa_key_derivation_output_key_custom(
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006634 const psa_key_attributes_t *attributes,
6635 psa_key_derivation_operation_t *operation,
Gilles Peskinef36d7852024-06-06 21:11:44 +02006636 const psa_custom_key_parameters_t *custom,
6637 const uint8_t *custom_data,
6638 size_t custom_data_length,
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006639 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006640{
6641 psa_status_t status;
6642 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006643 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006644
Ronald Cron81709fc2020-11-14 12:10:32 +01006645 *key = MBEDTLS_SVC_KEY_ID_INIT;
6646
Gilles Peskine0f84d622019-09-12 19:03:13 +02006647 /* Reject any attempt to create a zero-length key so that we don't
6648 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006649 if (psa_get_key_bits(attributes) == 0) {
6650 return PSA_ERROR_INVALID_ARGUMENT;
6651 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006652
Gilles Peskinef36d7852024-06-06 21:11:44 +02006653 (void) custom_data; /* We only accept 0-length data */
Gilles Peskine52504f82024-06-20 17:19:58 +02006654 if (!psa_custom_key_parameters_are_default(custom, custom_data_length)) {
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006655 return PSA_ERROR_INVALID_ARGUMENT;
6656 }
6657
Gilles Peskine449bd832023-01-11 14:50:10 +01006658 if (operation->alg == PSA_ALG_NONE) {
6659 return PSA_ERROR_BAD_STATE;
6660 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006661
Gilles Peskine449bd832023-01-11 14:50:10 +01006662 if (!operation->can_output_key) {
6663 return PSA_ERROR_NOT_PERMITTED;
6664 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006665
Gilles Peskine449bd832023-01-11 14:50:10 +01006666 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6667 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006668#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006669 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006670 /* Deriving a key in a secure element is not implemented yet. */
6671 status = PSA_ERROR_NOT_SUPPORTED;
6672 }
6673#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006674 if (status == PSA_SUCCESS) {
6675 status = psa_generate_derived_key_internal(slot,
Gilles Peskine2f107ae2024-02-28 01:26:46 +01006676 attributes->bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006677 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006678 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006679 if (status == PSA_SUCCESS) {
6680 status = psa_finish_key_creation(slot, driver, key);
6681 }
6682 if (status != PSA_SUCCESS) {
6683 psa_fail_key_creation(slot, driver);
6684 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006685
Gilles Peskine449bd832023-01-11 14:50:10 +01006686 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006687}
6688
Gilles Peskinef36d7852024-06-06 21:11:44 +02006689psa_status_t psa_key_derivation_output_key_ext(
6690 const psa_key_attributes_t *attributes,
6691 psa_key_derivation_operation_t *operation,
6692 const psa_key_production_parameters_t *params,
6693 size_t params_data_length,
6694 mbedtls_svc_key_id_t *key)
6695{
6696 return psa_key_derivation_output_key_custom(
6697 attributes, operation,
6698 (const psa_custom_key_parameters_t *) params,
6699 params->data, params_data_length,
6700 key);
6701}
6702
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006703psa_status_t psa_key_derivation_output_key(
6704 const psa_key_attributes_t *attributes,
6705 psa_key_derivation_operation_t *operation,
6706 mbedtls_svc_key_id_t *key)
6707{
Gilles Peskinef36d7852024-06-06 21:11:44 +02006708 return psa_key_derivation_output_key_custom(attributes, operation,
6709 &default_custom_production,
6710 NULL, 0,
6711 key);
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006712}
Gilles Peskineeab56e42018-07-12 17:12:33 +02006713
6714
6715/****************************************************************/
Gilles Peskinecdb37812025-02-05 18:02:49 +01006716/* Key derivation: operation management */
Gilles Peskineea0fb492018-07-12 17:17:20 +02006717/****************************************************************/
6718
Steven Cooreman932ffb72021-02-15 12:14:32 +01006719#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006720static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006721{
6722#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006723 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6724 return 1;
6725 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006726#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006727#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006728 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6729 return 1;
6730 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006731#endif
6732#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006733 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6734 return 1;
6735 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006736#endif
6737#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006738 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6739 return 1;
6740 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006741#endif
6742#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006743 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6744 return 1;
6745 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006746#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006747#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006748 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6749 return 1;
6750 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006751#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306752#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6753 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6754 return 1;
6755 }
6756#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306757#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6758 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6759 return 1;
6760 }
6761#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006762 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006763}
6764
Gilles Peskine449bd832023-01-11 14:50:10 +01006765static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006766{
6767 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006768 psa_status_t status = psa_hash_setup(&operation, alg);
6769 psa_hash_abort(&operation);
6770 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006771}
6772
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306773static psa_status_t psa_key_derivation_set_maximum_capacity(
6774 psa_key_derivation_operation_t *operation,
6775 psa_algorithm_t kdf_alg)
6776{
6777#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6778 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6779 operation->capacity = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6780 return PSA_SUCCESS;
6781 }
6782#endif
6783#if defined(PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128)
6784 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6785#if (SIZE_MAX > UINT32_MAX)
Kusumit Ghoderao7d4db632023-12-07 16:17:46 +05306786 operation->capacity = UINT32_MAX * (size_t) PSA_MAC_LENGTH(
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306787 PSA_KEY_TYPE_AES,
6788 128U,
6789 PSA_ALG_CMAC);
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306790#else
6791 operation->capacity = SIZE_MAX;
6792#endif
6793 return PSA_SUCCESS;
6794 }
6795#endif /* PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128 */
6796
6797 /* After this point, if kdf_alg is not valid then value of hash_alg may be
6798 * invalid or meaningless but it does not affect this function */
6799 psa_algorithm_t hash_alg = PSA_ALG_GET_HASH(kdf_alg);
6800 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306801 if (hash_size == 0) {
6802 return PSA_ERROR_NOT_SUPPORTED;
6803 }
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306804
6805 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6806 * we might fail later, which is somewhat unfriendly and potentially
6807 * risk-prone. */
6808 psa_status_t status = psa_hash_try_support(hash_alg);
6809 if (status != PSA_SUCCESS) {
6810 return status;
6811 }
6812
6813#if defined(PSA_WANT_ALG_HKDF)
6814 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6815 operation->capacity = 255 * hash_size;
6816 } else
6817#endif
6818#if defined(PSA_WANT_ALG_HKDF_EXTRACT)
6819 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6820 operation->capacity = hash_size;
6821 } else
6822#endif
6823#if defined(PSA_WANT_ALG_HKDF_EXPAND)
6824 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6825 operation->capacity = 255 * hash_size;
6826 } else
6827#endif
6828#if defined(PSA_WANT_ALG_TLS12_PRF)
6829 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) &&
6830 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6831 operation->capacity = SIZE_MAX;
6832 } else
6833#endif
6834#if defined(PSA_WANT_ALG_TLS12_PSK_TO_MS)
6835 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg) &&
6836 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6837 /* Master Secret is always 48 bytes
6838 * https://datatracker.ietf.org/doc/html/rfc5246.html#section-8.1 */
6839 operation->capacity = 48U;
6840 } else
6841#endif
6842#if defined(PSA_WANT_ALG_PBKDF2_HMAC)
6843 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6844#if (SIZE_MAX > UINT32_MAX)
6845 operation->capacity = UINT32_MAX * hash_size;
6846#else
6847 operation->capacity = SIZE_MAX;
6848#endif
6849 } else
6850#endif /* PSA_WANT_ALG_PBKDF2_HMAC */
6851 {
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306852 (void) hash_size;
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306853 status = PSA_ERROR_NOT_SUPPORTED;
6854 }
6855 return status;
6856}
6857
Gilles Peskine969c5d62019-01-16 15:53:06 +01006858static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006859 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006860 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006861{
Janos Follath5fe19732019-06-20 15:09:30 +01006862 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6863 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006864 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006865
Gilles Peskine969c5d62019-01-16 15:53:06 +01006866 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006867 if (!is_kdf_alg_supported(kdf_alg)) {
6868 return PSA_ERROR_NOT_SUPPORTED;
6869 }
John Durkop07cc04a2020-11-16 22:08:34 -08006870
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306871 psa_status_t status = psa_key_derivation_set_maximum_capacity(operation,
6872 kdf_alg);
Kusumit Ghoderao5f3a9382023-09-13 16:28:12 +05306873 return status;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006874}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006875
Gilles Peskine449bd832023-01-11 14:50:10 +01006876static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006877{
6878#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006879 if (alg == PSA_ALG_ECDH) {
6880 return PSA_SUCCESS;
6881 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006882#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006883#if defined(PSA_WANT_ALG_FFDH)
6884 if (alg == PSA_ALG_FFDH) {
6885 return PSA_SUCCESS;
6886 }
6887#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006888 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006889 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006890}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006891
6892static int psa_key_derivation_allows_free_form_secret_input(
6893 psa_algorithm_t kdf_alg)
6894{
6895#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6896 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6897 return 0;
6898 }
6899#endif
6900 (void) kdf_alg;
6901 return 1;
6902}
John Durkop07cc04a2020-11-16 22:08:34 -08006903#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006904
Gilles Peskine449bd832023-01-11 14:50:10 +01006905psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6906 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006907{
6908 psa_status_t status;
6909
Gilles Peskine449bd832023-01-11 14:50:10 +01006910 if (operation->alg != 0) {
6911 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006912 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006913
Gilles Peskine449bd832023-01-11 14:50:10 +01006914 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6915 return PSA_ERROR_INVALID_ARGUMENT;
6916 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6917#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6918 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6919 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6920 status = psa_key_agreement_try_support(ka_alg);
6921 if (status != PSA_SUCCESS) {
6922 return status;
6923 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006924 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6925 return PSA_ERROR_INVALID_ARGUMENT;
6926 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006927 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6928#else
6929 return PSA_ERROR_NOT_SUPPORTED;
6930#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6931 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6932#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6933 status = psa_key_derivation_setup_kdf(operation, alg);
6934#else
6935 return PSA_ERROR_NOT_SUPPORTED;
6936#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6937 } else {
6938 return PSA_ERROR_INVALID_ARGUMENT;
6939 }
6940
6941 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006942 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006943 }
6944 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006945}
6946
Przemek Stekiel69c46792022-06-10 12:59:51 +02006947#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006948static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6949 psa_algorithm_t kdf_alg,
6950 psa_key_derivation_step_t step,
6951 const uint8_t *data,
6952 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006953{
Gilles Peskine449bd832023-01-11 14:50:10 +01006954 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006955 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006956 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006957 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006958#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006959 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6960 return PSA_ERROR_INVALID_ARGUMENT;
6961 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006962#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006963 if (hkdf->state != HKDF_STATE_INIT) {
6964 return PSA_ERROR_BAD_STATE;
6965 } else {
6966 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6967 hash_alg,
6968 data, data_length);
6969 if (status != PSA_SUCCESS) {
6970 return status;
6971 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006972 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006973 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006974 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006975 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006976#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006977 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006978 /* We shouldn't be in different state as HKDF_EXPAND only allows
6979 * two inputs: SECRET (this case) and INFO which does not modify
6980 * the state. It could happen only if the hkdf
6981 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006982 if (hkdf->state != HKDF_STATE_INIT) {
6983 return PSA_ERROR_BAD_STATE;
6984 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006985
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006986 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006987 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6988 return PSA_ERROR_INVALID_ARGUMENT;
6989 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006990
Gilles Peskine449bd832023-01-11 14:50:10 +01006991 memcpy(hkdf->prk, data, data_length);
6992 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006993#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006994 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006995 /* HKDF: If no salt was provided, use an empty salt.
6996 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006997 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006998#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006999 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
7000 return PSA_ERROR_BAD_STATE;
7001 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02007002#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01007003 status = psa_key_derivation_start_hmac(&hkdf->hmac,
7004 hash_alg,
7005 NULL, 0);
7006 if (status != PSA_SUCCESS) {
7007 return status;
7008 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02007009 hkdf->state = HKDF_STATE_STARTED;
7010 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007011 if (hkdf->state != HKDF_STATE_STARTED) {
7012 return PSA_ERROR_BAD_STATE;
7013 }
7014 status = psa_mac_update(&hkdf->hmac,
7015 data, data_length);
7016 if (status != PSA_SUCCESS) {
7017 return status;
7018 }
7019 status = psa_mac_sign_finish(&hkdf->hmac,
7020 hkdf->prk,
7021 sizeof(hkdf->prk),
7022 &data_length);
7023 if (status != PSA_SUCCESS) {
7024 return status;
7025 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007026 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02007027
Gilles Peskine2b522db2019-04-12 15:11:49 +02007028 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02007029 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02007030#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01007031 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02007032 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007033 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02007034 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007035 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02007036#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02007037 {
7038 /* Block 0 is empty, and the next block will be
7039 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007040 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02007041 }
7042
Gilles Peskine449bd832023-01-11 14:50:10 +01007043 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02007044 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02007045#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01007046 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
7047 return PSA_ERROR_INVALID_ARGUMENT;
7048 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02007049#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02007050#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01007051 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
7052 hkdf->state == HKDF_STATE_INIT) {
7053 return PSA_ERROR_BAD_STATE;
7054 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02007055#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01007056 if (hkdf->state == HKDF_STATE_OUTPUT) {
7057 return PSA_ERROR_BAD_STATE;
7058 }
7059 if (hkdf->info_set) {
7060 return PSA_ERROR_BAD_STATE;
7061 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007062 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007063 if (data_length != 0) {
7064 hkdf->info = mbedtls_calloc(1, data_length);
7065 if (hkdf->info == NULL) {
7066 return PSA_ERROR_INSUFFICIENT_MEMORY;
7067 }
7068 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007069 }
7070 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007071 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007072 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007073 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007074 }
7075}
Przemek Stekiel69c46792022-06-10 12:59:51 +02007076#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01007077
John Durkop07cc04a2020-11-16 22:08:34 -08007078#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
7079 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007080static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
7081 const uint8_t *data,
7082 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01007083{
Gilles Peskine449bd832023-01-11 14:50:10 +01007084 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
7085 return PSA_ERROR_BAD_STATE;
7086 }
Janos Follathf08e2652019-06-13 09:05:41 +01007087
Gilles Peskine449bd832023-01-11 14:50:10 +01007088 if (data_length != 0) {
7089 prf->seed = mbedtls_calloc(1, data_length);
7090 if (prf->seed == NULL) {
7091 return PSA_ERROR_INSUFFICIENT_MEMORY;
7092 }
Janos Follathf08e2652019-06-13 09:05:41 +01007093
Gilles Peskine449bd832023-01-11 14:50:10 +01007094 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01007095 prf->seed_length = data_length;
7096 }
Janos Follathf08e2652019-06-13 09:05:41 +01007097
Gilles Peskine43f958b2020-12-13 14:55:14 +01007098 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01007099
Gilles Peskine449bd832023-01-11 14:50:10 +01007100 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01007101}
7102
Gilles Peskine449bd832023-01-11 14:50:10 +01007103static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
7104 const uint8_t *data,
7105 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01007106{
Gilles Peskine449bd832023-01-11 14:50:10 +01007107 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
7108 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
7109 return PSA_ERROR_BAD_STATE;
7110 }
Janos Follath81550542019-06-13 14:26:34 +01007111
Gilles Peskine449bd832023-01-11 14:50:10 +01007112 if (data_length != 0) {
7113 prf->secret = mbedtls_calloc(1, data_length);
7114 if (prf->secret == NULL) {
7115 return PSA_ERROR_INSUFFICIENT_MEMORY;
7116 }
Steven Cooremana6df6042021-04-29 19:32:25 +02007117
Gilles Peskine449bd832023-01-11 14:50:10 +01007118 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02007119 prf->secret_length = data_length;
7120 }
Janos Follath81550542019-06-13 14:26:34 +01007121
Gilles Peskine43f958b2020-12-13 14:55:14 +01007122 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01007123
Gilles Peskine449bd832023-01-11 14:50:10 +01007124 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01007125}
7126
Gilles Peskine449bd832023-01-11 14:50:10 +01007127static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
7128 const uint8_t *data,
7129 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01007130{
Gilles Peskine449bd832023-01-11 14:50:10 +01007131 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
7132 return PSA_ERROR_BAD_STATE;
7133 }
Janos Follath63028dd2019-06-13 09:15:47 +01007134
Gilles Peskine449bd832023-01-11 14:50:10 +01007135 if (data_length != 0) {
7136 prf->label = mbedtls_calloc(1, data_length);
7137 if (prf->label == NULL) {
7138 return PSA_ERROR_INSUFFICIENT_MEMORY;
7139 }
Janos Follath63028dd2019-06-13 09:15:47 +01007140
Gilles Peskine449bd832023-01-11 14:50:10 +01007141 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01007142 prf->label_length = data_length;
7143 }
Janos Follath63028dd2019-06-13 09:15:47 +01007144
Gilles Peskine43f958b2020-12-13 14:55:14 +01007145 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01007146
Gilles Peskine449bd832023-01-11 14:50:10 +01007147 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01007148}
7149
Gilles Peskine449bd832023-01-11 14:50:10 +01007150static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
7151 psa_key_derivation_step_t step,
7152 const uint8_t *data,
7153 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01007154{
Gilles Peskine449bd832023-01-11 14:50:10 +01007155 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01007156 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01007157 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01007158 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007159 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01007160 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01007161 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01007162 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007163 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01007164 }
7165}
John Durkop07cc04a2020-11-16 22:08:34 -08007166#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
7167 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
7168
7169#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
7170static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
7171 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08007172 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007173 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08007174{
7175 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007176 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
7177 4 + data_length + prf->other_secret_length :
7178 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08007179
Gilles Peskine449bd832023-01-11 14:50:10 +01007180 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
7181 return PSA_ERROR_INVALID_ARGUMENT;
7182 }
John Durkop07cc04a2020-11-16 22:08:34 -08007183
Gilles Peskine449bd832023-01-11 14:50:10 +01007184 uint8_t *pms = mbedtls_calloc(1, pms_len);
7185 if (pms == NULL) {
7186 return PSA_ERROR_INSUFFICIENT_MEMORY;
7187 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02007188 uint8_t *cur = pms;
7189
7190 /* pure-PSK:
7191 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08007192 *
7193 * The premaster secret is formed as follows: if the PSK is N octets
7194 * long, concatenate a uint16 with the value N, N zero octets, a second
7195 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02007196 *
7197 * mixed-PSK:
7198 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
7199 * follows: concatenate a uint16 with the length of the other secret,
7200 * the other secret itself, uint16 with the length of PSK, and the
7201 * PSK itself.
7202 * For details please check:
7203 * - RFC 4279, Section 4 for the definition of RSA-PSK,
7204 * - RFC 4279, Section 3 for the definition of DHE-PSK,
7205 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08007206 */
7207
Gilles Peskine449bd832023-01-11 14:50:10 +01007208 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
7209 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
7210 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
7211 if (prf->other_secret_length != 0) {
7212 memcpy(cur, prf->other_secret, prf->other_secret_length);
7213 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02007214 cur += prf->other_secret_length;
7215 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007216 } else {
7217 *cur++ = MBEDTLS_BYTE_1(data_length);
7218 *cur++ = MBEDTLS_BYTE_0(data_length);
7219 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02007220 cur += data_length;
7221 }
7222
Gilles Peskine449bd832023-01-11 14:50:10 +01007223 *cur++ = MBEDTLS_BYTE_1(data_length);
7224 *cur++ = MBEDTLS_BYTE_0(data_length);
7225 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08007226 cur += data_length;
7227
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007228 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08007229
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01007230 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01007231 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08007232}
Janos Follath6660f0e2019-06-17 08:44:03 +01007233
Przemek Stekiele47201b2022-04-19 13:53:28 +02007234static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
7235 psa_tls12_prf_key_derivation_t *prf,
7236 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007237 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02007238{
Gilles Peskine449bd832023-01-11 14:50:10 +01007239 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
7240 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02007241 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007242
7243 if (data_length != 0) {
7244 prf->other_secret = mbedtls_calloc(1, data_length);
7245 if (prf->other_secret == NULL) {
7246 return PSA_ERROR_INSUFFICIENT_MEMORY;
7247 }
7248
7249 memcpy(prf->other_secret, data, data_length);
7250 prf->other_secret_length = data_length;
7251 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02007252 prf->other_secret_length = 0;
7253 }
7254
7255 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
7256
Gilles Peskine449bd832023-01-11 14:50:10 +01007257 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02007258}
7259
Janos Follath6660f0e2019-06-17 08:44:03 +01007260static psa_status_t psa_tls12_prf_psk_to_ms_input(
7261 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01007262 psa_key_derivation_step_t step,
7263 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007264 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01007265{
Gilles Peskine449bd832023-01-11 14:50:10 +01007266 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02007267 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007268 return psa_tls12_prf_psk_to_ms_set_key(prf,
7269 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02007270 break;
7271 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007272 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
7273 data,
7274 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02007275 break;
7276 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007277 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02007278 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01007279
Przemek Stekiele47201b2022-04-19 13:53:28 +02007280 }
Janos Follath6660f0e2019-06-17 08:44:03 +01007281}
John Durkop07cc04a2020-11-16 22:08:34 -08007282#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007283
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007284#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
7285static psa_status_t psa_tls12_ecjpake_to_pms_input(
7286 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04007287 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007288 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007289 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007290{
Gilles Peskine449bd832023-01-11 14:50:10 +01007291 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
7292 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
7293 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04007294 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007295
7296 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01007297 if (data[0] != 0x04) {
7298 return PSA_ERROR_INVALID_ARGUMENT;
7299 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007300
7301 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007302 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007303
Gilles Peskine449bd832023-01-11 14:50:10 +01007304 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007305}
7306#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307307
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307308#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307309static psa_status_t psa_pbkdf2_set_input_cost(
7310 psa_pbkdf2_key_derivation_t *pbkdf2,
7311 psa_key_derivation_step_t step,
7312 uint64_t data)
7313{
7314 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
7315 return PSA_ERROR_INVALID_ARGUMENT;
7316 }
7317
7318 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
7319 return PSA_ERROR_BAD_STATE;
7320 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307321
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05307322 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307323 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307324 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307325
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307326 if (data == 0) {
7327 return PSA_ERROR_INVALID_ARGUMENT;
7328 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05307329
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307330 pbkdf2->input_cost = data;
7331 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
7332
7333 return PSA_SUCCESS;
7334}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307335
7336static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
7337 const uint8_t *data,
7338 size_t data_length)
7339{
Gilles Peskineead17662023-08-20 22:02:51 +02007340 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
7341 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
7342 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
7343 /* Appending to existing salt. No state change. */
7344 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307345 return PSA_ERROR_BAD_STATE;
7346 }
7347
Gilles Peskineca57d782023-07-20 19:08:06 +02007348 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02007349 /* Appending an empty string, nothing to do. */
7350 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307351 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05307352
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307353 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
7354 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05307355 return PSA_ERROR_INSUFFICIENT_MEMORY;
7356 }
7357
Gilles Peskineead17662023-08-20 22:02:51 +02007358 if (pbkdf2->salt_length != 0) {
7359 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
7360 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307361 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05307362 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307363 mbedtls_free(pbkdf2->salt);
7364 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307365 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307366 return PSA_SUCCESS;
7367}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307368
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307369#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307370static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307371 const uint8_t *input,
7372 size_t input_len,
7373 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05307374 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307375{
7376 psa_status_t status = PSA_SUCCESS;
7377 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
Ryan Everett5d2e82f2024-02-07 17:24:59 +00007378 return psa_hash_compute(hash_alg, input, input_len, output,
7379 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
7380 } else if (input_len > 0) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307381 memcpy(output, input, input_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307382 }
Ryan Everett5d2e82f2024-02-07 17:24:59 +00007383 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307384 return status;
7385}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307386#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307387
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307388#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307389static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
7390 size_t input_len,
7391 uint8_t *output,
7392 size_t *output_len)
7393{
7394 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307395 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307396 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05307397 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307398 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
7399 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
7400 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307401 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05307402 * mac_size as the driver function sets mac_output_length = mac_size
7403 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307404 status = psa_driver_wrapper_mac_compute(&attributes,
7405 zeros, sizeof(zeros),
7406 PSA_ALG_CMAC, input, input_len,
7407 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307408 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
7409 128U,
7410 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307411 output_len);
7412 } else {
7413 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307414 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307415 }
7416 return status;
7417}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307418#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307419
7420static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307421 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307422 const uint8_t *data,
7423 size_t data_length)
7424{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307425 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307426 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
7427 return PSA_ERROR_BAD_STATE;
7428 }
7429
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307430#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307431 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
7432 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
7433 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
7434 pbkdf2->password,
7435 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307436 } else
7437#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
7438#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
7439 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307440 status = psa_pbkdf2_cmac_set_password(data, data_length,
7441 pbkdf2->password,
7442 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307443 } else
7444#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
7445 {
7446 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307447 }
7448
7449 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
7450
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307451 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307452}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307453
7454static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307455 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307456 psa_key_derivation_step_t step,
7457 const uint8_t *data,
7458 size_t data_length)
7459{
7460 switch (step) {
7461 case PSA_KEY_DERIVATION_INPUT_SALT:
7462 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
7463 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307464 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307465 default:
7466 return PSA_ERROR_INVALID_ARGUMENT;
7467 }
7468}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307469#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307470
Gilles Peskineb8965192019-09-24 16:21:10 +02007471/** Check whether the given key type is acceptable for the given
7472 * input step of a key derivation.
7473 *
7474 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
7475 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
7476 * Both secret and non-secret inputs can alternatively have the type
7477 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
7478 * that the input was passed as a buffer rather than via a key object.
7479 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02007480static int psa_key_derivation_check_input_type(
7481 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007482 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02007483{
Gilles Peskine449bd832023-01-11 14:50:10 +01007484 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007485 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 if (key_type == PSA_KEY_TYPE_DERIVE) {
7487 return PSA_SUCCESS;
7488 }
7489 if (key_type == PSA_KEY_TYPE_NONE) {
7490 return PSA_SUCCESS;
7491 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007492 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02007493 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007494 if (key_type == PSA_KEY_TYPE_DERIVE) {
7495 return PSA_SUCCESS;
7496 }
7497 if (key_type == PSA_KEY_TYPE_NONE) {
7498 return PSA_SUCCESS;
7499 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02007500 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007501 case PSA_KEY_DERIVATION_INPUT_LABEL:
7502 case PSA_KEY_DERIVATION_INPUT_SALT:
7503 case PSA_KEY_DERIVATION_INPUT_INFO:
7504 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01007505 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
7506 return PSA_SUCCESS;
7507 }
7508 if (key_type == PSA_KEY_TYPE_NONE) {
7509 return PSA_SUCCESS;
7510 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007511 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307512 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
7513 if (key_type == PSA_KEY_TYPE_PASSWORD) {
7514 return PSA_SUCCESS;
7515 }
7516 if (key_type == PSA_KEY_TYPE_DERIVE) {
7517 return PSA_SUCCESS;
7518 }
7519 if (key_type == PSA_KEY_TYPE_NONE) {
7520 return PSA_SUCCESS;
7521 }
7522 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007523 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007524 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007525}
7526
Janos Follathb80a94e2019-06-12 15:54:46 +01007527static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007528 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007529 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007530 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007531 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007532 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007533{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007534 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007535 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007536
Waleed Elmelegy443908b2025-03-10 14:19:01 +00007537 if (kdf_alg == PSA_ALG_NONE) {
Waleed Elmelegy82cd3242025-03-03 15:04:17 +00007538 /* This is a blank or aborted operation. */
Waleed Elmelegy72b391f2025-03-03 12:35:28 +00007539 status = PSA_ERROR_BAD_STATE;
7540 goto exit;
7541 }
7542
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 status = psa_key_derivation_check_input_type(step, key_type);
7544 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007545 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007546 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007547
Przemek Stekiel69c46792022-06-10 12:59:51 +02007548#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007549 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7550 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7551 step, data, data_length);
7552 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007553#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007554#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007555 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7556 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7557 step, data, data_length);
7558 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007559#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7560#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007561 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7562 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7563 step, data, data_length);
7564 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007565#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007566#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007567 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007568 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007569 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7570 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007571#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307572#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307573 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307574 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7575 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307576 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307577#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007578 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007579 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007580 (void) data;
7581 (void) data_length;
7582 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007583 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007584 }
7585
Gilles Peskine224b0d62019-09-23 18:13:17 +02007586exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007587 if (status != PSA_SUCCESS) {
7588 psa_key_derivation_abort(operation);
7589 }
7590 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007591}
7592
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307593static psa_status_t psa_key_derivation_input_integer_internal(
7594 psa_key_derivation_operation_t *operation,
7595 psa_key_derivation_step_t step,
7596 uint64_t value)
7597{
7598 psa_status_t status;
7599 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7600
Waleed Elmelegy443908b2025-03-10 14:19:01 +00007601 if (kdf_alg == PSA_ALG_NONE) {
Waleed Elmelegy72b391f2025-03-03 12:35:28 +00007602 /* This is a blank or aborted operation. */
7603 status = PSA_ERROR_BAD_STATE;
7604 goto exit;
7605 }
7606
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307607#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307608 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307609 status = psa_pbkdf2_set_input_cost(
7610 &operation->ctx.pbkdf2, step, value);
7611 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307612#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307613 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307614 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307615 (void) value;
7616 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307617 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307618 }
7619
Waleed Elmelegy72b391f2025-03-03 12:35:28 +00007620exit:
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307621 if (status != PSA_SUCCESS) {
7622 psa_key_derivation_abort(operation);
7623 }
7624 return status;
7625}
7626
Janos Follath51f4a0f2019-06-14 11:35:55 +01007627psa_status_t psa_key_derivation_input_bytes(
7628 psa_key_derivation_operation_t *operation,
7629 psa_key_derivation_step_t step,
Ryan Everettd1e398c2024-01-19 14:46:00 +00007630 const uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007631 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007632{
Ryan Everettd1e398c2024-01-19 14:46:00 +00007633 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7634 LOCAL_INPUT_DECLARE(data_external, data);
7635
7636 LOCAL_INPUT_ALLOC(data_external, data_length, data);
7637
7638 status = psa_key_derivation_input_internal(operation, step,
7639 PSA_KEY_TYPE_NONE,
7640 data, data_length);
David Horstmann4a48bec2024-03-13 15:42:31 +00007641#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Ryan Everettd1e398c2024-01-19 14:46:00 +00007642exit:
Ryan Everettb41c3c92024-01-25 11:56:35 +00007643#endif
Ryan Everettd1e398c2024-01-19 14:46:00 +00007644 LOCAL_INPUT_FREE(data_external, data);
7645 return status;
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007646}
7647
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307648psa_status_t psa_key_derivation_input_integer(
7649 psa_key_derivation_operation_t *operation,
7650 psa_key_derivation_step_t step,
7651 uint64_t value)
7652{
7653 return psa_key_derivation_input_integer_internal(operation, step, value);
7654}
7655
Janos Follath51f4a0f2019-06-14 11:35:55 +01007656psa_status_t psa_key_derivation_input_key(
7657 psa_key_derivation_operation_t *operation,
7658 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007659 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007660{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007661 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007662 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007663 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007664
Ronald Cron5c522922020-11-14 16:35:34 +01007665 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007666 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7667 if (status != PSA_SUCCESS) {
7668 psa_key_derivation_abort(operation);
7669 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007670 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007671
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307672 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7673 * permission to output to a key object. */
7674 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7675 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007676 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007677 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007678
Gilles Peskine449bd832023-01-11 14:50:10 +01007679 status = psa_key_derivation_input_internal(operation,
7680 step, slot->attr.type,
7681 slot->key.data,
7682 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007683
Ryan Everett5ac6fa72024-02-14 17:11:36 +00007684 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007685
Gilles Peskine449bd832023-01-11 14:50:10 +01007686 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007687}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007688
7689
7690
7691/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007692/* Key agreement */
7693/****************************************************************/
7694
Gilles Peskine449bd832023-01-11 14:50:10 +01007695psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7696 const uint8_t *key_buffer,
7697 size_t key_buffer_size,
7698 psa_algorithm_t alg,
7699 const uint8_t *peer_key,
7700 size_t peer_key_length,
7701 uint8_t *shared_secret,
7702 size_t shared_secret_size,
7703 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007704{
Gilles Peskine449bd832023-01-11 14:50:10 +01007705 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007706#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007707 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007708 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7709 key_buffer_size, alg,
7710 peer_key, peer_key_length,
7711 shared_secret,
7712 shared_secret_size,
7713 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007714#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007715
7716#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7717 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007718 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007719 peer_key,
7720 peer_key_length,
7721 key_buffer,
7722 key_buffer_size,
7723 shared_secret,
7724 shared_secret_size,
7725 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007726#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7727
Gilles Peskine01d718c2018-09-18 12:01:02 +02007728 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007729 (void) attributes;
7730 (void) key_buffer;
7731 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007732 (void) peer_key;
7733 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007734 (void) shared_secret;
7735 (void) shared_secret_size;
7736 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007737 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007738 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007739}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007740
Aditya Deshpande17845b82022-10-13 17:21:01 +01007741/** Internal function for raw key agreement
7742 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007743 * to the driver's implementation if a driver is present.
7744 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007745 * (psa_key_agreement_raw_builtin).
7746 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007747static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7748 psa_key_slot_t *private_key,
7749 const uint8_t *peer_key,
7750 size_t peer_key_length,
7751 uint8_t *shared_secret,
7752 size_t shared_secret_size,
7753 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007754{
Gilles Peskine449bd832023-01-11 14:50:10 +01007755 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7756 return PSA_ERROR_NOT_SUPPORTED;
7757 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007758
Gilles Peskine7a5d9202024-02-28 01:18:23 +01007759 return psa_driver_wrapper_key_agreement(&private_key->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01007760 private_key->key.data,
7761 private_key->key.bytes, alg,
7762 peer_key, peer_key_length,
7763 shared_secret,
7764 shared_secret_size,
7765 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007766}
7767
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007768/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007769 * to potentially free embedded data structures and wipe confidential data.
7770 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007771static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7772 psa_key_derivation_step_t step,
7773 psa_key_slot_t *private_key,
7774 const uint8_t *peer_key,
7775 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007776{
7777 psa_status_t status;
Moritz Fischer967f8cd2024-03-02 00:55:06 +00007778 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE] = { 0 };
Gilles Peskine01d718c2018-09-18 12:01:02 +02007779 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007780 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007781
7782 /* Step 1: run the secret agreement algorithm to generate the shared
7783 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007784 status = psa_key_agreement_raw_internal(ka_alg,
7785 private_key,
7786 peer_key, peer_key_length,
7787 shared_secret,
7788 sizeof(shared_secret),
7789 &shared_secret_length);
7790 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007791 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007792 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007793
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007794 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007795 * the shared secret. A shared secret is permitted wherever a key
7796 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007797 status = psa_key_derivation_input_internal(operation, step,
7798 PSA_KEY_TYPE_DERIVE,
7799 shared_secret,
7800 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007801exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007802 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7803 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007804}
7805
Gilles Peskine449bd832023-01-11 14:50:10 +01007806psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7807 psa_key_derivation_step_t step,
7808 mbedtls_svc_key_id_t private_key,
Thomas Daubney9739ac02024-02-15 13:15:47 +00007809 const uint8_t *peer_key_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007810 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007811{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007812 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007813 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007814 psa_key_slot_t *slot;
Thomas Daubney9739ac02024-02-15 13:15:47 +00007815 LOCAL_INPUT_DECLARE(peer_key_external, peer_key);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007816
Gilles Peskine449bd832023-01-11 14:50:10 +01007817 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7818 return PSA_ERROR_INVALID_ARGUMENT;
7819 }
Ronald Cron5c522922020-11-14 16:35:34 +01007820 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007821 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7822 if (status != PSA_SUCCESS) {
7823 return status;
7824 }
Thomas Daubney9739ac02024-02-15 13:15:47 +00007825
Thomas Daubney692fb3c2024-03-12 16:20:41 +00007826 LOCAL_INPUT_ALLOC(peer_key_external, peer_key_length, peer_key);
Gilles Peskine449bd832023-01-11 14:50:10 +01007827 status = psa_key_agreement_internal(operation, step,
7828 slot,
7829 peer_key, peer_key_length);
Thomas Daubney9739ac02024-02-15 13:15:47 +00007830
David Horstmann4a48bec2024-03-13 15:42:31 +00007831#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney9739ac02024-02-15 13:15:47 +00007832exit:
Thomas Daubney50f58fc2024-02-15 14:24:03 +00007833#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007834 if (status != PSA_SUCCESS) {
7835 psa_key_derivation_abort(operation);
7836 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007837 /* If a private key has been added as SECRET, we allow the derived
7838 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007839 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007840 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007841 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007842 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007843
Ryan Everett5ac6fa72024-02-14 17:11:36 +00007844 unlock_status = psa_unregister_read_under_mutex(slot);
Thomas Daubney9739ac02024-02-15 13:15:47 +00007845 LOCAL_INPUT_FREE(peer_key_external, peer_key);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007846
Gilles Peskine449bd832023-01-11 14:50:10 +01007847 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007848}
7849
Gilles Peskine449bd832023-01-11 14:50:10 +01007850psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7851 mbedtls_svc_key_id_t private_key,
Thomas Daubney81899ab2024-02-15 12:57:26 +00007852 const uint8_t *peer_key_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007853 size_t peer_key_length,
Thomas Daubney81899ab2024-02-15 12:57:26 +00007854 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007855 size_t output_size,
7856 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007857{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007858 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007859 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007860 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007861 size_t expected_length;
Thomas Daubney81899ab2024-02-15 12:57:26 +00007862 LOCAL_INPUT_DECLARE(peer_key_external, peer_key);
7863 LOCAL_OUTPUT_DECLARE(output_external, output);
Thomas Daubney89d8c2a2024-02-21 11:16:16 +00007864 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007865
Gilles Peskine449bd832023-01-11 14:50:10 +01007866 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007867 status = PSA_ERROR_INVALID_ARGUMENT;
7868 goto exit;
7869 }
Ronald Cron5c522922020-11-14 16:35:34 +01007870 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007871 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7872 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007873 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007874 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007875
Gilles Peskine3e561302022-04-14 00:17:15 +02007876 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7877 * for the output size. The PSA specification only guarantees that this
7878 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7879 * but it might be nice to allow smaller buffers if the output fits.
7880 * At the time of writing this comment, with only ECDH implemented,
7881 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7882 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7883 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007884 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007885 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7886 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007887 status = PSA_ERROR_BUFFER_TOO_SMALL;
7888 goto exit;
7889 }
7890
Thomas Daubney81899ab2024-02-15 12:57:26 +00007891 LOCAL_INPUT_ALLOC(peer_key_external, peer_key_length, peer_key);
Gilles Peskine449bd832023-01-11 14:50:10 +01007892 status = psa_key_agreement_raw_internal(alg, slot,
7893 peer_key, peer_key_length,
7894 output, output_size,
7895 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007896
7897exit:
Thomas Daubney5390aca2024-02-22 11:06:04 +00007898 /* Check for successful allocation of output,
7899 * with an unsuccessful status. */
Thomas Daubney0576a6a2024-02-21 15:15:00 +00007900 if (output != NULL && status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007901 /* If an error happens and is not handled properly, the output
7902 * may be used as a key to protect sensitive data. Arrange for such
7903 * a key to be random, which is likely to result in decryption or
7904 * verification errors. This is better than filling the buffer with
7905 * some constant data such as zeros, which would result in the data
7906 * being protected with a reproducible, easily knowable key.
7907 */
David Horstmann6e99bb22024-02-06 15:27:49 +00007908 psa_generate_random_internal(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007909 *output_length = output_size;
7910 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007911
Thomas Daubney5390aca2024-02-22 11:06:04 +00007912 if (output == NULL) {
Thomas Daubney89d8c2a2024-02-21 11:16:16 +00007913 /* output allocation failed. */
7914 *output_length = 0;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007915 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007916
Ryan Everetta103ec92024-01-31 13:59:57 +00007917 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007918
Thomas Daubney81899ab2024-02-15 12:57:26 +00007919 LOCAL_INPUT_FREE(peer_key_external, peer_key);
7920 LOCAL_OUTPUT_FREE(output_external, output);
Gilles Peskine449bd832023-01-11 14:50:10 +01007921 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007922}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007923
7924
7925/****************************************************************/
7926/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007927/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007928
Gilles Peskine672a7712023-04-28 21:00:28 +02007929#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7930#include "entropy_poll.h"
7931#endif
7932
Gilles Peskine30524eb2020-11-13 17:02:26 +01007933/** Initialize the PSA random generator.
Paul Elliottd35dce62024-03-15 13:57:16 +00007934 *
7935 * Note: the mbedtls_threading_psa_rngdata_mutex should be held when calling
7936 * this function if mutexes are enabled.
Gilles Peskine30524eb2020-11-13 17:02:26 +01007937 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007938static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007939{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007940#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007941 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007942#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7943
Gilles Peskine30524eb2020-11-13 17:02:26 +01007944 /* Set default configuration if
7945 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007946 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007947 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007948 }
7949 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007950 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007951 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007952
Gilles Peskine449bd832023-01-11 14:50:10 +01007953 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007954#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7955 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7956 /* The PSA entropy injection feature depends on using NV seed as an entropy
7957 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007958 mbedtls_entropy_add_source(&rng->entropy,
7959 mbedtls_nv_seed_poll, NULL,
7960 MBEDTLS_ENTROPY_BLOCK_SIZE,
7961 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007962#endif
7963
Valerio Setti061d4e42024-02-26 12:52:44 +01007964 mbedtls_psa_drbg_init(&rng->drbg);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007965#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007966}
7967
7968/** Deinitialize the PSA random generator.
Paul Elliottd35dce62024-03-15 13:57:16 +00007969 *
7970 * Note: the mbedtls_threading_psa_rngdata_mutex should be held when calling
7971 * this function if mutexes are enabled.
Gilles Peskine30524eb2020-11-13 17:02:26 +01007972 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007973static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007974{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007975#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007976 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007977#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti061d4e42024-02-26 12:52:44 +01007978 mbedtls_psa_drbg_free(&rng->drbg);
Gilles Peskine449bd832023-01-11 14:50:10 +01007979 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007980#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007981}
7982
7983/** Seed the PSA random generator.
7984 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007985static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007986{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007987#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7988 /* Do nothing: the external RNG seeds itself. */
7989 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007990 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007991#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007992 const unsigned char drbg_seed[] = "PSA";
Valerio Setti061d4e42024-02-26 12:52:44 +01007993 int ret = mbedtls_psa_drbg_seed(&rng->drbg, &rng->entropy,
Gilles Peskine449bd832023-01-11 14:50:10 +01007994 drbg_seed, sizeof(drbg_seed) - 1);
7995 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007996#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007997}
7998
David Horstmann6e99bb22024-02-06 15:27:49 +00007999psa_status_t psa_generate_random(uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01008000 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01008001{
David Horstmann6e99bb22024-02-06 15:27:49 +00008002 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008003
David Horstmann6e99bb22024-02-06 15:27:49 +00008004 LOCAL_OUTPUT_DECLARE(output_external, output);
8005 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01008006
David Horstmann6e99bb22024-02-06 15:27:49 +00008007 status = psa_generate_random_internal(output, output_size);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01008008
David Horstmann4a48bec2024-03-13 15:42:31 +00008009#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
David Horstmann6e99bb22024-02-06 15:27:49 +00008010exit:
David Horstmanne097bbd2024-02-28 14:17:10 +00008011#endif
David Horstmann6e99bb22024-02-06 15:27:49 +00008012 LOCAL_OUTPUT_FREE(output_external, output);
8013 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008014}
8015
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01008016#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01008017psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
8018 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02008019{
Paul Elliott600472b2024-02-23 17:26:58 +00008020 if (psa_get_initialized()) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008021 return PSA_ERROR_NOT_PERMITTED;
8022 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02008023
Gilles Peskine449bd832023-01-11 14:50:10 +01008024 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
8025 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
8026 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
8027 return PSA_ERROR_INVALID_ARGUMENT;
8028 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02008029
Gilles Peskine449bd832023-01-11 14:50:10 +01008030 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02008031}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01008032#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02008033
Ronald Cron3772afe2021-02-08 16:10:05 +01008034/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02008035 *
Ronald Cron3772afe2021-02-08 16:10:05 +01008036 * \param type The key type
8037 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02008038 *
8039 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01008040 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02008041 * \retval #PSA_ERROR_INVALID_ARGUMENT
8042 * The size in bits of the key is not valid.
8043 * \retval #PSA_ERROR_NOT_SUPPORTED
8044 * The type and/or the size in bits of the key or the combination of
8045 * the two is not supported.
8046 */
Ronald Cron3772afe2021-02-08 16:10:05 +01008047static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01008048 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01008049{
Ronald Cronf3bb7612020-10-02 20:11:59 +02008050 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008051
Gilles Peskine449bd832023-01-11 14:50:10 +01008052 if (key_type_is_raw_bytes(type)) {
8053 status = psa_validate_unstructured_key_bit_size(type, bits);
8054 if (status != PSA_SUCCESS) {
8055 return status;
8056 }
8057 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02008058#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008059 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
8060 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
8061 return PSA_ERROR_NOT_SUPPORTED;
8062 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00008063 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00008064 return PSA_ERROR_NOT_SUPPORTED;
8065 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02008066
Ronald Cron01b2aba2020-10-05 09:42:02 +02008067 /* Accept only byte-aligned keys, for the same reasons as
8068 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01008069 if (bits % 8 != 0) {
8070 return PSA_ERROR_NOT_SUPPORTED;
8071 }
8072 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02008073#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02008074
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02008075#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008076 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01008077 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008078 return PSA_SUCCESS;
8079 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02008080#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01008081
Valerio Settia55f0422023-07-10 15:34:41 +02008082#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01008083 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02008084 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01008085 return PSA_ERROR_NOT_SUPPORTED;
8086 }
8087 } else
Valerio Settia55f0422023-07-10 15:34:41 +02008088#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02008089 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008090 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02008091 }
8092
Gilles Peskine449bd832023-01-11 14:50:10 +01008093 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02008094}
8095
Ronald Cron55ed0592020-10-05 10:30:40 +02008096psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02008097 const psa_key_attributes_t *attributes,
Gilles Peskinef36d7852024-06-06 21:11:44 +02008098 const psa_custom_key_parameters_t *custom,
8099 const uint8_t *custom_data,
8100 size_t custom_data_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01008101 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02008102{
8103 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f107ae2024-02-28 01:26:46 +01008104 psa_key_type_t type = attributes->type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02008105
Gilles Peskine7a18f962024-02-12 16:48:11 +01008106 /* Only used for RSA */
Gilles Peskinef36d7852024-06-06 21:11:44 +02008107 (void) custom;
8108 (void) custom_data;
8109 (void) custom_data_length;
Ronald Cron01b2aba2020-10-05 09:42:02 +02008110
Gilles Peskine449bd832023-01-11 14:50:10 +01008111 if (key_type_is_raw_bytes(type)) {
David Horstmann93fa4e12024-03-12 15:02:28 +00008112 status = psa_generate_random_internal(key_buffer, key_buffer_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01008113 if (status != PSA_SUCCESS) {
8114 return status;
8115 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02008116
David Brown12ca5032021-02-11 11:02:00 -07008117#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01008118 if (type == PSA_KEY_TYPE_DES) {
8119 psa_des_set_key_parity(key_buffer, key_buffer_size);
8120 }
David Brown8107e312021-02-12 08:08:46 -07008121#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01008122 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01008123
Valerio Setti76df8c12023-07-11 14:11:28 +02008124#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008125 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
8126 return mbedtls_psa_rsa_generate_key(attributes,
Gilles Peskinef36d7852024-06-06 21:11:44 +02008127 custom_data, custom_data_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01008128 key_buffer,
8129 key_buffer_size,
8130 key_buffer_length);
8131 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02008132#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01008133
Valerio Settibfeaf5b2023-06-20 13:27:46 +02008134#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01008135 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
8136 return mbedtls_psa_ecp_generate_key(attributes,
8137 key_buffer,
8138 key_buffer_size,
8139 key_buffer_length);
8140 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02008141#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01008142
Valerio Settia55f0422023-07-10 15:34:41 +02008143#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01008144 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
8145 return mbedtls_psa_ffdh_generate_key(attributes,
8146 key_buffer,
8147 key_buffer_size,
8148 key_buffer_length);
8149 } else
Valerio Settia55f0422023-07-10 15:34:41 +02008150#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02008151 {
Gilles Peskine449bd832023-01-11 14:50:10 +01008152 (void) key_buffer_length;
8153 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02008154 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01008155
Gilles Peskine449bd832023-01-11 14:50:10 +01008156 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02008157}
Darryl Green0c6575a2018-11-07 16:05:30 +00008158
Gilles Peskinef36d7852024-06-06 21:11:44 +02008159psa_status_t psa_generate_key_custom(const psa_key_attributes_t *attributes,
8160 const psa_custom_key_parameters_t *custom,
8161 const uint8_t *custom_data,
8162 size_t custom_data_length,
8163 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02008164{
8165 psa_status_t status;
8166 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02008167 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02008168 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02008169
Ronald Cron81709fc2020-11-14 12:10:32 +01008170 *key = MBEDTLS_SVC_KEY_ID_INIT;
8171
Gilles Peskine0f84d622019-09-12 19:03:13 +02008172 /* Reject any attempt to create a zero-length key so that we don't
8173 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008174 if (psa_get_key_bits(attributes) == 0) {
8175 return PSA_ERROR_INVALID_ARGUMENT;
8176 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02008177
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02008178 /* Reject any attempt to create a public key. */
Gilles Peskine2f107ae2024-02-28 01:26:46 +01008179 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008180 return PSA_ERROR_INVALID_ARGUMENT;
8181 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02008182
Gilles Peskine7a18f962024-02-12 16:48:11 +01008183#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine2f107ae2024-02-28 01:26:46 +01008184 if (attributes->type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
Gilles Peskinef36d7852024-06-06 21:11:44 +02008185 if (custom->flags != 0) {
Gilles Peskine7a18f962024-02-12 16:48:11 +01008186 return PSA_ERROR_INVALID_ARGUMENT;
8187 }
8188 } else
8189#endif
Gilles Peskine52504f82024-06-20 17:19:58 +02008190 if (!psa_custom_key_parameters_are_default(custom, custom_data_length)) {
Ronald Cron81709fc2020-11-14 12:10:32 +01008191 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine11792082019-08-06 18:36:36 +02008192 }
8193
Gilles Peskine449bd832023-01-11 14:50:10 +01008194 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
8195 &slot, &driver);
8196 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02008197 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008198 }
Gilles Peskine11792082019-08-06 18:36:36 +02008199
Ronald Cron977c2472020-10-13 08:32:21 +02008200 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05308201 * storage ( thus not in the case of generating a key in a secure element
8202 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
8203 * buffer to hold the generated key material. */
Valerio Setti70fa89c2024-08-14 05:12:45 +02008204 if (slot->key.bytes == 0) {
Gilles Peskine2f107ae2024-02-28 01:26:46 +01008205 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->lifetime) ==
Gilles Peskine449bd832023-01-11 14:50:10 +01008206 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01008207 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine2f107ae2024-02-28 01:26:46 +01008208 attributes->type, attributes->bits);
Gilles Peskine449bd832023-01-11 14:50:10 +01008209 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01008210 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008211 }
Ronald Cron3772afe2021-02-08 16:10:05 +01008212
8213 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine2f107ae2024-02-28 01:26:46 +01008214 attributes->type,
8215 attributes->bits);
Gilles Peskine449bd832023-01-11 14:50:10 +01008216 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02008217 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01008218 attributes, &key_buffer_size);
8219 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01008220 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008221 }
Ronald Cron977c2472020-10-13 08:32:21 +02008222 }
Ronald Cron977c2472020-10-13 08:32:21 +02008223
Gilles Peskine449bd832023-01-11 14:50:10 +01008224 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
8225 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02008226 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008227 }
Ronald Cron977c2472020-10-13 08:32:21 +02008228 }
8229
Gilles Peskine449bd832023-01-11 14:50:10 +01008230 status = psa_driver_wrapper_generate_key(attributes,
Gilles Peskinef36d7852024-06-06 21:11:44 +02008231 custom,
8232 custom_data, custom_data_length,
Gilles Peskine7a18f962024-02-12 16:48:11 +01008233 slot->key.data, slot->key.bytes,
8234 &slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01008235 if (status != PSA_SUCCESS) {
8236 psa_remove_key_data_from_memory(slot);
8237 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02008238
Gilles Peskine11792082019-08-06 18:36:36 +02008239exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008240 if (status == PSA_SUCCESS) {
8241 status = psa_finish_key_creation(slot, driver, key);
8242 }
8243 if (status != PSA_SUCCESS) {
8244 psa_fail_key_creation(slot, driver);
8245 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02008246
Gilles Peskine449bd832023-01-11 14:50:10 +01008247 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008248}
8249
Gilles Peskinef36d7852024-06-06 21:11:44 +02008250psa_status_t psa_generate_key_ext(const psa_key_attributes_t *attributes,
8251 const psa_key_production_parameters_t *params,
8252 size_t params_data_length,
8253 mbedtls_svc_key_id_t *key)
8254{
8255 return psa_generate_key_custom(
8256 attributes,
8257 (const psa_custom_key_parameters_t *) params,
8258 params->data, params_data_length,
8259 key);
8260}
8261
Gilles Peskinef0765fa2024-02-12 16:46:16 +01008262psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
8263 mbedtls_svc_key_id_t *key)
8264{
Gilles Peskinef36d7852024-06-06 21:11:44 +02008265 return psa_generate_key_custom(attributes,
8266 &default_custom_production,
8267 NULL, 0,
8268 key);
Gilles Peskinef0765fa2024-02-12 16:46:16 +01008269}
8270
Gilles Peskinecdb37812025-02-05 18:02:49 +01008271
8272
Gilles Peskinee59236f2018-01-27 23:32:46 +01008273/****************************************************************/
8274/* Module setup */
8275/****************************************************************/
8276
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01008277#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01008278psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01008279 void (* entropy_init)(mbedtls_entropy_context *ctx),
8280 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01008281{
Paul Elliott8e151532024-02-23 17:35:29 +00008282 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8283
8284#if defined(MBEDTLS_THREADING_C)
8285 mbedtls_mutex_lock(&mbedtls_threading_psa_rngdata_mutex);
8286#endif /* defined(MBEDTLS_THREADING_C) */
8287
Gilles Peskine449bd832023-01-11 14:50:10 +01008288 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
Paul Elliott8e151532024-02-23 17:35:29 +00008289 status = PSA_ERROR_BAD_STATE;
8290 } else {
8291 global_data.rng.entropy_init = entropy_init;
8292 global_data.rng.entropy_free = entropy_free;
8293 status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01008294 }
Paul Elliott8e151532024-02-23 17:35:29 +00008295
8296#if defined(MBEDTLS_THREADING_C)
8297 mbedtls_mutex_unlock(&mbedtls_threading_psa_rngdata_mutex);
8298#endif /* defined(MBEDTLS_THREADING_C) */
8299
8300 return status;
Gilles Peskine5e769522018-11-20 21:59:56 +01008301}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01008302#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01008303
Gilles Peskine449bd832023-01-11 14:50:10 +01008304void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01008305{
Paul Elliott47cee8e2024-03-08 21:38:02 +00008306
Paul Elliott600472b2024-02-23 17:26:58 +00008307#if defined(MBEDTLS_THREADING_C)
8308 mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex);
8309#endif /* defined(MBEDTLS_THREADING_C) */
8310
Paul Elliott47cee8e2024-03-08 21:38:02 +00008311 /* Nothing to do to free transaction. */
8312 if (global_data.initialized & PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED) {
8313 global_data.initialized &= ~PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED;
Valerio Setti83e0de82023-11-24 12:13:05 +01008314 }
Paul Elliott600472b2024-02-23 17:26:58 +00008315
Paul Elliott47cee8e2024-03-08 21:38:02 +00008316 if (global_data.initialized & PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS_INITIALIZED) {
8317 psa_wipe_all_key_slots();
8318 global_data.initialized &= ~PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS_INITIALIZED;
8319 }
Ronald Cron9ba76912021-04-10 16:57:30 +02008320
Paul Elliott600472b2024-02-23 17:26:58 +00008321#if defined(MBEDTLS_THREADING_C)
8322 mbedtls_mutex_unlock(&mbedtls_threading_psa_globaldata_mutex);
8323#endif /* defined(MBEDTLS_THREADING_C) */
8324
Paul Elliott47cee8e2024-03-08 21:38:02 +00008325#if defined(MBEDTLS_THREADING_C)
8326 mbedtls_mutex_lock(&mbedtls_threading_psa_rngdata_mutex);
8327#endif /* defined(MBEDTLS_THREADING_C) */
8328
Gilles Peskinec6b69072018-11-20 21:42:52 +01008329 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01008330 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01008331 }
Paul Elliott47cee8e2024-03-08 21:38:02 +00008332 global_data.rng_state = RNG_NOT_INITIALIZED;
8333 mbedtls_platform_zeroize(&global_data.rng, sizeof(global_data.rng));
8334
8335#if defined(MBEDTLS_THREADING_C)
8336 mbedtls_mutex_unlock(&mbedtls_threading_psa_rngdata_mutex);
8337#endif /* defined(MBEDTLS_THREADING_C) */
8338
8339#if defined(MBEDTLS_THREADING_C)
8340 mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex);
8341#endif /* defined(MBEDTLS_THREADING_C) */
Ronald Cron9ba76912021-04-10 16:57:30 +02008342
8343 /* Terminate drivers */
Paul Elliott47cee8e2024-03-08 21:38:02 +00008344 if (global_data.initialized & PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS_INITIALIZED) {
8345 psa_driver_wrapper_free();
8346 global_data.initialized &= ~PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS_INITIALIZED;
8347 }
8348
8349#if defined(MBEDTLS_THREADING_C)
8350 mbedtls_mutex_unlock(&mbedtls_threading_psa_globaldata_mutex);
8351#endif /* defined(MBEDTLS_THREADING_C) */
8352
Gilles Peskinee59236f2018-01-27 23:32:46 +01008353}
8354
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008355#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
8356/** Recover a transaction that was interrupted by a power failure.
8357 *
8358 * This function is called during initialization, before psa_crypto_init()
8359 * returns. If this function returns a failure status, the initialization
8360 * fails.
8361 */
8362static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01008363 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008364{
Gilles Peskine449bd832023-01-11 14:50:10 +01008365 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008366 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
8367 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008368 /* TODO - fall through to the failure case until this
8369 * is implemented.
8370 * https://github.com/ARMmbed/mbed-crypto/issues/218
8371 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008372 default:
8373 /* We found an unsupported transaction in the storage.
8374 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008375 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008376 }
8377}
8378#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
8379
Paul Elliott47cee8e2024-03-08 21:38:02 +00008380static psa_status_t mbedtls_psa_crypto_init_subsystem(mbedtls_psa_crypto_subsystem subsystem)
8381{
8382 psa_status_t status = PSA_SUCCESS;
8383 uint8_t driver_wrappers_initialized = 0;
8384
8385 switch (subsystem) {
8386 case PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS:
8387
8388#if defined(MBEDTLS_THREADING_C)
8389 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex));
8390#endif /* defined(MBEDTLS_THREADING_C) */
8391
8392 if (!(global_data.initialized & PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS_INITIALIZED)) {
8393 /* Init drivers */
8394 status = psa_driver_wrapper_init();
8395
8396 /* Drivers need shutdown regardless of startup errors. */
8397 global_data.initialized |= PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS_INITIALIZED;
8398
8399
8400 }
8401#if defined(MBEDTLS_THREADING_C)
8402 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_unlock(
8403 &mbedtls_threading_psa_globaldata_mutex));
8404#endif /* defined(MBEDTLS_THREADING_C) */
8405
8406 break;
8407
8408 case PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS:
8409
8410#if defined(MBEDTLS_THREADING_C)
8411 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex));
8412#endif /* defined(MBEDTLS_THREADING_C) */
8413
8414 if (!(global_data.initialized & PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS_INITIALIZED)) {
8415 status = psa_initialize_key_slots();
8416
8417 /* Need to wipe keys even if initialization fails. */
8418 global_data.initialized |= PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS_INITIALIZED;
8419
8420 }
8421#if defined(MBEDTLS_THREADING_C)
8422 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_unlock(
8423 &mbedtls_threading_psa_globaldata_mutex));
8424#endif /* defined(MBEDTLS_THREADING_C) */
8425
8426 break;
8427
8428 case PSA_CRYPTO_SUBSYSTEM_RNG:
8429
8430#if defined(MBEDTLS_THREADING_C)
8431 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex));
8432#endif /* defined(MBEDTLS_THREADING_C) */
8433
8434 driver_wrappers_initialized =
8435 (global_data.initialized & PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS_INITIALIZED);
8436
8437#if defined(MBEDTLS_THREADING_C)
8438 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_unlock(
8439 &mbedtls_threading_psa_globaldata_mutex));
8440#endif /* defined(MBEDTLS_THREADING_C) */
8441
8442 /* Need to use separate mutex here, as initialisation can require
8443 * testing of init flags, which requires locking the global data
8444 * mutex. */
8445#if defined(MBEDTLS_THREADING_C)
8446 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(&mbedtls_threading_psa_rngdata_mutex));
8447#endif /* defined(MBEDTLS_THREADING_C) */
8448
8449 /* Initialize and seed the random generator. */
8450 if (global_data.rng_state == RNG_NOT_INITIALIZED && driver_wrappers_initialized) {
8451 mbedtls_psa_random_init(&global_data.rng);
8452 global_data.rng_state = RNG_INITIALIZED;
8453
8454 status = mbedtls_psa_random_seed(&global_data.rng);
8455 if (status == PSA_SUCCESS) {
8456 global_data.rng_state = RNG_SEEDED;
8457 }
8458 }
8459
8460#if defined(MBEDTLS_THREADING_C)
8461 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_unlock(
8462 &mbedtls_threading_psa_rngdata_mutex));
8463#endif /* defined(MBEDTLS_THREADING_C) */
8464
Paul Elliott47cee8e2024-03-08 21:38:02 +00008465 break;
8466
8467 case PSA_CRYPTO_SUBSYSTEM_TRANSACTION:
8468
8469#if defined(MBEDTLS_THREADING_C)
8470 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex));
8471#endif /* defined(MBEDTLS_THREADING_C) */
8472
8473 if (!(global_data.initialized & PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED)) {
8474#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
8475 status = psa_crypto_load_transaction();
8476 if (status == PSA_SUCCESS) {
8477 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
8478 if (status == PSA_SUCCESS) {
8479 global_data.initialized |= PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED;
8480 }
8481 status = psa_crypto_stop_transaction();
8482 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
8483 /* There's no transaction to complete. It's all good. */
8484 global_data.initialized |= PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED;
8485 status = PSA_SUCCESS;
8486 }
8487#else /* defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS) */
8488 global_data.initialized |= PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED;
8489 status = PSA_SUCCESS;
8490#endif /* defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS) */
8491 }
8492
8493#if defined(MBEDTLS_THREADING_C)
8494 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_unlock(
8495 &mbedtls_threading_psa_globaldata_mutex));
8496#endif /* defined(MBEDTLS_THREADING_C) */
8497
8498 break;
8499
8500 default:
8501 status = PSA_ERROR_CORRUPTION_DETECTED;
8502 }
8503
8504 /* Exit label only required when using threading macros. */
8505#if defined(MBEDTLS_THREADING_C)
8506exit:
8507#endif /* defined(MBEDTLS_THREADING_C) */
8508
8509 return status;
8510}
8511
Gilles Peskine449bd832023-01-11 14:50:10 +01008512psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01008513{
Gilles Peskine66fb1262018-12-10 16:29:04 +01008514 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008515
Paul Elliott47cee8e2024-03-08 21:38:02 +00008516 /* Double initialization is explicitly allowed. Early out if everything is
8517 * done. */
8518 if (psa_get_initialized()) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008519 return PSA_SUCCESS;
8520 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01008521
Paul Elliott47cee8e2024-03-08 21:38:02 +00008522 status = mbedtls_psa_crypto_init_subsystem(PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS);
Valerio Setti402cfba2023-11-13 10:24:32 +01008523 if (status != PSA_SUCCESS) {
8524 goto exit;
8525 }
8526
Paul Elliott47cee8e2024-03-08 21:38:02 +00008527 status = mbedtls_psa_crypto_init_subsystem(PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS);
Gilles Peskine449bd832023-01-11 14:50:10 +01008528 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01008529 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008530 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01008531
Paul Elliott47cee8e2024-03-08 21:38:02 +00008532 status = mbedtls_psa_crypto_init_subsystem(PSA_CRYPTO_SUBSYSTEM_RNG);
8533 if (status != PSA_SUCCESS) {
8534 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02008535 }
Gilles Peskinefc762652019-07-22 19:30:34 +02008536
Paul Elliott47cee8e2024-03-08 21:38:02 +00008537 status = mbedtls_psa_crypto_init_subsystem(PSA_CRYPTO_SUBSYSTEM_TRANSACTION);
Gilles Peskinee59236f2018-01-27 23:32:46 +01008538
8539exit:
Paul Elliott600472b2024-02-23 17:26:58 +00008540
Gilles Peskine449bd832023-01-11 14:50:10 +01008541 if (status != PSA_SUCCESS) {
8542 mbedtls_psa_crypto_free();
8543 }
Paul Elliott47cee8e2024-03-08 21:38:02 +00008544
Gilles Peskine449bd832023-01-11 14:50:10 +01008545 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008546}
8547
Gilles Peskinecdb37812025-02-05 18:02:49 +01008548
8549
8550/****************************************************************/
8551/* PAKE */
8552/****************************************************************/
8553
Yanray Wangffc3c482023-07-11 12:01:04 +08008554#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008555psa_status_t psa_crypto_driver_pake_get_password_len(
8556 const psa_crypto_driver_pake_inputs_t *inputs,
8557 size_t *password_len)
8558{
8559 if (inputs->password_len == 0) {
8560 return PSA_ERROR_BAD_STATE;
8561 }
8562
8563 *password_len = inputs->password_len;
8564
8565 return PSA_SUCCESS;
8566}
8567
8568psa_status_t psa_crypto_driver_pake_get_password(
8569 const psa_crypto_driver_pake_inputs_t *inputs,
8570 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
8571{
8572 if (inputs->password_len == 0) {
8573 return PSA_ERROR_BAD_STATE;
8574 }
8575
8576 if (buffer_size < inputs->password_len) {
8577 return PSA_ERROR_BUFFER_TOO_SMALL;
8578 }
8579
8580 memcpy(buffer, inputs->password, inputs->password_len);
8581 *buffer_length = inputs->password_len;
8582
8583 return PSA_SUCCESS;
8584}
8585
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008586psa_status_t psa_crypto_driver_pake_get_user_len(
8587 const psa_crypto_driver_pake_inputs_t *inputs,
8588 size_t *user_len)
8589{
8590 if (inputs->user_len == 0) {
8591 return PSA_ERROR_BAD_STATE;
8592 }
8593
8594 *user_len = inputs->user_len;
8595
8596 return PSA_SUCCESS;
8597}
8598
8599psa_status_t psa_crypto_driver_pake_get_user(
8600 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008601 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008602{
8603 if (inputs->user_len == 0) {
8604 return PSA_ERROR_BAD_STATE;
8605 }
8606
Przemek Stekielc0e62502023-03-14 11:49:36 +01008607 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008608 return PSA_ERROR_BUFFER_TOO_SMALL;
8609 }
8610
Przemek Stekielc0e62502023-03-14 11:49:36 +01008611 memcpy(user_id, inputs->user, inputs->user_len);
8612 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008613
8614 return PSA_SUCCESS;
8615}
8616
8617psa_status_t psa_crypto_driver_pake_get_peer_len(
8618 const psa_crypto_driver_pake_inputs_t *inputs,
8619 size_t *peer_len)
8620{
8621 if (inputs->peer_len == 0) {
8622 return PSA_ERROR_BAD_STATE;
8623 }
8624
8625 *peer_len = inputs->peer_len;
8626
8627 return PSA_SUCCESS;
8628}
8629
8630psa_status_t psa_crypto_driver_pake_get_peer(
8631 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008632 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008633{
8634 if (inputs->peer_len == 0) {
8635 return PSA_ERROR_BAD_STATE;
8636 }
8637
Przemek Stekielc0e62502023-03-14 11:49:36 +01008638 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008639 return PSA_ERROR_BUFFER_TOO_SMALL;
8640 }
8641
Przemek Stekielc0e62502023-03-14 11:49:36 +01008642 memcpy(peer_id, inputs->peer, inputs->peer_len);
8643 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008644
8645 return PSA_SUCCESS;
8646}
8647
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008648psa_status_t psa_crypto_driver_pake_get_cipher_suite(
8649 const psa_crypto_driver_pake_inputs_t *inputs,
8650 psa_pake_cipher_suite_t *cipher_suite)
8651{
8652 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
8653 return PSA_ERROR_BAD_STATE;
8654 }
8655
8656 *cipher_suite = inputs->cipher_suite;
8657
8658 return PSA_SUCCESS;
8659}
8660
Neil Armstronga7d08c32022-06-01 18:21:20 +02008661psa_status_t psa_pake_setup(
8662 psa_pake_operation_t *operation,
8663 const psa_pake_cipher_suite_t *cipher_suite)
8664{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008665 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008666
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008667 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008668 status = PSA_ERROR_BAD_STATE;
8669 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008670 }
8671
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008672 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01008673 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008674 status = PSA_ERROR_INVALID_ARGUMENT;
8675 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008676 }
8677
Gilles Peskinea7a480b2025-02-05 19:41:52 +01008678 /* Make sure the variable-purpose part of the operation is zeroed.
8679 * Initializing the operation does not necessarily take care of it,
8680 * since the context is a union and initializing a union does not
8681 * necessarily initialize all of its members. */
8682 memset(&operation->data, 0, sizeof(operation->data));
Przemek Stekiel51eac532022-12-07 11:04:51 +01008683
Przemek Stekiele12ed362022-12-21 12:54:46 +01008684 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01008685 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
8686 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008687 operation->data.inputs.cipher_suite = *cipher_suite;
8688
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008689#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008690 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008691 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01008692 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008693
David Horstmann16f01512023-06-14 17:21:07 +01008694 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01008695 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008696 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008697#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008698 {
8699 status = PSA_ERROR_NOT_SUPPORTED;
8700 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008701 }
8702
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008703 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
8704
Przemek Stekiel51eac532022-12-07 11:04:51 +01008705 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008706exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008707 psa_pake_abort(operation);
8708 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008709}
8710
8711psa_status_t psa_pake_set_password_key(
8712 psa_pake_operation_t *operation,
8713 mbedtls_svc_key_id_t password)
8714{
Neil Armstrong5ae60962022-09-15 11:29:46 +02008715 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01008716 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
8717 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008718 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008719
Przemek Stekiel51eac532022-12-07 11:04:51 +01008720 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008721 status = PSA_ERROR_BAD_STATE;
8722 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008723 }
8724
Przemek Stekiel6c764412022-11-22 14:05:12 +01008725 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
8726 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008727 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008728 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008729 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008730 }
8731
Gilles Peskine7a5d9202024-02-28 01:18:23 +01008732 type = psa_get_key_type(&slot->attr);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008733
Przemek Stekiel51eac532022-12-07 11:04:51 +01008734 if (type != PSA_KEY_TYPE_PASSWORD &&
8735 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8736 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008737 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008738 }
8739
Przemek Stekiel51eac532022-12-07 11:04:51 +01008740 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8741 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008742 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008743 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008744 }
8745
8746 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8747 operation->data.inputs.password_len = slot->key.bytes;
Gilles Peskine7fad3ef2024-02-28 01:08:27 +01008748 operation->data.inputs.attributes = slot->attr;
8749
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008750exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008751 if (status != PSA_SUCCESS) {
8752 psa_pake_abort(operation);
8753 }
Ryan Everettbbedfce2024-02-14 18:22:09 +00008754 unlock_status = psa_unregister_read_under_mutex(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008755 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008756}
8757
8758psa_status_t psa_pake_set_user(
8759 psa_pake_operation_t *operation,
David Horstmann4f534ae2024-01-22 17:35:59 +00008760 const uint8_t *user_id_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008761 size_t user_id_len)
8762{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008763 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
David Horstmann4f534ae2024-01-22 17:35:59 +00008764 LOCAL_INPUT_DECLARE(user_id_external, user_id);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008765
8766 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008767 status = PSA_ERROR_BAD_STATE;
8768 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008769 }
8770
Przemek Stekiel51eac532022-12-07 11:04:51 +01008771 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008772 status = PSA_ERROR_INVALID_ARGUMENT;
8773 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008774 }
8775
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008776 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008777 status = PSA_ERROR_BAD_STATE;
8778 goto exit;
8779 }
8780
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008781 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8782 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008783 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8784 goto exit;
8785 }
8786
David Horstmann4f534ae2024-01-22 17:35:59 +00008787 LOCAL_INPUT_ALLOC(user_id_external, user_id_len, user_id);
8788
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008789 memcpy(operation->data.inputs.user, user_id, user_id_len);
8790 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008791
David Horstmann4f534ae2024-01-22 17:35:59 +00008792 status = PSA_SUCCESS;
8793
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008794exit:
David Horstmann4f534ae2024-01-22 17:35:59 +00008795 LOCAL_INPUT_FREE(user_id_external, user_id);
8796 if (status != PSA_SUCCESS) {
8797 psa_pake_abort(operation);
8798 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008799 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008800}
8801
8802psa_status_t psa_pake_set_peer(
8803 psa_pake_operation_t *operation,
David Horstmann4f534ae2024-01-22 17:35:59 +00008804 const uint8_t *peer_id_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008805 size_t peer_id_len)
8806{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008807 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
David Horstmann4f534ae2024-01-22 17:35:59 +00008808 LOCAL_INPUT_DECLARE(peer_id_external, peer_id);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008809
8810 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008811 status = PSA_ERROR_BAD_STATE;
8812 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008813 }
8814
Przemek Stekiel51eac532022-12-07 11:04:51 +01008815 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008816 status = PSA_ERROR_INVALID_ARGUMENT;
8817 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008818 }
8819
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008820 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008821 status = PSA_ERROR_BAD_STATE;
8822 goto exit;
8823 }
8824
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008825 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8826 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008827 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8828 goto exit;
8829 }
8830
David Horstmann4f534ae2024-01-22 17:35:59 +00008831 LOCAL_INPUT_ALLOC(peer_id_external, peer_id_len, peer_id);
8832
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008833 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8834 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008835
David Horstmann4f534ae2024-01-22 17:35:59 +00008836 status = PSA_SUCCESS;
8837
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008838exit:
David Horstmann4f534ae2024-01-22 17:35:59 +00008839 LOCAL_INPUT_FREE(peer_id_external, peer_id);
8840 if (status != PSA_SUCCESS) {
8841 psa_pake_abort(operation);
8842 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008843 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008844}
8845
8846psa_status_t psa_pake_set_role(
8847 psa_pake_operation_t *operation,
8848 psa_pake_role_t role)
8849{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008850 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008851
Przemek Stekiel51eac532022-12-07 11:04:51 +01008852 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008853 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008854 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008855 }
8856
Przemek Stekiel09104b82023-03-06 14:11:51 +01008857 switch (operation->alg) {
8858#if defined(PSA_WANT_ALG_JPAKE)
8859 case PSA_ALG_JPAKE:
8860 if (role == PSA_PAKE_ROLE_NONE) {
8861 return PSA_SUCCESS;
8862 }
8863 status = PSA_ERROR_INVALID_ARGUMENT;
8864 break;
8865#endif
8866 default:
8867 (void) role;
8868 status = PSA_ERROR_NOT_SUPPORTED;
8869 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008870 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008871exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008872 psa_pake_abort(operation);
8873 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008874}
8875
David Horstmanne7f21e62023-05-12 18:17:21 +01008876/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008877#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008878static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008879 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008880{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008881 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008882 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008883 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008884
David Horstmann024e5c52023-06-14 15:48:21 +01008885 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008886 is_x1 = (stage->outputs < 1);
8887 } else {
8888 is_x1 = (stage->inputs < 1);
8889 }
8890
David Horstmann74a3d8c2023-06-14 18:28:19 +01008891 key_share_step = is_x1 ?
8892 PSA_JPAKE_X1_STEP_KEY_SHARE :
8893 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008894 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008895 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8896 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8897 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8898 } else {
8899 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008900 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008901 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008902}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008903#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008904
Przemek Stekiel2797d372022-12-22 11:19:22 +01008905static psa_status_t psa_pake_complete_inputs(
8906 psa_pake_operation_t *operation)
8907{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008908 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008909 /* Create copy of the inputs on stack as inputs share memory
8910 with the driver context which will be setup by the driver. */
8911 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008912
Przemek Stekielfde11282023-03-13 16:06:09 +01008913 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008914 return PSA_ERROR_BAD_STATE;
8915 }
8916
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008917 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008918 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8919 return PSA_ERROR_BAD_STATE;
8920 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008921 }
8922
Przemek Stekiel18620a32023-01-17 16:34:52 +01008923 /* Clear driver context */
8924 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8925
8926 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008927
8928 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008929 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008930
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008931 /* User and peer are translated to role. */
8932 mbedtls_free(inputs.user);
8933 mbedtls_free(inputs.peer);
8934
Przemek Stekiel2797d372022-12-22 11:19:22 +01008935 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008936#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008937 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008938 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008939 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008940#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008941 {
8942 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008943 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008944 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008945 return status;
8946}
8947
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008948#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008949static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008950 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008951 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008952 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008953{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008954 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8955 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8956 step != PSA_PAKE_STEP_ZK_PROOF) {
8957 return PSA_ERROR_INVALID_ARGUMENT;
8958 }
8959
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008960 psa_jpake_computation_stage_t *computation_stage =
8961 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008962
David Horstmann5da95602023-06-08 15:37:12 +01008963 if (computation_stage->round != PSA_JPAKE_FIRST &&
8964 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008965 return PSA_ERROR_BAD_STATE;
8966 }
8967
David Horstmanne7f21e62023-05-12 18:17:21 +01008968 /* Check that the step we are given is the one we were expecting */
8969 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008970 return PSA_ERROR_BAD_STATE;
8971 }
8972
David Horstmanne7f21e62023-05-12 18:17:21 +01008973 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8974 computation_stage->inputs == 0 &&
8975 computation_stage->outputs == 0) {
8976 /* Start of the round, so function decides whether we are inputting
8977 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008978 computation_stage->io_mode = io_mode;
8979 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008980 /* Middle of the round so the mode we are in must match the function
8981 * called by the user */
8982 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008983 }
8984
8985 return PSA_SUCCESS;
8986}
8987
David Horstmanne7f21e62023-05-12 18:17:21 +01008988static psa_status_t psa_jpake_epilogue(
8989 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008990 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008991{
David Horstmanne7f21e62023-05-12 18:17:21 +01008992 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008993 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008994
David Horstmanne7f21e62023-05-12 18:17:21 +01008995 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8996 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008997 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008998 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008999 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01009000 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01009001 }
9002 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01009003 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01009004 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01009005 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01009006 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01009007 }
9008 }
David Horstmann246ec5a2023-06-27 10:33:06 +01009009 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
9010 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01009011 /* End of a round, move to the next round */
9012 stage->inputs = 0;
9013 stage->outputs = 0;
9014 stage->round++;
9015 }
9016 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01009017 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01009018 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01009019 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01009020 return PSA_SUCCESS;
9021}
David Horstmanne7f21e62023-05-12 18:17:21 +01009022
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01009023#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01009024
Neil Armstronga7d08c32022-06-01 18:21:20 +02009025psa_status_t psa_pake_output(
9026 psa_pake_operation_t *operation,
9027 psa_pake_step_t step,
David Horstmannc75639d2024-01-22 17:56:39 +00009028 uint8_t *output_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02009029 size_t output_size,
9030 size_t *output_length)
9031{
Przemek Stekiel51eac532022-12-07 11:04:51 +01009032 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01009033 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
David Horstmannc75639d2024-01-22 17:56:39 +00009034 LOCAL_OUTPUT_DECLARE(output_external, output);
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01009035 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01009036
9037 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01009038 status = psa_pake_complete_inputs(operation);
9039 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009040 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01009041 }
9042 }
9043
9044 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009045 status = PSA_ERROR_BAD_STATE;
9046 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01009047 }
9048
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01009049 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009050 status = PSA_ERROR_INVALID_ARGUMENT;
9051 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02009052 }
9053
Przemek Stekiele12ed362022-12-21 12:54:46 +01009054 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01009055#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01009056 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01009057 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01009058 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009059 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01009060 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01009061 driver_step = convert_jpake_computation_stage_to_driver_step(
9062 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01009063 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01009064#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01009065 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01009066 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009067 status = PSA_ERROR_NOT_SUPPORTED;
9068 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01009069 }
9070
David Horstmannc75639d2024-01-22 17:56:39 +00009071 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
9072
Przemek Stekiel691e91a2023-03-07 16:26:37 +01009073 status = psa_driver_wrapper_pake_output(operation, driver_step,
9074 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01009075
9076 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009077 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01009078 }
9079
9080 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01009081#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01009082 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01009083 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01009084 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009085 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01009086 }
9087 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01009088#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01009089 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009090 status = PSA_ERROR_NOT_SUPPORTED;
9091 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01009092 }
9093
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009094exit:
David Horstmannc75639d2024-01-22 17:56:39 +00009095 LOCAL_OUTPUT_FREE(output_external, output);
9096 if (status != PSA_SUCCESS) {
9097 psa_pake_abort(operation);
9098 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01009099 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02009100}
9101
9102psa_status_t psa_pake_input(
9103 psa_pake_operation_t *operation,
9104 psa_pake_step_t step,
David Horstmannc75639d2024-01-22 17:56:39 +00009105 const uint8_t *input_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02009106 size_t input_length)
9107{
Przemek Stekiel51eac532022-12-07 11:04:51 +01009108 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01009109 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01009110 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
9111 operation->primitive,
9112 step);
David Horstmannc75639d2024-01-22 17:56:39 +00009113 LOCAL_INPUT_DECLARE(input_external, input);
Przemek Stekiel51eac532022-12-07 11:04:51 +01009114
9115 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01009116 status = psa_pake_complete_inputs(operation);
9117 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009118 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01009119 }
9120 }
9121
9122 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009123 status = PSA_ERROR_BAD_STATE;
9124 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01009125 }
9126
Przemek Stekiel256c75d2023-03-23 14:09:34 +01009127 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009128 status = PSA_ERROR_INVALID_ARGUMENT;
9129 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02009130 }
9131
Przemek Stekiele12ed362022-12-21 12:54:46 +01009132 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01009133#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01009134 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01009135 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01009136 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009137 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01009138 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01009139 driver_step = convert_jpake_computation_stage_to_driver_step(
9140 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01009141 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01009142#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01009143 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01009144 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01009145 status = PSA_ERROR_NOT_SUPPORTED;
9146 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01009147 }
9148
David Horstmannc75639d2024-01-22 17:56:39 +00009149 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Przemek Stekiel691e91a2023-03-07 16:26:37 +01009150 status = psa_driver_wrapper_pake_input(operation, driver_step,
9151 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01009152
9153 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009154 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01009155 }
9156
9157 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01009158#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01009159 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01009160 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01009161 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009162 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01009163 }
9164 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01009165#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01009166 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009167 status = PSA_ERROR_NOT_SUPPORTED;
9168 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01009169 }
9170
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009171exit:
David Horstmannc75639d2024-01-22 17:56:39 +00009172 LOCAL_INPUT_FREE(input_external, input);
9173 if (status != PSA_SUCCESS) {
9174 psa_pake_abort(operation);
9175 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01009176 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02009177}
9178
9179psa_status_t psa_pake_get_implicit_key(
9180 psa_pake_operation_t *operation,
9181 psa_key_derivation_operation_t *output)
9182{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01009183 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009184 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01009185 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01009186 size_t shared_key_len = 0;
9187
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01009188 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009189 status = PSA_ERROR_BAD_STATE;
9190 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02009191 }
9192
Przemek Stekiel4aa99402023-02-27 13:00:57 +01009193#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01009194 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009195 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01009196 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01009197 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009198 status = PSA_ERROR_BAD_STATE;
9199 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01009200 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01009201 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01009202#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01009203 {
9204 status = PSA_ERROR_NOT_SUPPORTED;
9205 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01009206 }
9207
Przemek Stekiel0c781802022-11-29 14:53:13 +01009208 status = psa_driver_wrapper_pake_get_implicit_key(operation,
9209 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01009210 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01009211 &shared_key_len);
9212
9213 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009214 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01009215 }
9216
9217 status = psa_key_derivation_input_bytes(output,
9218 PSA_KEY_DERIVATION_INPUT_SECRET,
9219 shared_key,
9220 shared_key_len);
9221
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01009222 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01009223exit:
9224 abort_status = psa_pake_abort(operation);
9225 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02009226}
9227
9228psa_status_t psa_pake_abort(
9229 psa_pake_operation_t *operation)
9230{
Przemek Stekield69dca92023-01-31 19:59:20 +01009231 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01009232
Przemek Stekield69dca92023-01-31 19:59:20 +01009233 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01009234 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02009235 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01009236
Przemek Stekiel26c909d2023-02-28 12:34:03 +01009237 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
9238 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009239 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01009240 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01009241 }
9242 if (operation->data.inputs.user != NULL) {
9243 mbedtls_free(operation->data.inputs.user);
9244 }
9245 if (operation->data.inputs.peer != NULL) {
9246 mbedtls_free(operation->data.inputs.peer);
9247 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01009248 }
Przemek Stekield69dca92023-01-31 19:59:20 +01009249 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01009250
Przemek Stekield69dca92023-01-31 19:59:20 +01009251 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02009252}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01009253#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02009254
David Horstmann00d7a042023-12-07 18:39:17 +00009255/* Memory copying test hooks. These are called before input copy, after input
9256 * copy, before output copy and after output copy, respectively.
9257 * They are used by memory-poisoning tests to temporarily unpoison buffers
9258 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00009259#if defined(MBEDTLS_TEST_HOOKS)
9260void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
9261void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
9262void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
9263void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
9264#endif
David Horstmannfde97392023-10-30 20:29:43 +00009265
David Horstmann1b7279a2023-11-15 15:18:30 +00009266/** Copy from an input buffer to a local copy.
9267 *
9268 * \param[in] input Pointer to input buffer.
9269 * \param[in] input_len Length of the input buffer.
9270 * \param[out] input_copy Pointer to a local copy in which to store the input data.
9271 * \param[out] input_copy_len Length of the local copy buffer.
9272 * \return #PSA_SUCCESS, if the buffer was successfully
9273 * copied.
9274 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
9275 * copy is too small to hold contents of the
9276 * input buffer.
9277 */
9278MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00009279psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
9280 uint8_t *input_copy, size_t input_copy_len)
9281{
9282 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00009283 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00009284 }
9285
David Horstmann372b8bb2023-11-24 16:21:04 +00009286#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00009287 if (psa_input_pre_copy_hook != NULL) {
9288 psa_input_pre_copy_hook(input, input_len);
9289 }
David Horstmann372b8bb2023-11-24 16:21:04 +00009290#endif
9291
David Horstmann777e7412023-11-15 17:33:47 +00009292 if (input_len > 0) {
9293 memcpy(input_copy, input, input_len);
9294 }
David Horstmannfde97392023-10-30 20:29:43 +00009295
David Horstmann372b8bb2023-11-24 16:21:04 +00009296#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00009297 if (psa_input_post_copy_hook != NULL) {
9298 psa_input_post_copy_hook(input, input_len);
9299 }
David Horstmann372b8bb2023-11-24 16:21:04 +00009300#endif
9301
David Horstmannfde97392023-10-30 20:29:43 +00009302 return PSA_SUCCESS;
9303}
9304
David Horstmann1b7279a2023-11-15 15:18:30 +00009305/** Copy from a local output buffer into a user-supplied one.
9306 *
9307 * \param[in] output_copy Pointer to a local buffer containing the output.
9308 * \param[in] output_copy_len Length of the local buffer.
9309 * \param[out] output Pointer to user-supplied output buffer.
9310 * \param[out] output_len Length of the user-supplied output buffer.
9311 * \return #PSA_SUCCESS, if the buffer was successfully
9312 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00009313 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00009314 * user-supplied output buffer is too small to
9315 * hold the contents of the local buffer.
9316 */
9317MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00009318psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
9319 uint8_t *output, size_t output_len)
9320{
9321 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00009322 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00009323 }
David Horstmann777e7412023-11-15 17:33:47 +00009324
David Horstmann372b8bb2023-11-24 16:21:04 +00009325#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00009326 if (psa_output_pre_copy_hook != NULL) {
9327 psa_output_pre_copy_hook(output, output_len);
9328 }
David Horstmann372b8bb2023-11-24 16:21:04 +00009329#endif
9330
David Horstmann777e7412023-11-15 17:33:47 +00009331 if (output_copy_len > 0) {
9332 memcpy(output, output_copy, output_copy_len);
9333 }
9334
David Horstmann372b8bb2023-11-24 16:21:04 +00009335#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00009336 if (psa_output_post_copy_hook != NULL) {
9337 psa_output_post_copy_hook(output, output_len);
9338 }
David Horstmann372b8bb2023-11-24 16:21:04 +00009339#endif
9340
David Horstmann8978f5c2023-10-30 20:37:12 +00009341 return PSA_SUCCESS;
9342}
9343
David Horstmannf1734052023-11-20 17:15:32 +00009344psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
9345 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00009346{
9347 psa_status_t status;
9348
David Horstmann9db14482023-11-23 15:50:37 +00009349 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00009350
David Horstmannc5cc1c32023-11-15 18:11:26 +00009351 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00009352 return PSA_SUCCESS;
9353 }
9354
David Horstmannf1734052023-11-20 17:15:32 +00009355 local_input->buffer = mbedtls_calloc(input_len, 1);
9356 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00009357 /* Since we dealt with the zero-length case above, we know that
9358 * a NULL return value means a failure of allocation. */
9359 return PSA_ERROR_INSUFFICIENT_MEMORY;
9360 }
David Horstmannf1734052023-11-20 17:15:32 +00009361 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00009362
David Horstmannf1734052023-11-20 17:15:32 +00009363 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00009364
9365 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00009366 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00009367 if (status != PSA_SUCCESS) {
9368 goto error;
9369 }
9370
9371 return PSA_SUCCESS;
9372
9373error:
Gilles Peskinee847afd2025-03-06 12:41:39 +01009374 mbedtls_zeroize_and_free(local_input->buffer, local_input->length);
David Horstmannf1734052023-11-20 17:15:32 +00009375 local_input->buffer = NULL;
9376 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00009377 return status;
9378}
9379
David Horstmannf1734052023-11-20 17:15:32 +00009380void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00009381{
Gilles Peskinee847afd2025-03-06 12:41:39 +01009382 mbedtls_zeroize_and_free(local_input->buffer, local_input->length);
David Horstmannf1734052023-11-20 17:15:32 +00009383 local_input->buffer = NULL;
9384 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00009385}
9386
David Horstmann89875a42023-11-20 12:54:09 +00009387psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
9388 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00009389{
David Horstmann9db14482023-11-23 15:50:37 +00009390 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00009391
David Horstmannc5cc1c32023-11-15 18:11:26 +00009392 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00009393 return PSA_SUCCESS;
9394 }
David Horstmann89875a42023-11-20 12:54:09 +00009395 local_output->buffer = mbedtls_calloc(output_len, 1);
9396 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00009397 /* Since we dealt with the zero-length case above, we know that
9398 * a NULL return value means a failure of allocation. */
9399 return PSA_ERROR_INSUFFICIENT_MEMORY;
9400 }
David Horstmann89875a42023-11-20 12:54:09 +00009401 local_output->length = output_len;
9402 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00009403
9404 return PSA_SUCCESS;
9405}
9406
David Horstmann89875a42023-11-20 12:54:09 +00009407psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00009408{
David Horstmannc335a4e2023-11-15 15:57:32 +00009409 psa_status_t status;
9410
David Horstmann89875a42023-11-20 12:54:09 +00009411 if (local_output->buffer == NULL) {
9412 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00009413 return PSA_SUCCESS;
9414 }
David Horstmann89875a42023-11-20 12:54:09 +00009415 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00009416 /* We have an internal copy but nothing to copy back to. */
9417 return PSA_ERROR_CORRUPTION_DETECTED;
9418 }
9419
David Horstmann89875a42023-11-20 12:54:09 +00009420 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
9421 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00009422 if (status != PSA_SUCCESS) {
9423 return status;
9424 }
David Horstmann9467ea32023-11-08 17:44:18 +00009425
Gilles Peskinee847afd2025-03-06 12:41:39 +01009426 mbedtls_zeroize_and_free(local_output->buffer, local_output->length);
David Horstmann89875a42023-11-20 12:54:09 +00009427 local_output->buffer = NULL;
9428 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00009429
9430 return PSA_SUCCESS;
9431}
9432
Gilles Peskinee59236f2018-01-27 23:32:46 +01009433#endif /* MBEDTLS_PSA_CRYPTO_C */