blob: 969c695ac09c25ccfed44d7b02472b48eb942ae8 [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{
Gilles Peskine449bd832023-01-11 14:50:10 +0100708 if (slot->key.data != NULL) {
709 return PSA_ERROR_ALREADY_EXISTS;
710 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200711
Gilles Peskine449bd832023-01-11 14:50:10 +0100712 slot->key.data = mbedtls_calloc(1, buffer_length);
713 if (slot->key.data == NULL) {
714 return PSA_ERROR_INSUFFICIENT_MEMORY;
715 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200716
Ronald Cronea0f8a62020-11-25 17:52:23 +0100717 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100718 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200719}
720
Gilles Peskine449bd832023-01-11 14:50:10 +0100721psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
722 const uint8_t *data,
723 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200724{
Gilles Peskine449bd832023-01-11 14:50:10 +0100725 psa_status_t status = psa_allocate_buffer_to_slot(slot,
726 data_length);
727 if (status != PSA_SUCCESS) {
728 return status;
729 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200730
Gilles Peskine449bd832023-01-11 14:50:10 +0100731 memcpy(slot->key.data, data, data_length);
732 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200733}
734
Ronald Crona0fe59f2020-11-29 11:14:53 +0100735psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100736 const psa_key_attributes_t *attributes,
737 const uint8_t *data, size_t data_length,
738 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100739 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100740{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100741 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f107ae2024-02-28 01:26:46 +0100742 psa_key_type_t type = attributes->type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100743
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200744 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100745 if (data_length == 0) {
746 return PSA_ERROR_NOT_SUPPORTED;
747 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200748
Gilles Peskine449bd832023-01-11 14:50:10 +0100749 if (key_type_is_raw_bytes(type)) {
750 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200751
Gilles Peskine2f107ae2024-02-28 01:26:46 +0100752 status = psa_validate_unstructured_key_bit_size(attributes->type,
Gilles Peskine449bd832023-01-11 14:50:10 +0100753 *bits);
754 if (status != PSA_SUCCESS) {
755 return status;
756 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200757
Ronald Crondd04d422020-11-28 15:14:42 +0100758 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100759 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100760 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100761 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200762
Gilles Peskine449bd832023-01-11 14:50:10 +0100763 return PSA_SUCCESS;
764 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +0200765#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200766 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100767 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200768 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Valerio Setti504a1022024-01-17 15:19:30 +0100769 return PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100770 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200771 return mbedtls_psa_ffdh_import_key(attributes,
772 data, data_length,
773 key_buffer, key_buffer_size,
774 key_buffer_length,
775 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100776 }
Valerio Settia55f0422023-07-10 15:34:41 +0200777#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200778 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti27c501a2023-06-27 16:58:52 +0200779#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100780 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
781 if (PSA_KEY_TYPE_IS_ECC(type)) {
782 return mbedtls_psa_ecp_import_key(attributes,
783 data, data_length,
784 key_buffer, key_buffer_size,
785 key_buffer_length,
786 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100787 }
Valerio Setti27c501a2023-06-27 16:58:52 +0200788#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800789 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settife478902023-07-25 12:27:19 +0200790#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
791 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100792 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
793 if (PSA_KEY_TYPE_IS_RSA(type)) {
794 return mbedtls_psa_rsa_import_key(attributes,
795 data, data_length,
796 key_buffer, key_buffer_size,
797 key_buffer_length,
798 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200799 }
Valerio Settife478902023-07-25 12:27:19 +0200800#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
801 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -0800802 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100803 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100804
Gilles Peskine449bd832023-01-11 14:50:10 +0100805 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100806}
807
Gilles Peskinef603c712019-01-19 13:40:11 +0100808/** Calculate the intersection of two algorithm usage policies.
809 *
810 * Return 0 (which allows no operation) on incompatibility.
811 */
812static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100813 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100814 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100815 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100816{
Gilles Peskine549ea862019-05-22 11:45:59 +0200817 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100818 if (alg1 == alg2) {
819 return alg1;
820 }
Steven Cooreman03488022021-02-18 12:07:20 +0100821 /* If the policies are from the same hash-and-sign family, check
822 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100823 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
824 PSA_ALG_IS_SIGN_HASH(alg2) &&
825 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
826 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
827 return alg2;
828 }
829 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
830 return alg1;
831 }
Steven Cooreman03488022021-02-18 12:07:20 +0100832 }
833 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100834 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100835 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100836 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
837 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
838 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
839 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
840 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100841 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100842
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100843 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100844 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
845 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
846 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
847 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100848 }
849 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100850 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
851 (alg1_len <= alg2_len)) {
852 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100853 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100854 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
855 (alg2_len <= alg1_len)) {
856 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100857 }
858 }
859 /* If the policies are from the same MAC family, check whether one
860 * of them is a minimum-MAC-length policy. Calculate the most
861 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100862 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
863 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
864 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100865 /* Validate the combination of key type and algorithm. Since the base
866 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100867 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
868 return 0;
869 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100870
Steven Cooreman31a876d2021-03-03 20:47:40 +0100871 /* Get the (exact or at-least) output lengths for both sides of the
872 * requested intersection. None of the currently supported algorithms
873 * have an output length dependent on the actual key size, so setting it
874 * to a bogus value of 0 is currently OK.
875 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100876 * Note that for at-least-this-length wildcard algorithms, the output
877 * length is set to the shortest allowed length, which allows us to
878 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100879 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
880 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100881 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100882
Steven Cooremana1d83222021-02-25 10:20:29 +0100883 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100884 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
885 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
886 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100887 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100888
889 /* If only one is an at-least-this-length policy, the intersection would
890 * be the other (fixed-length) policy as long as said fixed length is
891 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100892 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
893 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100894 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100895 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
896 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100897 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100898
Steven Cooremancd640932021-03-08 12:00:27 +0100899 /* If none of them are wildcards, check whether they define the same tag
900 * length. This is still possible here when one is default-length and
901 * the other specific-length. Ensure to always return the
902 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100903 if (alg1_len == alg2_len) {
904 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
905 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100906 }
907 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100908 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100909}
910
Gilles Peskine449bd832023-01-11 14:50:10 +0100911static int psa_key_algorithm_permits(psa_key_type_t key_type,
912 psa_algorithm_t policy_alg,
913 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200914{
Gilles Peskine549ea862019-05-22 11:45:59 +0200915 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100916 if (requested_alg == policy_alg) {
917 return 1;
918 }
Steven Cooreman03488022021-02-18 12:07:20 +0100919 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
920 * and requested_alg is the same hash-and-sign family with any hash,
921 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100922 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
923 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
924 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
925 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100926 }
927 /* If policy_alg is a wildcard AEAD algorithm of the same base as
928 * the requested algorithm, check the requested tag length to be
929 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100930 if (PSA_ALG_IS_AEAD(policy_alg) &&
931 PSA_ALG_IS_AEAD(requested_alg) &&
932 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
933 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
934 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
935 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
936 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100937 }
Steven Cooremancd640932021-03-08 12:00:27 +0100938 /* If policy_alg is a MAC algorithm of the same base as the requested
939 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100940 if (PSA_ALG_IS_MAC(policy_alg) &&
941 PSA_ALG_IS_MAC(requested_alg) &&
942 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
943 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100944 /* Validate the combination of key type and algorithm. Since the policy
945 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100946 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
947 return 0;
948 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100949
Steven Cooreman31a876d2021-03-03 20:47:40 +0100950 /* Get both the requested output length for the algorithm which is to be
951 * verified, and the default output length for the base algorithm.
952 * Note that none of the currently supported algorithms have an output
953 * length dependent on actual key size, so setting it to a bogus value
954 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100955 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100957 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100958 key_type, 0,
959 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100960
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100961 /* If the policy is default-length, only allow an algorithm with
962 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100963 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
964 return requested_output_length == default_output_length;
965 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100966
967 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100968 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100969 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
970 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
971 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100972 }
973
Steven Cooremancd640932021-03-08 12:00:27 +0100974 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
975 * check for the requested MAC length to be equal to or longer than the
976 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100977 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
978 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
979 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100980 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200981 }
Steven Cooremance48e852020-10-05 16:02:45 +0200982 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200983 * a key derivation with that key agreement should also be allowed. This
984 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100985 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
986 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
987 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
988 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +0200989 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100990 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100991 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200992}
993
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100994/** Test whether a policy permits an algorithm.
995 *
996 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100997 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100998 * \note This function requires providing the key type for which the policy is
999 * being validated, since some algorithm policy definitions (e.g. MAC)
1000 * have different properties depending on what kind of cipher it is
1001 * combined with.
1002 *
Steven Cooreman7e39f052021-02-23 14:18:32 +01001003 * \retval PSA_SUCCESS When \p alg is a specific algorithm
1004 * allowed by the \p policy.
1005 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
1006 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
1007 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001008 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001009static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
1010 psa_key_type_t key_type,
1011 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001012{
Steven Cooremand788fab2021-02-25 11:29:17 +01001013 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01001014 if (alg == 0) {
1015 return PSA_ERROR_INVALID_ARGUMENT;
1016 }
Steven Cooremand788fab2021-02-25 11:29:17 +01001017
Steven Cooreman7e39f052021-02-23 14:18:32 +01001018 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001019 if (PSA_ALG_IS_WILDCARD(alg)) {
1020 return PSA_ERROR_INVALID_ARGUMENT;
1021 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001022
Gilles Peskine449bd832023-01-11 14:50:10 +01001023 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
1024 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
1025 return PSA_SUCCESS;
1026 } else {
1027 return PSA_ERROR_NOT_PERMITTED;
1028 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001029}
1030
Gilles Peskinef603c712019-01-19 13:40:11 +01001031/** Restrict a key policy based on a constraint.
1032 *
Steven Cooreman5a172672021-03-02 21:27:42 +01001033 * \note This function requires providing the key type for which the policy is
1034 * being restricted, since some algorithm policy definitions (e.g. MAC)
1035 * have different properties depending on what kind of cipher it is
1036 * combined with.
1037 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001038 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +01001039 * \param[in,out] policy The policy to restrict.
1040 * \param[in] constraint The policy constraint to apply.
1041 *
1042 * \retval #PSA_SUCCESS
1043 * \c *policy contains the intersection of the original value of
1044 * \c *policy and \c *constraint.
1045 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001046 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +01001047 * \c *policy is unchanged.
1048 */
1049static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001050 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +01001051 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +01001052 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +01001053{
1054 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 psa_key_policy_algorithm_intersection(key_type, policy->alg,
1056 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +02001057 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
1059 constraint->alg2);
1060 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
1061 return PSA_ERROR_INVALID_ARGUMENT;
1062 }
1063 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
1064 return PSA_ERROR_INVALID_ARGUMENT;
1065 }
Gilles Peskinef603c712019-01-19 13:40:11 +01001066 policy->usage &= constraint->usage;
1067 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001068 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001069 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +01001070}
1071
Przemek Stekiel061f6942022-11-30 10:51:35 +01001072/** Get the description of a key given its identifier and policy constraints
1073 * and lock it.
1074 *
1075 * The key must have allow all the usage flags set in \p usage. If \p alg is
1076 * nonzero, the key must allow operations with this algorithm. If \p alg is
1077 * zero, the algorithm is not checked.
1078 *
1079 * In case of a persistent key, the function loads the description of the key
1080 * into a key slot if not already done.
1081 *
Ryan Everett098c6652024-01-03 13:03:36 +00001082 * On success, the returned key slot has been registered for reading.
Ryan Everett93cea572024-02-20 18:01:29 +00001083 * It is the responsibility of the caller to then unregister
1084 * once they have finished reading the contents of the slot.
1085 * The caller unregisters by calling psa_unregister_read() or
1086 * psa_unregister_read_under_mutex(). psa_unregister_read() must be called
1087 * if and only if the caller already holds the global key slot mutex
1088 * (when mutexes are enabled). psa_unregister_read_under_mutex() encapsulates
1089 * the unregister with mutex lock and unlock operations.
Przemek Stekiel061f6942022-11-30 10:51:35 +01001090 */
1091static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01001092 mbedtls_svc_key_id_t key,
1093 psa_key_slot_t **p_slot,
1094 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +01001096{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001097 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01001098 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001099
Gilles Peskine449bd832023-01-11 14:50:10 +01001100 status = psa_get_and_lock_key_slot(key, p_slot);
1101 if (status != PSA_SUCCESS) {
1102 return status;
1103 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001104 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001105
1106 /* Enforce that usage policy for the key slot contains all the flags
1107 * required by the usage parameter. There is one exception: public
1108 * keys can always be exported, so we treat public key objects as
1109 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001110 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +01001111 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001113
Gilles Peskine449bd832023-01-11 14:50:10 +01001114 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +01001115 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001116 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001117 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001118
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001119 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001120 if (alg != 0) {
1121 status = psa_key_policy_permits(&slot->attr.policy,
1122 slot->attr.type,
1123 alg);
1124 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +01001125 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001127 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001128
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001130
1131error:
1132 *p_slot = NULL;
Ryan Everettfb792ca2024-01-31 13:40:05 +00001133 psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001134
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +01001136}
Darryl Green940d72c2018-07-13 13:18:51 +01001137
Ronald Cron5c522922020-11-14 16:35:34 +01001138/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001139 *
1140 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +02001141 * available, as opposed to a key in a secure element and/or to be used
1142 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001143 *
Ronald Cronddae0f52021-08-24 15:39:44 +02001144 * This is a temporary function that may be used instead of
1145 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
1146 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001147 *
Ryan Everett098c6652024-01-03 13:03:36 +00001148 * On success, the returned key slot has been registered for reading.
Ryan Everett93cea572024-02-20 18:01:29 +00001149 * It is the responsibility of the caller to then unregister
1150 * once they have finished reading the contents of the slot.
1151 * The caller unregisters by calling psa_unregister_read() or
1152 * psa_unregister_read_under_mutex(). psa_unregister_read() must be called
1153 * if and only if the caller already holds the global key slot mutex
1154 * (when mutexes are enabled). psa_unregister_read_under_mutex() encapsulates
1155 * psa_unregister_read() with mutex lock and unlock operations.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001156 */
Ronald Cron5c522922020-11-14 16:35:34 +01001157static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1158 mbedtls_svc_key_id_t key,
1159 psa_key_slot_t **p_slot,
1160 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001161 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +02001162{
Gilles Peskine449bd832023-01-11 14:50:10 +01001163 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
1164 usage, alg);
1165 if (status != PSA_SUCCESS) {
1166 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001167 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001168
Gilles Peskine449bd832023-01-11 14:50:10 +01001169 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
Ryan Everettfb792ca2024-01-31 13:40:05 +00001170 psa_unregister_read_under_mutex(*p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 *p_slot = NULL;
1172 return PSA_ERROR_NOT_SUPPORTED;
1173 }
1174
1175 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001176}
Gilles Peskine28f8f302019-07-24 13:30:31 +02001177
Gilles Peskine449bd832023-01-11 14:50:10 +01001178psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +00001179{
Gilles Peskine449bd832023-01-11 14:50:10 +01001180 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +01001181 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001183
Ronald Cronea0f8a62020-11-25 17:52:23 +01001184 slot->key.data = NULL;
1185 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001186
Gilles Peskine449bd832023-01-11 14:50:10 +01001187 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001188}
1189
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001190/** Completely wipe a slot in memory, including its policy.
1191 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001192psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001193{
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001195
Gilles Peskine449bd832023-01-11 14:50:10 +01001196 /*
1197 * As the return error code may not be handled in case of multiple errors,
Ryan Everett7ed542e2024-01-17 11:39:09 +00001198 * do our best to report an unexpected amount of registered readers or
1199 * an unexpected state.
1200 * Assert with MBEDTLS_TEST_HOOK_TEST_ASSERT that the slot is valid for
1201 * wiping.
Gilles Peskine449bd832023-01-11 14:50:10 +01001202 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1203 * function is called as part of the execution of a test suite, the
1204 * execution of the test suite is stopped in error if the assertion fails.
1205 */
Ryan Everett7ed542e2024-01-17 11:39:09 +00001206 switch (slot->state) {
1207 case PSA_SLOT_FULL:
1208 /* In this state psa_wipe_key_slot() must only be called if the
1209 * caller is the last reader. */
1210 case PSA_SLOT_PENDING_DELETION:
1211 /* In this state psa_wipe_key_slot() must only be called if the
1212 * caller is the last reader. */
1213 if (slot->registered_readers != 1) {
1214 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 1);
1215 status = PSA_ERROR_CORRUPTION_DETECTED;
1216 }
1217 break;
1218 case PSA_SLOT_FILLING:
1219 /* In this state registered_readers must be 0. */
1220 if (slot->registered_readers != 0) {
1221 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 0);
1222 status = PSA_ERROR_CORRUPTION_DETECTED;
1223 }
1224 break;
1225 case PSA_SLOT_EMPTY:
1226 /* The slot is already empty, it cannot be wiped. */
1227 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->state != PSA_SLOT_EMPTY);
1228 status = PSA_ERROR_CORRUPTION_DETECTED;
1229 break;
1230 default:
1231 /* The slot's state is invalid. */
1232 status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronddd3d052020-10-30 14:07:07 +01001233 }
1234
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001235 /* Multipart operations may still be using the key. This is safe
1236 * because all multipart operation objects are independent from
1237 * the key slot: if they need to access the key after the setup
1238 * phase, they have a copy of the key. Note that this means that
1239 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001240 /* At this point, key material and other type-specific content has
1241 * been wiped. Clear remaining metadata. We can call memset and not
Ryan Everettaa33c512023-12-21 17:32:07 +00001242 * zeroize because the metadata is not particularly sensitive.
1243 * This memset also sets the slot's state to PSA_SLOT_EMPTY. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001244 memset(slot, 0, sizeof(*slot));
1245 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001246}
1247
Gilles Peskine449bd832023-01-11 14:50:10 +01001248psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001249{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001250 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001251 psa_status_t status; /* status of the last operation */
1252 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001253#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1254 psa_se_drv_table_entry_t *driver;
1255#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001256
Gilles Peskine449bd832023-01-11 14:50:10 +01001257 if (mbedtls_svc_key_id_is_null(key)) {
1258 return PSA_SUCCESS;
1259 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001260
Ronald Cronf2911112020-10-29 17:51:10 +01001261 /*
Ryan Everett7ed542e2024-01-17 11:39:09 +00001262 * Get the description of the key in a key slot, and register to read it.
1263 * In the case of a persistent key, this will load the key description
1264 * from persistent memory if not done yet.
1265 * We cannot avoid this loading as without it we don't know if
Ronald Cronf2911112020-10-29 17:51:10 +01001266 * the key is operated by an SE or not and this information is needed by
Ryan Everett7ed542e2024-01-17 11:39:09 +00001267 * the current implementation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001268 status = psa_get_and_lock_key_slot(key, &slot);
1269 if (status != PSA_SUCCESS) {
1270 return status;
1271 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001272
Ryan Everettc053d962024-01-25 17:56:32 +00001273#if defined(MBEDTLS_THREADING_C)
Ryan Everett763971f2024-01-29 17:13:36 +00001274 /* We cannot unlock between setting the state to PENDING_DELETION
1275 * and destroying the key in storage, as otherwise another thread
1276 * could load the key into a new slot and the key will not be
1277 * fully destroyed. */
Ryan Everettc053d962024-01-25 17:56:32 +00001278 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(
1279 &mbedtls_threading_key_slot_mutex));
Ryan Everettd868b742024-03-08 18:35:09 +00001280
1281 if (slot->state == PSA_SLOT_PENDING_DELETION) {
1282 /* Another thread has destroyed the key between us locking the slot
1283 * and us gaining the mutex. Unregister from the slot,
1284 * and report that the key does not exist. */
1285 status = psa_unregister_read(slot);
1286
1287 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1288 &mbedtls_threading_key_slot_mutex));
1289 return (status == PSA_SUCCESS) ? PSA_ERROR_INVALID_HANDLE : status;
1290 }
Ryan Everettc053d962024-01-25 17:56:32 +00001291#endif
Ryan Everett7ed542e2024-01-17 11:39:09 +00001292 /* Set the key slot containing the key description's state to
1293 * PENDING_DELETION. This stops new operations from registering
1294 * to read the slot. Current readers can safely continue to access
1295 * the key within the slot; the last registered reader will
1296 * automatically wipe the slot when they call psa_unregister_read().
1297 * If the key is persistent, we can now delete the copy of the key
1298 * from memory. If the key is opaque, we require the driver to
1299 * deal with the deletion. */
Ryan Everettd868b742024-03-08 18:35:09 +00001300 overall_status = psa_key_slot_state_transition(slot, PSA_SLOT_FULL,
1301 PSA_SLOT_PENDING_DELETION);
Ryan Everettc053d962024-01-25 17:56:32 +00001302
Ryan Everettd868b742024-03-08 18:35:09 +00001303 if (overall_status != PSA_SUCCESS) {
Ryan Everettc053d962024-01-25 17:56:32 +00001304 goto exit;
1305 }
Ronald Cronf2911112020-10-29 17:51:10 +01001306
Gilles Peskine449bd832023-01-11 14:50:10 +01001307 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001308 /* Refuse the destruction of a read-only key (which may or may not work
1309 * if we attempt it, depending on whether the key is merely read-only
1310 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001311 * Just do the best we can, which is to wipe the copy in memory
1312 * (done in this function's cleanup code). */
1313 overall_status = PSA_ERROR_NOT_PERMITTED;
1314 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001315 }
1316
Gilles Peskine354f7672019-07-12 23:46:38 +02001317#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001318 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1319 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001320 /* For a key in a secure element, we need to do three things:
1321 * remove the key file in internal storage, destroy the
1322 * key inside the secure element, and update the driver's
1323 * persistent data. Start a transaction that will encompass these
1324 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001325 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001326 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001327 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001328 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001329 status = psa_crypto_save_transaction();
1330 if (status != PSA_SUCCESS) {
1331 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001332 /* We should still try to destroy the key in the secure
1333 * element and the key metadata in storage. This is especially
1334 * important if the error is that the storage is full.
1335 * But how to do it exactly without risking an inconsistent
1336 * state after a reset?
1337 * https://github.com/ARMmbed/mbed-crypto/issues/215
1338 */
1339 overall_status = status;
1340 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001341 }
1342
Gilles Peskine449bd832023-01-11 14:50:10 +01001343 status = psa_destroy_se_key(driver,
1344 psa_key_slot_get_slot_number(slot));
1345 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001346 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001347 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001348 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001349#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1350
Darryl Greend49a4992018-06-18 17:27:26 +01001351#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ryan Everett4a0ba802024-01-17 14:12:33 +00001353 /* Destroy the copy of the persistent key from storage.
Ryan Everett7ed542e2024-01-17 11:39:09 +00001354 * The slot will still hold a copy of the key until the last reader
1355 * unregisters. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001356 status = psa_destroy_persistent_key(slot->attr.id);
1357 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001358 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001359 }
Darryl Greend49a4992018-06-18 17:27:26 +01001360 }
1361#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001362
Gilles Peskinefc762652019-07-22 19:30:34 +02001363#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 if (driver != NULL) {
1365 status = psa_save_se_persistent_data(driver);
1366 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001367 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001368 }
1369 status = psa_crypto_stop_transaction();
1370 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001371 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001372 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001373 }
1374#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1375
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001376exit:
Ryan Everett7ed542e2024-01-17 11:39:09 +00001377 /* Unregister from reading the slot. If we are the last active reader
1378 * then this will wipe the slot. */
1379 status = psa_unregister_read(slot);
1380 /* Prioritize CORRUPTION_DETECTED from unregistering over
1381 * a storage error. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001382 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001383 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001384 }
Ryan Everettc053d962024-01-25 17:56:32 +00001385
1386#if defined(MBEDTLS_THREADING_C)
Ryan Everett7fee4f72024-02-09 14:11:27 +00001387 /* Don't overwrite existing errors if the unlock fails. */
1388 status = overall_status;
Ryan Everettc053d962024-01-25 17:56:32 +00001389 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1390 &mbedtls_threading_key_slot_mutex));
1391#endif
1392
Gilles Peskine449bd832023-01-11 14:50:10 +01001393 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001394}
1395
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001396/** Retrieve all the publicly-accessible attributes of a key.
1397 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001398psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1399 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001400{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001401 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001402 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001403
Gilles Peskine449bd832023-01-11 14:50:10 +01001404 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001405
Gilles Peskine449bd832023-01-11 14:50:10 +01001406 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1407 if (status != PSA_SUCCESS) {
1408 return status;
1409 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001410
Gilles Peskine7fad3ef2024-02-28 01:08:27 +01001411 *attributes = slot->attr;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001412
1413#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001414 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1415 psa_set_key_slot_number(attributes,
1416 psa_key_slot_get_slot_number(slot));
1417 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001418#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001419
Gilles Peskine97c0b2f2024-02-16 00:49:46 +01001420 return psa_unregister_read_under_mutex(slot);
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001421}
1422
Gilles Peskinec8000c02019-08-02 20:15:51 +02001423#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1424psa_status_t psa_get_key_slot_number(
1425 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001426 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001427{
Gilles Peskine972539c2024-02-28 01:49:45 +01001428 if (attributes->has_slot_number) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001429 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001430 return PSA_SUCCESS;
1431 } else {
1432 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001433 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001434}
1435#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1436
Gilles Peskine449bd832023-01-11 14:50:10 +01001437static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1438 size_t key_buffer_size,
1439 uint8_t *data,
1440 size_t data_size,
1441 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001442{
Gilles Peskine449bd832023-01-11 14:50:10 +01001443 if (key_buffer_size > data_size) {
1444 return PSA_ERROR_BUFFER_TOO_SMALL;
1445 }
1446 memcpy(data, key_buffer, key_buffer_size);
1447 memset(data + key_buffer_size, 0,
1448 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001449 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001450 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001451}
1452
Ronald Cron7285cda2020-11-26 14:46:37 +01001453psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001454 const psa_key_attributes_t *attributes,
1455 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001456 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001457{
Gilles Peskine2f107ae2024-02-28 01:26:46 +01001458 psa_key_type_t type = attributes->type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001459
Gilles Peskine449bd832023-01-11 14:50:10 +01001460 if (key_type_is_raw_bytes(type) ||
1461 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001462 PSA_KEY_TYPE_IS_ECC(type) ||
1463 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001464 return psa_export_key_buffer_internal(
1465 key_buffer, key_buffer_size,
1466 data, data_size, data_length);
1467 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001468 /* This shouldn't happen in the reference implementation, but
1469 it is valid for a special-purpose implementation to omit
1470 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001471 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001472 }
1473}
1474
Gilles Peskine449bd832023-01-11 14:50:10 +01001475psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
Ryan Everett45ac5262024-01-08 17:15:19 +00001476 uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01001477 size_t data_size,
1478 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001479{
1480 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1481 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1482 psa_key_slot_t *slot;
Ryan Everett45ac5262024-01-08 17:15:19 +00001483 LOCAL_OUTPUT_DECLARE(data_external, data);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001484
Ronald Crone907e552021-01-18 13:22:38 +01001485 /* Reject a zero-length output buffer now, since this can never be a
1486 * valid key representation. This way we know that data must be a valid
1487 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001488 if (data_size == 0) {
1489 return PSA_ERROR_BUFFER_TOO_SMALL;
1490 }
Ronald Crone907e552021-01-18 13:22:38 +01001491
Ronald Cron9486f9d2020-11-26 13:36:23 +01001492 /* Set the key to empty now, so that even when there are errors, we always
1493 * set data_length to a value between 0 and data_size. On error, setting
1494 * the key to empty is a good choice because an empty key representation is
1495 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001496 *data_length = 0;
1497
Ronald Cron9486f9d2020-11-26 13:36:23 +01001498 /* Export requires the EXPORT flag. There is an exception for public keys,
1499 * which don't require any flag, but
1500 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1501 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001502 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1503 PSA_KEY_USAGE_EXPORT, 0);
1504 if (status != PSA_SUCCESS) {
1505 return status;
1506 }
mohammad160306e79202018-03-28 13:17:44 +03001507
Ryan Everett45ac5262024-01-08 17:15:19 +00001508 LOCAL_OUTPUT_ALLOC(data_external, data_size, data);
1509
Gilles Peskine7a5d9202024-02-28 01:18:23 +01001510 status = psa_driver_wrapper_export_key(&slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01001511 slot->key.data, slot->key.bytes,
1512 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001513
David Horstmann4a48bec2024-03-13 15:42:31 +00001514#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Ryan Everett45ac5262024-01-08 17:15:19 +00001515exit:
Ryan Everett35f68532024-01-25 12:02:03 +00001516#endif
Ryan Everetta103ec92024-01-31 13:59:57 +00001517 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001518
Ryan Everett45ac5262024-01-08 17:15:19 +00001519 LOCAL_OUTPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01001520 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001521}
1522
Ronald Cron7285cda2020-11-26 14:46:37 +01001523psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001524 const psa_key_attributes_t *attributes,
1525 const uint8_t *key_buffer,
1526 size_t key_buffer_size,
1527 uint8_t *data,
1528 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001530{
Gilles Peskine2f107ae2024-02-28 01:26:46 +01001531 psa_key_type_t type = attributes->type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001532
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001533 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001534 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1535 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001536 /* Exporting public -> public */
1537 return psa_export_key_buffer_internal(
1538 key_buffer, key_buffer_size,
1539 data, data_size, data_length);
1540 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001541#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001542 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1543 return mbedtls_psa_rsa_export_public_key(attributes,
1544 key_buffer,
1545 key_buffer_size,
1546 data,
1547 data_size,
1548 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001549#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001550 /* We don't know how to convert a private RSA key to public. */
1551 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001552#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001553 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001554 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001555#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001556 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1557 return mbedtls_psa_ecp_export_public_key(attributes,
1558 key_buffer,
1559 key_buffer_size,
1560 data,
1561 data_size,
1562 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001563#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001564 /* We don't know how to convert a private ECC key to public */
1565 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001566#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001567 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001568 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001569#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001570 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001571 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001572 key_buffer,
1573 key_buffer_size,
1574 data, data_size,
1575 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001576#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001577 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001578#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001579 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001580 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001581 (void) key_buffer;
1582 (void) key_buffer_size;
1583 (void) data;
1584 (void) data_size;
1585 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001586 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001587 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001588}
Ronald Crond18b5f82020-11-25 16:46:05 +01001589
Gilles Peskine449bd832023-01-11 14:50:10 +01001590psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
Ryan Everettb1d2c672024-01-08 17:19:30 +00001591 uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01001592 size_t data_size,
1593 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001594{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001595 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001596 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001597 psa_key_slot_t *slot;
Darryl Greendd8fb772018-11-07 16:00:44 +00001598
Ryan Everettb1d2c672024-01-08 17:19:30 +00001599 LOCAL_OUTPUT_DECLARE(data_external, data);
Darryl Greendd8fb772018-11-07 16:00:44 +00001600
Ronald Crone907e552021-01-18 13:22:38 +01001601 /* Reject a zero-length output buffer now, since this can never be a
1602 * valid key representation. This way we know that data must be a valid
1603 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001604 if (data_size == 0) {
1605 return PSA_ERROR_BUFFER_TOO_SMALL;
1606 }
Ronald Crone907e552021-01-18 13:22:38 +01001607
Darryl Greendd8fb772018-11-07 16:00:44 +00001608 /* Set the key to empty now, so that even when there are errors, we always
1609 * set data_length to a value between 0 and data_size. On error, setting
1610 * the key to empty is a good choice because an empty key representation is
1611 * unlikely to be accepted anywhere. */
1612 *data_length = 0;
1613
1614 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001615 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1616 if (status != PSA_SUCCESS) {
1617 return status;
1618 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001619
Ryan Everettb1d2c672024-01-08 17:19:30 +00001620 LOCAL_OUTPUT_ALLOC(data_external, data_size, data);
1621
Gilles Peskine449bd832023-01-11 14:50:10 +01001622 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1623 status = PSA_ERROR_INVALID_ARGUMENT;
1624 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001625 }
1626
Ronald Cron67227982020-11-26 15:16:05 +01001627 status = psa_driver_wrapper_export_public_key(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01001628 &slot->attr, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001629 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001630
1631exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00001632 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001633
Ryan Everettb1d2c672024-01-08 17:19:30 +00001634 LOCAL_OUTPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01001635 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001636}
1637
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001638/** Validate that a key policy is internally well-formed.
1639 *
1640 * This function only rejects invalid policies. It does not validate the
1641 * consistency of the policy with respect to other attributes of the key
1642 * such as the key type.
1643 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001644static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001645{
Gilles Peskine449bd832023-01-11 14:50:10 +01001646 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1647 PSA_KEY_USAGE_COPY |
1648 PSA_KEY_USAGE_ENCRYPT |
1649 PSA_KEY_USAGE_DECRYPT |
1650 PSA_KEY_USAGE_SIGN_MESSAGE |
1651 PSA_KEY_USAGE_VERIFY_MESSAGE |
1652 PSA_KEY_USAGE_SIGN_HASH |
1653 PSA_KEY_USAGE_VERIFY_HASH |
1654 PSA_KEY_USAGE_VERIFY_DERIVATION |
1655 PSA_KEY_USAGE_DERIVE)) != 0) {
1656 return PSA_ERROR_INVALID_ARGUMENT;
1657 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001658
Gilles Peskine449bd832023-01-11 14:50:10 +01001659 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001660}
1661
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001662/** Validate the internal consistency of key attributes.
1663 *
1664 * This function only rejects invalid attribute values. If does not
1665 * validate the consistency of the attributes with any key data that may
1666 * be involved in the creation of the key.
1667 *
1668 * Call this function early in the key creation process.
1669 *
1670 * \param[in] attributes Key attributes for the new key.
1671 * \param[out] p_drv On any return, the driver for the key, if any.
1672 * NULL for a transparent key.
1673 *
1674 */
1675static psa_status_t psa_validate_key_attributes(
1676 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001677 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001678{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001679 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001680 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1681 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001682
Gilles Peskine449bd832023-01-11 14:50:10 +01001683 status = psa_validate_key_location(lifetime, p_drv);
1684 if (status != PSA_SUCCESS) {
1685 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001686 }
1687
Gilles Peskine449bd832023-01-11 14:50:10 +01001688 status = psa_validate_key_persistence(lifetime);
1689 if (status != PSA_SUCCESS) {
1690 return status;
1691 }
1692
1693 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1694 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1695 return PSA_ERROR_INVALID_ARGUMENT;
1696 }
1697 } else {
1698 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1699 return PSA_ERROR_INVALID_ARGUMENT;
1700 }
1701 }
1702
Gilles Peskine2f107ae2024-02-28 01:26:46 +01001703 status = psa_validate_key_policy(&attributes->policy);
Gilles Peskine449bd832023-01-11 14:50:10 +01001704 if (status != PSA_SUCCESS) {
1705 return status;
1706 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001707
1708 /* Refuse to create overly large keys.
1709 * Note that this doesn't trigger on import if the attributes don't
1710 * explicitly specify a size (so psa_get_key_bits returns 0), so
1711 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001712 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1713 return PSA_ERROR_NOT_SUPPORTED;
1714 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001715
Gilles Peskine449bd832023-01-11 14:50:10 +01001716 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001717}
1718
Gilles Peskine4747d192019-04-17 15:05:45 +02001719/** Prepare a key slot to receive key material.
1720 *
1721 * This function allocates a key slot and sets its metadata.
1722 *
1723 * If this function fails, call psa_fail_key_creation().
1724 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001725 * This function is intended to be used as follows:
1726 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001727 * it with the specified attributes, and in case of a volatile key assign it
1728 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001729 * -# Populate the slot with the key material.
1730 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1731 * In case of failure at any step, stop the sequence and call
1732 * psa_fail_key_creation().
1733 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001734 * On success, the key slot's state is PSA_SLOT_FILLING.
1735 * It is the responsibility of the caller to change the slot's state to
1736 * PSA_SLOT_EMPTY/FULL once key creation has finished.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001737 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001738 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001739 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001740 * \param[out] p_slot On success, a pointer to the prepared slot.
1741 * \param[out] p_drv On any return, the driver for the key, if any.
1742 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001743 *
1744 * \retval #PSA_SUCCESS
1745 * The key slot is ready to receive key material.
1746 * \return If this function fails, the key slot is an invalid state.
1747 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001748 */
1749static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001750 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001751 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001752 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001753 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001754{
1755 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001756 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001757 psa_key_slot_t *slot;
1758
Gilles Peskinedf179142019-07-15 22:02:14 +02001759 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001760 *p_drv = NULL;
1761
Gilles Peskine449bd832023-01-11 14:50:10 +01001762 status = psa_validate_key_attributes(attributes, p_drv);
1763 if (status != PSA_SUCCESS) {
1764 return status;
1765 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001766
Ryan Everett3d8118d2024-01-30 16:58:47 +00001767#if defined(MBEDTLS_THREADING_C)
1768 PSA_THREADING_CHK_RET(mbedtls_mutex_lock(
1769 &mbedtls_threading_key_slot_mutex));
1770#endif
Ryan Everettb69118e2024-01-02 15:54:32 +00001771 status = psa_reserve_free_key_slot(&volatile_key_id, p_slot);
Ryan Everett3d8118d2024-01-30 16:58:47 +00001772#if defined(MBEDTLS_THREADING_C)
1773 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1774 &mbedtls_threading_key_slot_mutex));
1775#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001776 if (status != PSA_SUCCESS) {
1777 return status;
1778 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001779 slot = *p_slot;
1780
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001781 /* We're storing the declared bit-size of the key. It's up to each
1782 * creation mechanism to verify that this information is correct.
1783 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001784 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001785 * is optional (import, copy). In case of a volatile key, assign it the
1786 * volatile key identifier associated to the slot returned to contain its
1787 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001788
Gilles Peskine7fad3ef2024-02-28 01:08:27 +01001789 slot->attr = *attributes;
Gilles Peskine449bd832023-01-11 14:50:10 +01001790 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001791#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1792 slot->attr.id = volatile_key_id;
1793#else
1794 slot->attr.id.key_id = volatile_key_id;
1795#endif
1796 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001797
Gilles Peskinecbaff462019-07-12 23:46:04 +02001798#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001799 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001800 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001801 * create the key file in internal storage, create the
1802 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001803 * persistent data. This is done by starting a transaction that will
1804 * encompass these three actions.
1805 * For registering a volatile key, we just need to find an appropriate
1806 * slot number inside the SE. Since the key is designated volatile, creating
1807 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001808 /* The first thing to do is to find a slot number for the new key.
1809 * We save the slot number in persistent storage as part of the
1810 * transaction data. It will be needed to recover if the power
1811 * fails during the key creation process, to clean up on the secure
1812 * element side after restarting. Obtaining a slot number from the
1813 * secure element driver updates its persistent state, but we do not yet
1814 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001815 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001816 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001817 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1819 &slot_number);
1820 if (status != PSA_SUCCESS) {
1821 return status;
1822 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001823
Gilles Peskine2f107ae2024-02-28 01:26:46 +01001824 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->lifetime)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001825 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001826 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001827 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001828 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 status = psa_crypto_save_transaction();
1830 if (status != PSA_SUCCESS) {
1831 (void) psa_crypto_stop_transaction();
1832 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001833 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001834 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001835
1836 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001838 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001839
Gilles Peskine449bd832023-01-11 14:50:10 +01001840 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001841 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001842 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001843 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001844#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1845
Gilles Peskine449bd832023-01-11 14:50:10 +01001846 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001847}
Gilles Peskine4747d192019-04-17 15:05:45 +02001848
1849/** Finalize the creation of a key once its key material has been set.
1850 *
1851 * This entails writing the key to persistent storage.
1852 *
1853 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001854 * See the documentation of psa_start_key_creation() for the intended use
1855 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001856 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001857 * If the finalization succeeds, the function sets the key slot's state to
1858 * PSA_SLOT_FULL, and the key slot can no longer be accessed as part of the
1859 * key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001860 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001861 * \param[in,out] slot Pointer to the slot with key material.
1862 * \param[in] driver The secure element driver for the key,
1863 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001864 * \param[out] key On success, identifier of the key. Note that the
1865 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001866 *
1867 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001868 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001869 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1870 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1871 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1872 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1873 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1874 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001875 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001876 * \return If this function fails, the key slot is an invalid state.
1877 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001878 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001879static psa_status_t psa_finish_key_creation(
1880 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001881 psa_se_drv_table_entry_t *driver,
1882 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001883{
1884 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001885 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001886 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001887
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001888#if defined(MBEDTLS_THREADING_C)
1889 PSA_THREADING_CHK_RET(mbedtls_mutex_lock(
1890 &mbedtls_threading_key_slot_mutex));
1891#endif
1892
Gilles Peskine4747d192019-04-17 15:05:45 +02001893#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001894 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001895#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001896 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001897 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001898 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001899 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001900
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001901 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1902 sizeof(data.slot_number),
1903 "Slot number size does not match psa_se_key_data_storage_t");
1904
Gilles Peskine449bd832023-01-11 14:50:10 +01001905 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1906 status = psa_save_persistent_key(&slot->attr,
1907 (uint8_t *) &data,
1908 sizeof(data));
1909 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001910#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1911 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001912 /* Key material is saved in export representation in the slot, so
1913 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001914 status = psa_save_persistent_key(&slot->attr,
1915 slot->key.data,
1916 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001917 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001918 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001919#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1920
Gilles Peskinecbaff462019-07-12 23:46:04 +02001921#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001922 /* Finish the transaction for a key creation. This does not
1923 * happen when registering an existing key. Detect this case
1924 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001925 * creation of a persistent key in a secure element requires a transaction,
1926 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001927 if (driver != NULL &&
1928 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1929 status = psa_save_se_persistent_data(driver);
1930 if (status != PSA_SUCCESS) {
1931 psa_destroy_persistent_key(slot->attr.id);
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001932
1933#if defined(MBEDTLS_THREADING_C)
1934 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1935 &mbedtls_threading_key_slot_mutex));
1936#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001937 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001938 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001939 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001940 }
1941#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1942
Gilles Peskine449bd832023-01-11 14:50:10 +01001943 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001944 *key = slot->attr.id;
Ryan Everettb69118e2024-01-02 15:54:32 +00001945 status = psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1946 PSA_SLOT_FULL);
Gilles Peskine449bd832023-01-11 14:50:10 +01001947 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001948 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001950 }
Ronald Cron50972942020-11-14 11:28:25 +01001951
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001952#if defined(MBEDTLS_THREADING_C)
1953 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1954 &mbedtls_threading_key_slot_mutex));
1955#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001956 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001957}
1958
1959/** Abort the creation of a key.
1960 *
1961 * You may call this function after calling psa_start_key_creation(),
1962 * or after psa_finish_key_creation() fails. In other circumstances, this
1963 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001964 * See the documentation of psa_start_key_creation() for the intended use
Ryan Everettb69118e2024-01-02 15:54:32 +00001965 * of this function. Sets the slot's state to PSA_SLOT_EMPTY.
Gilles Peskine4747d192019-04-17 15:05:45 +02001966 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001967 * \param[in,out] slot Pointer to the slot with key material.
1968 * \param[in] driver The secure element driver for the key,
1969 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001970 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001971static void psa_fail_key_creation(psa_key_slot_t *slot,
1972 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001973{
Gilles Peskine011e4282019-06-26 18:34:38 +02001974 (void) driver;
1975
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001977 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001979
Ryan Everettb7101442024-01-23 20:09:49 +00001980#if defined(MBEDTLS_THREADING_C)
Ryan Everett73feaf22024-02-14 11:36:41 +00001981 /* If the lock operation fails we still wipe the slot.
1982 * Operations will no longer work after a failed lock,
1983 * but we still need to wipe the slot of confidential data. */
Ryan Everettb7101442024-01-23 20:09:49 +00001984 mbedtls_mutex_lock(&mbedtls_threading_key_slot_mutex);
1985#endif
1986
Gilles Peskine011e4282019-06-26 18:34:38 +02001987#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001988 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001989 * element, and the failure happened later (when saving metadata
1990 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001991 * element.
1992 * https://github.com/ARMmbed/mbed-crypto/issues/217
1993 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001994
Gilles Peskined7729582019-08-05 15:55:54 +02001995 /* Abort the ongoing transaction if any (there may not be one if
1996 * the creation process failed before starting one, or if the
1997 * key creation is a registration of a key in a secure element).
1998 * Earlier functions must already have done what it takes to undo any
1999 * partial creation. All that's left is to update the transaction data
2000 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002001 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02002002#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2003
Gilles Peskine449bd832023-01-11 14:50:10 +01002004 psa_wipe_key_slot(slot);
Ryan Everettb7101442024-01-23 20:09:49 +00002005
2006#if defined(MBEDTLS_THREADING_C)
2007 mbedtls_mutex_unlock(&mbedtls_threading_key_slot_mutex);
2008#endif
Gilles Peskine4747d192019-04-17 15:05:45 +02002009}
2010
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002011/** Validate optional attributes during key creation.
2012 *
2013 * Some key attributes are optional during key creation. If they are
2014 * specified in the attributes structure, check that they are consistent
2015 * with the data in the slot.
2016 *
2017 * This function should be called near the end of key creation, after
2018 * the slot in memory is fully populated but before saving persistent data.
2019 */
2020static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002021 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01002022 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002023{
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002024 if (attributes->type != 0) {
2025 if (attributes->type != slot->attr.type) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002026 return PSA_ERROR_INVALID_ARGUMENT;
2027 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002028 }
2029
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002030 if (attributes->bits != 0) {
2031 if (attributes->bits != slot->attr.bits) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002032 return PSA_ERROR_INVALID_ARGUMENT;
2033 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002034 }
2035
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002037}
2038
Gilles Peskine449bd832023-01-11 14:50:10 +01002039psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
Ryan Everettf028fe12024-01-08 17:14:44 +00002040 const uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002041 size_t data_length,
2042 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002043{
2044 psa_status_t status;
Ryan Everettf028fe12024-01-08 17:14:44 +00002045 LOCAL_INPUT_DECLARE(data_external, data);
Gilles Peskine4747d192019-04-17 15:05:45 +02002046 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002047 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002048 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302049 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002050
Ronald Cron81709fc2020-11-14 12:10:32 +01002051 *key = MBEDTLS_SVC_KEY_ID_INIT;
2052
Gilles Peskine0f84d622019-09-12 19:03:13 +02002053 /* Reject zero-length symmetric keys (including raw data key objects).
2054 * This also rejects any key which might be encoded as an empty string,
2055 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002056 if (data_length == 0) {
2057 return PSA_ERROR_INVALID_ARGUMENT;
2058 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002059
Archana449608b2021-09-08 15:36:05 +05302060 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002061 if (data_length > SIZE_MAX / 8) {
2062 return PSA_ERROR_NOT_SUPPORTED;
2063 }
Archana6ed4bda2021-08-04 10:47:15 +05302064
Ryan Everettf028fe12024-01-08 17:14:44 +00002065 LOCAL_INPUT_ALLOC(data_external, data_length, data);
2066
Gilles Peskine449bd832023-01-11 14:50:10 +01002067 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2068 &slot, &driver);
2069 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002070 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002071 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002072
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002073 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302074 * storage ( thus not in the case of importing a key in a secure element
2075 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2076 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002077 if (slot->key.data == NULL) {
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002078 if (psa_key_lifetime_is_external(attributes->lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302079 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002080 attributes, data, data_length, &storage_size);
2081 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302082 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 }
Archanad8a83dc2021-06-14 10:04:16 +05302084 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 status = psa_allocate_buffer_to_slot(slot, storage_size);
2086 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002087 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002088 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002089 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002090
2091 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002092 status = psa_driver_wrapper_import_key(attributes,
2093 data, data_length,
2094 slot->key.data,
2095 slot->key.bytes,
2096 &slot->key.bytes, &bits);
2097 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002098 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002100
Gilles Peskine449bd832023-01-11 14:50:10 +01002101 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002102 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002104 status = PSA_ERROR_INVALID_ARGUMENT;
2105 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002106 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002107
Archana6ed4bda2021-08-04 10:47:15 +05302108 /* Enforce a size limit, and in particular ensure that the bit
2109 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302111 status = PSA_ERROR_NOT_SUPPORTED;
2112 goto exit;
2113 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002114 status = psa_validate_optional_attributes(slot, attributes);
2115 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002116 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002118
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002120exit:
Ryan Everettf028fe12024-01-08 17:14:44 +00002121 LOCAL_INPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 if (status != PSA_SUCCESS) {
2123 psa_fail_key_creation(slot, driver);
2124 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002125
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002127}
2128
Gilles Peskined7729582019-08-05 15:55:54 +02002129#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2130psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002132{
2133 psa_status_t status;
2134 psa_key_slot_t *slot = NULL;
2135 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002136 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002137
2138 /* Leaving attributes unspecified is not currently supported.
2139 * It could make sense to query the key type and size from the
2140 * secure element, but not all secure elements support this
2141 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002142 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2143 return PSA_ERROR_NOT_SUPPORTED;
2144 }
2145 if (psa_get_key_bits(attributes) == 0) {
2146 return PSA_ERROR_NOT_SUPPORTED;
2147 }
Gilles Peskined7729582019-08-05 15:55:54 +02002148
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2150 &slot, &driver);
2151 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002152 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 }
Gilles Peskined7729582019-08-05 15:55:54 +02002154
Gilles Peskine449bd832023-01-11 14:50:10 +01002155 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002156
2157exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 if (status != PSA_SUCCESS) {
2159 psa_fail_key_creation(slot, driver);
2160 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002161
Gilles Peskined7729582019-08-05 15:55:54 +02002162 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 psa_close_key(key);
2164 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002165}
2166#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2167
Gilles Peskine449bd832023-01-11 14:50:10 +01002168psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2169 const psa_key_attributes_t *specified_attributes,
2170 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002171{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002172 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002173 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002174 psa_key_slot_t *source_slot = NULL;
2175 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002176 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002177 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302178 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002179
Ronald Cron81709fc2020-11-14 12:10:32 +01002180 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2181
Archana8a180362021-07-05 02:18:48 +05302182 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002183 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2184 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002185 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002186 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002187
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 status = psa_validate_optional_attributes(source_slot,
2189 specified_attributes);
2190 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002191 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002192 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002193
Archana9d17bf42021-09-10 06:22:44 +05302194 /* The target key type and number of bits have been validated by
2195 * psa_validate_optional_attributes() to be either equal to zero or
2196 * equal to the ones of the source key. So it is safe to inherit
2197 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302198 * */
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002199 actual_attributes.bits = source_slot->attr.bits;
2200 actual_attributes.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302201
2202
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 status = psa_restrict_key_policy(source_slot->attr.type,
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002204 &actual_attributes.policy,
Gilles Peskine449bd832023-01-11 14:50:10 +01002205 &source_slot->attr.policy);
2206 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002207 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002209
Gilles Peskine449bd832023-01-11 14:50:10 +01002210 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2211 &target_slot, &driver);
2212 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002213 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 }
2215 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2216 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302217 /*
Archana9d17bf42021-09-10 06:22:44 +05302218 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302219 * the source key would need to be exported as plaintext and re-imported
2220 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302221 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302222 * appropriate API invocations from the application, if needed.
2223 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002224 status = PSA_ERROR_NOT_SUPPORTED;
2225 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002226 }
Archana8a180362021-07-05 02:18:48 +05302227 /*
2228 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302229 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302230 * - For opaque keys this translates to an invocation of the drivers'
2231 * copy_key entry point through the dispatch layer.
2232 * */
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002233 if (psa_key_lifetime_is_external(actual_attributes.lifetime)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2235 &storage_size);
2236 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302237 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002238 }
Archana374fe5b2021-09-08 15:50:28 +05302239
Gilles Peskine449bd832023-01-11 14:50:10 +01002240 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2241 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302242 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 }
Archana374fe5b2021-09-08 15:50:28 +05302244
Gilles Peskine449bd832023-01-11 14:50:10 +01002245 status = psa_driver_wrapper_copy_key(&actual_attributes,
2246 source_slot->key.data,
2247 source_slot->key.bytes,
2248 target_slot->key.data,
2249 target_slot->key.bytes,
2250 &target_slot->key.bytes);
2251 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302252 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 }
2254 } else {
2255 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302256 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002257 source_slot->key.bytes);
2258 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302259 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002260 }
Archana8a180362021-07-05 02:18:48 +05302261 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002263exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002264 if (status != PSA_SUCCESS) {
2265 psa_fail_key_creation(target_slot, driver);
2266 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002267
Ryan Everetta103ec92024-01-31 13:59:57 +00002268 unlock_status = psa_unregister_read_under_mutex(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002269
Gilles Peskine449bd832023-01-11 14:50:10 +01002270 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002271}
2272
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002273
2274
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002275/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002276/* Message digests */
2277/****************************************************************/
2278
Gilles Peskine449bd832023-01-11 14:50:10 +01002279psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002280{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002281 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 if (operation->id == 0) {
2283 return PSA_SUCCESS;
2284 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002285
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002287 operation->id = 0;
2288
Gilles Peskine449bd832023-01-11 14:50:10 +01002289 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002290}
2291
Gilles Peskine449bd832023-01-11 14:50:10 +01002292psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2293 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002294{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002295 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002296
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002297 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002298 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002299 status = PSA_ERROR_BAD_STATE;
2300 goto exit;
2301 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002302
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002304 status = PSA_ERROR_INVALID_ARGUMENT;
2305 goto exit;
2306 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002307
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002308 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2309 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002311
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002313
2314exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 if (status != PSA_SUCCESS) {
2316 psa_hash_abort(operation);
2317 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002318
2319 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002320}
2321
Gilles Peskine449bd832023-01-11 14:50:10 +01002322psa_status_t psa_hash_update(psa_hash_operation_t *operation,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002323 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002324 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002325{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002326 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002327 LOCAL_INPUT_DECLARE(input_external, input);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002328
Gilles Peskine449bd832023-01-11 14:50:10 +01002329 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002330 status = PSA_ERROR_BAD_STATE;
2331 goto exit;
2332 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002333
Steven Cooremanc8288352021-03-04 14:02:19 +01002334 /* Don't require hash implementations to behave correctly on a
2335 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002336 if (input_length == 0) {
2337 return PSA_SUCCESS;
2338 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002339
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002340 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002341 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002342
2343exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 if (status != PSA_SUCCESS) {
2345 psa_hash_abort(operation);
2346 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002347
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002348 LOCAL_INPUT_FREE(input_external, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002350}
2351
Thomas Daubney31d8c0b2024-01-18 15:26:59 +00002352static psa_status_t psa_hash_finish_internal(psa_hash_operation_t *operation,
Thomas Daubneyd2411562024-01-25 17:25:07 +00002353 uint8_t *hash,
2354 size_t hash_size,
2355 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002356{
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002357 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2358
Steven Cooremanfbe09282021-03-08 18:41:12 +01002359 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 if (operation->id == 0) {
2361 return PSA_ERROR_BAD_STATE;
2362 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002363
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002364 status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 operation, hash, hash_size, hash_length);
2366 psa_hash_abort(operation);
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002367
2368 return status;
2369}
2370
2371psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2372 uint8_t *hash_external,
2373 size_t hash_size,
2374 size_t *hash_length)
2375{
2376 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2377 LOCAL_OUTPUT_DECLARE(hash_external, hash);
2378
2379 LOCAL_OUTPUT_ALLOC(hash_external, hash_size, hash);
2380 status = psa_hash_finish_internal(operation, hash, hash_size, hash_length);
2381
David Horstmann4a48bec2024-03-13 15:42:31 +00002382#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002383exit:
Thomas Daubneydedd1002024-01-25 16:52:50 +00002384#endif
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002385 LOCAL_OUTPUT_FREE(hash_external, hash);
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002387}
2388
Gilles Peskine449bd832023-01-11 14:50:10 +01002389psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002390 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002391 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002392{
Ronald Cron69a63422021-10-18 09:47:58 +02002393 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002394 size_t actual_hash_length;
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002395 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2396 LOCAL_INPUT_DECLARE(hash_external, hash);
2397
2398 status = psa_hash_finish_internal(
Gilles Peskine449bd832023-01-11 14:50:10 +01002399 operation,
2400 actual_hash, sizeof(actual_hash),
2401 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002402
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002404 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002406
Gilles Peskine449bd832023-01-11 14:50:10 +01002407 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002408 status = PSA_ERROR_INVALID_SIGNATURE;
2409 goto exit;
2410 }
2411
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002412 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
Dave Rodgman78701152023-08-29 14:20:18 +01002413 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002414 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002416
2417exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2419 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002420 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002421 }
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002422 LOCAL_INPUT_FREE(hash_external, hash);
Gilles Peskine449bd832023-01-11 14:50:10 +01002423 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002424}
2425
Gilles Peskine449bd832023-01-11 14:50:10 +01002426psa_status_t psa_hash_compute(psa_algorithm_t alg,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002427 const uint8_t *input_external, size_t input_length,
2428 uint8_t *hash_external, size_t hash_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002429 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002430{
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002431 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2432 LOCAL_INPUT_DECLARE(input_external, input);
2433 LOCAL_OUTPUT_DECLARE(hash_external, hash);
2434
Steven Cooremanfbe09282021-03-08 18:41:12 +01002435 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 if (!PSA_ALG_IS_HASH(alg)) {
2437 return PSA_ERROR_INVALID_ARGUMENT;
2438 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002439
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002440 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2441 LOCAL_OUTPUT_ALLOC(hash_external, hash_size, hash);
2442 status = psa_driver_wrapper_hash_compute(alg, input, input_length,
Thomas Daubneyd2411562024-01-25 17:25:07 +00002443 hash, hash_size, hash_length);
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002444
David Horstmann4a48bec2024-03-13 15:42:31 +00002445#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002446exit:
Thomas Daubneydedd1002024-01-25 16:52:50 +00002447#endif
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002448 LOCAL_INPUT_FREE(input_external, input);
2449 LOCAL_OUTPUT_FREE(hash_external, hash);
2450 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002451}
2452
Gilles Peskine449bd832023-01-11 14:50:10 +01002453psa_status_t psa_hash_compare(psa_algorithm_t alg,
Thomas Daubney51ffac92024-01-18 15:46:26 +00002454 const uint8_t *input_external, size_t input_length,
2455 const uint8_t *hash_external, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002456{
Ronald Cron69a63422021-10-18 09:47:58 +02002457 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002458 size_t actual_hash_length;
Thomas Daubney51ffac92024-01-18 15:46:26 +00002459 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2460
2461 LOCAL_INPUT_DECLARE(input_external, input);
2462 LOCAL_INPUT_DECLARE(hash_external, hash);
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002463
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 if (!PSA_ALG_IS_HASH(alg)) {
Thomas Daubney51ffac92024-01-18 15:46:26 +00002465 status = PSA_ERROR_INVALID_ARGUMENT;
2466 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002467 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002468
Thomas Daubney51ffac92024-01-18 15:46:26 +00002469 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2470 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002471 alg, input, input_length,
2472 actual_hash, sizeof(actual_hash),
2473 &actual_hash_length);
2474 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002475 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002476 }
2477 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002478 status = PSA_ERROR_INVALID_SIGNATURE;
2479 goto exit;
2480 }
Thomas Daubney51ffac92024-01-18 15:46:26 +00002481
2482 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
Dave Rodgman78701152023-08-29 14:20:18 +01002483 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002484 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002485 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002486
2487exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002488 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
Thomas Daubney51ffac92024-01-18 15:46:26 +00002489
2490 LOCAL_INPUT_FREE(input_external, input);
2491 LOCAL_INPUT_FREE(hash_external, hash);
2492
Gilles Peskine449bd832023-01-11 14:50:10 +01002493 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002494}
2495
Gilles Peskine449bd832023-01-11 14:50:10 +01002496psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2497 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002498{
Gilles Peskine449bd832023-01-11 14:50:10 +01002499 if (source_operation->id == 0 ||
2500 target_operation->id != 0) {
2501 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002502 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002503
Gilles Peskine449bd832023-01-11 14:50:10 +01002504 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2505 target_operation);
2506 if (status != PSA_SUCCESS) {
2507 psa_hash_abort(target_operation);
2508 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002509
Gilles Peskine449bd832023-01-11 14:50:10 +01002510 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002511}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002512
2513
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002514/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002515/* MAC */
2516/****************************************************************/
2517
Gilles Peskine449bd832023-01-11 14:50:10 +01002518psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002519{
Steven Cooremane6804192021-03-19 18:28:56 +01002520 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002521 if (operation->id == 0) {
2522 return PSA_SUCCESS;
2523 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002524
Gilles Peskine449bd832023-01-11 14:50:10 +01002525 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002526 operation->mac_size = 0;
2527 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002528 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002529
Gilles Peskine449bd832023-01-11 14:50:10 +01002530 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002531}
2532
Ronald Cron2dff3b22021-06-17 16:33:22 +02002533static psa_status_t psa_mac_finalize_alg_and_key_validation(
2534 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002535 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002536 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002537{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002538 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 psa_key_type_t key_type = psa_get_key_type(attributes);
2540 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002541
Gilles Peskine449bd832023-01-11 14:50:10 +01002542 if (!PSA_ALG_IS_MAC(alg)) {
2543 return PSA_ERROR_INVALID_ARGUMENT;
2544 }
Steven Cooremane6804192021-03-19 18:28:56 +01002545
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002546 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002547 status = psa_mac_key_can_do(alg, key_type);
2548 if (status != PSA_SUCCESS) {
2549 return status;
2550 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002551
Steven Cooremand1a68f12021-05-10 11:13:41 +02002552 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002554
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002556 /* A very short MAC is too short for security since it can be
2557 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2558 * so we make this our minimum, even though 32 bits is still
2559 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002561 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002562
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2564 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002565 /* It's impossible to "truncate" to a larger length than the full length
2566 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002568 }
2569
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002571 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2572 * that is disabled in the compile-time configuration. The result can
2573 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2574 * configuration into account. In this case, force a return of
2575 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2576 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2577 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2578 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2579 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002580 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002581 }
2582
Gilles Peskine449bd832023-01-11 14:50:10 +01002583 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002584}
2585
Gilles Peskine449bd832023-01-11 14:50:10 +01002586static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2587 mbedtls_svc_key_id_t key,
2588 psa_algorithm_t alg,
2589 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002590{
2591 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2592 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002593 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002594
2595 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002596 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002597 status = PSA_ERROR_BAD_STATE;
2598 goto exit;
2599 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002600
2601 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002602 key,
2603 &slot,
2604 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2605 alg);
2606 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002607 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002609
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002610 status = psa_mac_finalize_alg_and_key_validation(alg, &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002611 &operation->mac_size);
2612 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002613 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002614 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002615
2616 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002617 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002618 if (is_sign) {
2619 status = psa_driver_wrapper_mac_sign_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002620 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002621 slot->key.data,
2622 slot->key.bytes,
2623 alg);
2624 } else {
2625 status = psa_driver_wrapper_mac_verify_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002626 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002627 slot->key.data,
2628 slot->key.bytes,
2629 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002630 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002631
Gilles Peskinefbfac682018-07-08 20:51:54 +02002632exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002633 if (status != PSA_SUCCESS) {
2634 psa_mac_abort(operation);
2635 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002636
Ryan Everettfb9857f2024-02-14 12:16:41 +00002637 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002638
Gilles Peskine449bd832023-01-11 14:50:10 +01002639 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002640}
2641
Gilles Peskine449bd832023-01-11 14:50:10 +01002642psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2643 mbedtls_svc_key_id_t key,
2644 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002645{
Gilles Peskine449bd832023-01-11 14:50:10 +01002646 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002647}
2648
Gilles Peskine449bd832023-01-11 14:50:10 +01002649psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2650 mbedtls_svc_key_id_t key,
2651 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002652{
Gilles Peskine449bd832023-01-11 14:50:10 +01002653 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002654}
2655
Gilles Peskine449bd832023-01-11 14:50:10 +01002656psa_status_t psa_mac_update(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002657 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002659{
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002660 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2661 LOCAL_INPUT_DECLARE(input_external, input);
2662
Gilles Peskine449bd832023-01-11 14:50:10 +01002663 if (operation->id == 0) {
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002664 status = PSA_ERROR_BAD_STATE;
2665 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002666 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002667
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002668 /* Don't require hash implementations to behave correctly on a
2669 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 if (input_length == 0) {
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002671 status = PSA_SUCCESS;
2672 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002673 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002674
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002675 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2676 status = psa_driver_wrapper_mac_update(operation, input, input_length);
2677
Gilles Peskine449bd832023-01-11 14:50:10 +01002678 if (status != PSA_SUCCESS) {
2679 psa_mac_abort(operation);
2680 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002681
David Horstmann4a48bec2024-03-13 15:42:31 +00002682#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002683exit:
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002684#endif
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002685 LOCAL_INPUT_FREE(input_external, input);
2686
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002688}
2689
Gilles Peskine449bd832023-01-11 14:50:10 +01002690psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002691 uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002692 size_t mac_size,
2693 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002694{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002695 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2696 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002697 LOCAL_OUTPUT_DECLARE(mac_external, mac);
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002698 LOCAL_OUTPUT_ALLOC(mac_external, mac_size, mac);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002699
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002701 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002702 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002703 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002704
Gilles Peskine449bd832023-01-11 14:50:10 +01002705 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002706 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002707 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002708 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002709
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002710 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2711 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002713 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002714 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002715 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002716
Gilles Peskine449bd832023-01-11 14:50:10 +01002717 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002718 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002719 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002720 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002721
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002722
Gilles Peskine449bd832023-01-11 14:50:10 +01002723 status = psa_driver_wrapper_mac_sign_finish(operation,
2724 mac, operation->mac_size,
2725 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002726
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002727exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002728 /* In case of success, set the potential excess room in the output buffer
2729 * to an invalid value, to avoid potentially leaking a longer MAC.
2730 * In case of error, set the output length and content to a safe default,
2731 * such that in case the caller misses an error check, the output would be
2732 * an unachievable MAC.
2733 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002734 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002735 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002736 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002737 }
mohammad16036df908f2018-04-02 08:34:15 -07002738
Thomas Daubney03f1ea32024-02-01 16:16:27 +00002739 if (mac != NULL) {
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002740 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
2741 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002742
Gilles Peskine449bd832023-01-11 14:50:10 +01002743 abort_status = psa_mac_abort(operation);
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002744 LOCAL_OUTPUT_FREE(mac_external, mac);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002745
Gilles Peskine449bd832023-01-11 14:50:10 +01002746 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002747}
2748
Gilles Peskine449bd832023-01-11 14:50:10 +01002749psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002750 const uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002751 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002752{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002753 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2754 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002755 LOCAL_INPUT_DECLARE(mac_external, mac);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002756
Gilles Peskine449bd832023-01-11 14:50:10 +01002757 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002758 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002759 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002760 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002761
Gilles Peskine449bd832023-01-11 14:50:10 +01002762 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002763 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002764 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002765 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002766
Gilles Peskine449bd832023-01-11 14:50:10 +01002767 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002768 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002769 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002770 }
2771
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002772 LOCAL_INPUT_ALLOC(mac_external, mac_length, mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01002773 status = psa_driver_wrapper_mac_verify_finish(operation,
2774 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002775
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002776exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002777 abort_status = psa_mac_abort(operation);
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002778 LOCAL_INPUT_FREE(mac_external, mac);
mohammad16036df908f2018-04-02 08:34:15 -07002779
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002781}
2782
Gilles Peskine449bd832023-01-11 14:50:10 +01002783static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2784 psa_algorithm_t alg,
2785 const uint8_t *input,
2786 size_t input_length,
2787 uint8_t *mac,
2788 size_t mac_size,
2789 size_t *mac_length,
2790 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002791{
2792 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002793 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2794 psa_key_slot_t *slot;
2795 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002796
Ronald Cron51131b52021-06-17 17:17:20 +02002797 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002798 key,
2799 &slot,
2800 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2801 alg);
2802 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002803 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002804 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002805
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002806 status = psa_mac_finalize_alg_and_key_validation(alg, &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 &operation_mac_size);
2808 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002809 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002810 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002811
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002813 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002814 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002815 }
2816
2817 status = psa_driver_wrapper_mac_compute(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002818 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002819 slot->key.data, slot->key.bytes,
2820 alg,
2821 input, input_length,
2822 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002823
2824exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002825 /* In case of success, set the potential excess room in the output buffer
2826 * to an invalid value, to avoid potentially leaking a longer MAC.
2827 * In case of error, set the output length and content to a safe default,
2828 * such that in case the caller misses an error check, the output would be
2829 * an unachievable MAC.
2830 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002831 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002832 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002833 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002834 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002835
2836 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002837
Ryan Everetta103ec92024-01-31 13:59:57 +00002838 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002839
Gilles Peskine449bd832023-01-11 14:50:10 +01002840 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002841}
2842
Gilles Peskine449bd832023-01-11 14:50:10 +01002843psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002844 psa_algorithm_t alg,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002845 const uint8_t *input_external,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002846 size_t input_length,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002847 uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002848 size_t mac_size,
2849 size_t *mac_length)
2850{
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002851 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2852 LOCAL_INPUT_DECLARE(input_external, input);
2853 LOCAL_OUTPUT_DECLARE(mac_external, mac);
2854
2855 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2856 LOCAL_OUTPUT_ALLOC(mac_external, mac_size, mac);
2857 status = psa_mac_compute_internal(key, alg,
Thomas Daubney7480a742024-01-30 11:29:47 +00002858 input, input_length,
2859 mac, mac_size, mac_length, 1);
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002860
David Horstmann4a48bec2024-03-13 15:42:31 +00002861#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002862exit:
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002863#endif
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002864 LOCAL_INPUT_FREE(input_external, input);
2865 LOCAL_OUTPUT_FREE(mac_external, mac);
2866
2867 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002868}
2869
2870psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2871 psa_algorithm_t alg,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002872 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002873 size_t input_length,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002874 const uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002875 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002876{
2877 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002878 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2879 size_t actual_mac_length;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002880 LOCAL_INPUT_DECLARE(input_external, input);
2881 LOCAL_INPUT_DECLARE(mac_external, mac);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002882
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002883 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002884 status = psa_mac_compute_internal(key, alg,
2885 input, input_length,
2886 actual_mac, sizeof(actual_mac),
2887 &actual_mac_length, 0);
2888 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002889 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002890 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002891
Gilles Peskine449bd832023-01-11 14:50:10 +01002892 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002893 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002894 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002895 }
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002896
2897 LOCAL_INPUT_ALLOC(mac_external, mac_length, mac);
Dave Rodgman78701152023-08-29 14:20:18 +01002898 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002899 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002900 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002901 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002902
2903exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002905 LOCAL_INPUT_FREE(input_external, input);
2906 LOCAL_INPUT_FREE(mac_external, mac);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002907
Gilles Peskine449bd832023-01-11 14:50:10 +01002908 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002909}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002910
Gilles Peskinee59236f2018-01-27 23:32:46 +01002911/****************************************************************/
2912/* Asymmetric cryptography */
2913/****************************************************************/
2914
Gilles Peskine449bd832023-01-11 14:50:10 +01002915static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2916 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002917{
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 if (input_is_message) {
2919 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2920 return PSA_ERROR_INVALID_ARGUMENT;
2921 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002922
Gilles Peskine449bd832023-01-11 14:50:10 +01002923 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2924 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2925 return PSA_ERROR_INVALID_ARGUMENT;
2926 }
2927 }
2928 } else {
2929 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2930 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002931 }
2932 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002933
Gilles Peskine449bd832023-01-11 14:50:10 +01002934 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002935}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002936
Gilles Peskine449bd832023-01-11 14:50:10 +01002937static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2938 int input_is_message,
2939 psa_algorithm_t alg,
2940 const uint8_t *input,
2941 size_t input_length,
2942 uint8_t *signature,
2943 size_t signature_size,
2944 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002945{
2946 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2947 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2948 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002949
2950 *signature_length = 0;
2951
Gilles Peskine449bd832023-01-11 14:50:10 +01002952 status = psa_sign_verify_check_alg(input_is_message, alg);
2953 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002954 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002955 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002956
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002957 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002958 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002959 * buffer can in principle be empty since it doesn't actually have
2960 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002961 if (signature_size == 0) {
2962 return PSA_ERROR_BUFFER_TOO_SMALL;
2963 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002964
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002965 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002966 key, &slot,
2967 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2968 PSA_KEY_USAGE_SIGN_HASH,
2969 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002970
Gilles Peskine449bd832023-01-11 14:50:10 +01002971 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002972 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002973 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002974
Gilles Peskine449bd832023-01-11 14:50:10 +01002975 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002976 status = PSA_ERROR_INVALID_ARGUMENT;
2977 goto exit;
2978 }
2979
Gilles Peskine449bd832023-01-11 14:50:10 +01002980 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002981 status = psa_driver_wrapper_sign_message(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002982 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002983 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002984 signature, signature_size, signature_length);
2985 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002986
2987 status = psa_driver_wrapper_sign_hash(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002988 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002989 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002990 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002991 }
2992
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002993
2994exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002995 psa_wipe_tag_output_buffer(signature, status, signature_size,
2996 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002997
Ryan Everetta103ec92024-01-31 13:59:57 +00002998 unlock_status = psa_unregister_read_under_mutex(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002999
Gilles Peskine449bd832023-01-11 14:50:10 +01003000 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003001}
3002
Gilles Peskine449bd832023-01-11 14:50:10 +01003003static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
3004 int input_is_message,
3005 psa_algorithm_t alg,
3006 const uint8_t *input,
3007 size_t input_length,
3008 const uint8_t *signature,
3009 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003010{
3011 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3012 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3013 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003014
Gilles Peskine449bd832023-01-11 14:50:10 +01003015 status = psa_sign_verify_check_alg(input_is_message, alg);
3016 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003017 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003018 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003019
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003020 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 key, &slot,
3022 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
3023 PSA_KEY_USAGE_VERIFY_HASH,
3024 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003025
Gilles Peskine449bd832023-01-11 14:50:10 +01003026 if (status != PSA_SUCCESS) {
3027 return status;
3028 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003029
Gilles Peskine449bd832023-01-11 14:50:10 +01003030 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003031 status = psa_driver_wrapper_verify_message(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003032 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003033 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003034 signature, signature_length);
3035 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003036 status = psa_driver_wrapper_verify_hash(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003037 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003038 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003039 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003040 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003041
Ryan Everetta103ec92024-01-31 13:59:57 +00003042 unlock_status = psa_unregister_read_under_mutex(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003043
Gilles Peskine449bd832023-01-11 14:50:10 +01003044 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003045
3046}
3047
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003048psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003049 const psa_key_attributes_t *attributes,
3050 const uint8_t *key_buffer,
3051 size_t key_buffer_size,
3052 psa_algorithm_t alg,
3053 const uint8_t *input,
3054 size_t input_length,
3055 uint8_t *signature,
3056 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01003057 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003058{
3059 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003060
Gilles Peskine449bd832023-01-11 14:50:10 +01003061 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003062 size_t hash_length;
3063 uint8_t hash[PSA_HASH_MAX_SIZE];
3064
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003065 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003066 PSA_ALG_SIGN_GET_HASH(alg),
3067 input, input_length,
3068 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003069
Gilles Peskine449bd832023-01-11 14:50:10 +01003070 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003071 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003072 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003073
3074 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003075 attributes, key_buffer, key_buffer_size,
3076 alg, hash, hash_length,
3077 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003078 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003079
Gilles Peskine449bd832023-01-11 14:50:10 +01003080 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003081}
3082
Gilles Peskine449bd832023-01-11 14:50:10 +01003083psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3084 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003085 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003086 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003087 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003088 size_t signature_size,
3089 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003090{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003091 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3092 LOCAL_INPUT_DECLARE(input_external, input);
3093 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3094
3095 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3096 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3097 status = psa_sign_internal(key, 1, alg, input, input_length, signature,
3098 signature_size, signature_length);
3099
David Horstmann4a48bec2024-03-13 15:42:31 +00003100#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003101exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003102#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003103 LOCAL_INPUT_FREE(input_external, input);
3104 LOCAL_OUTPUT_FREE(signature_external, signature);
3105 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003106}
3107
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003108psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003109 const psa_key_attributes_t *attributes,
3110 const uint8_t *key_buffer,
3111 size_t key_buffer_size,
3112 psa_algorithm_t alg,
3113 const uint8_t *input,
3114 size_t input_length,
3115 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003116 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003117{
3118 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003119
Gilles Peskine449bd832023-01-11 14:50:10 +01003120 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003121 size_t hash_length;
3122 uint8_t hash[PSA_HASH_MAX_SIZE];
3123
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003124 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003125 PSA_ALG_SIGN_GET_HASH(alg),
3126 input, input_length,
3127 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003128
Gilles Peskine449bd832023-01-11 14:50:10 +01003129 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003130 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003131 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003132
3133 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003134 attributes, key_buffer, key_buffer_size,
3135 alg, hash, hash_length,
3136 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003137 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003138
Gilles Peskine449bd832023-01-11 14:50:10 +01003139 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003140}
3141
Gilles Peskine449bd832023-01-11 14:50:10 +01003142psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3143 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003144 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003145 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003146 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003147 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003148{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003149 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3150 LOCAL_INPUT_DECLARE(input_external, input);
3151 LOCAL_INPUT_DECLARE(signature_external, signature);
3152
3153 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3154 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3155 status = psa_verify_internal(key, 1, alg, input, input_length, signature,
3156 signature_length);
3157
David Horstmann4a48bec2024-03-13 15:42:31 +00003158#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003159exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003160#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003161 LOCAL_INPUT_FREE(input_external, input);
3162 LOCAL_INPUT_FREE(signature_external, signature);
3163
3164 return status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003165}
3166
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003167psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003168 const psa_key_attributes_t *attributes,
3169 const uint8_t *key_buffer, size_t key_buffer_size,
3170 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003171 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003172{
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003173 if (attributes->type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003174 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3175 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003176#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003177 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3178 return mbedtls_psa_rsa_sign_hash(
3179 attributes,
3180 key_buffer, key_buffer_size,
3181 alg, hash, hash_length,
3182 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003183#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3184 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003185 } else {
3186 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003187 }
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003188 } else if (PSA_KEY_TYPE_IS_ECC(attributes->type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003189 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003190#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003191 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3192 return mbedtls_psa_ecdsa_sign_hash(
3193 attributes,
3194 key_buffer, key_buffer_size,
3195 alg, hash, hash_length,
3196 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003197#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3198 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003199 } else {
3200 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003201 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003202 }
Ronald Cron4501c982021-03-19 20:09:32 +01003203
Gilles Peskine449bd832023-01-11 14:50:10 +01003204 (void) key_buffer;
3205 (void) key_buffer_size;
3206 (void) hash;
3207 (void) hash_length;
3208 (void) signature;
3209 (void) signature_size;
3210 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003211
Gilles Peskine449bd832023-01-11 14:50:10 +01003212 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003213}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003214
Gilles Peskine449bd832023-01-11 14:50:10 +01003215psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3216 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003217 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003218 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003219 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003220 size_t signature_size,
3221 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003222{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003223 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3224 LOCAL_INPUT_DECLARE(hash_external, hash);
3225 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3226
3227 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3228 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3229 status = psa_sign_internal(key, 0, alg, hash, hash_length, signature,
3230 signature_size, signature_length);
3231
David Horstmann4a48bec2024-03-13 15:42:31 +00003232#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003233exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003234#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003235 LOCAL_INPUT_FREE(hash_external, hash);
3236 LOCAL_OUTPUT_FREE(signature_external, signature);
3237
3238 return status;
itayzafrir5c753392018-05-08 11:18:38 +03003239}
3240
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003241psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003242 const psa_key_attributes_t *attributes,
3243 const uint8_t *key_buffer, size_t key_buffer_size,
3244 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003245 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003246{
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003247 if (PSA_KEY_TYPE_IS_RSA(attributes->type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003248 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3249 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003250#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003251 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3252 return mbedtls_psa_rsa_verify_hash(
3253 attributes,
3254 key_buffer, key_buffer_size,
3255 alg, hash, hash_length,
3256 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003257#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3258 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003259 } else {
3260 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003261 }
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003262 } else if (PSA_KEY_TYPE_IS_ECC(attributes->type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003263 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003264#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003265 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3266 return mbedtls_psa_ecdsa_verify_hash(
3267 attributes,
3268 key_buffer, key_buffer_size,
3269 alg, hash, hash_length,
3270 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003271#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3272 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003273 } else {
3274 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003275 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003276 }
Ronald Cron4501c982021-03-19 20:09:32 +01003277
Gilles Peskine449bd832023-01-11 14:50:10 +01003278 (void) key_buffer;
3279 (void) key_buffer_size;
3280 (void) hash;
3281 (void) hash_length;
3282 (void) signature;
3283 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003284
Gilles Peskine449bd832023-01-11 14:50:10 +01003285 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003286}
3287
Gilles Peskine449bd832023-01-11 14:50:10 +01003288psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3289 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003290 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003291 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003292 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003293 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003294{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003295 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3296 LOCAL_INPUT_DECLARE(hash_external, hash);
3297 LOCAL_INPUT_DECLARE(signature_external, signature);
3298
3299 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3300 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3301 status = psa_verify_internal(key, 0, alg, hash, hash_length, signature,
3302 signature_length);
3303
David Horstmann4a48bec2024-03-13 15:42:31 +00003304#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003305exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003306#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003307 LOCAL_INPUT_FREE(hash_external, hash);
3308 LOCAL_INPUT_FREE(signature_external, signature);
3309
3310 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01003311}
3312
Gilles Peskine449bd832023-01-11 14:50:10 +01003313psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3314 psa_algorithm_t alg,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003315 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003316 size_t input_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003317 const uint8_t *salt_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003318 size_t salt_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003319 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003320 size_t output_size,
3321 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003322{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003323 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003324 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003325 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003326
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003327 LOCAL_INPUT_DECLARE(input_external, input);
3328 LOCAL_INPUT_DECLARE(salt_external, salt);
3329 LOCAL_OUTPUT_DECLARE(output_external, output);
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003330
Darryl Green5cc689a2018-07-24 15:34:10 +01003331 (void) input;
3332 (void) input_length;
3333 (void) salt;
3334 (void) output;
3335 (void) output_size;
3336
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003337 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003338
Gilles Peskine449bd832023-01-11 14:50:10 +01003339 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3340 return PSA_ERROR_INVALID_ARGUMENT;
3341 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003342
Valerio Setti5bb454a2024-01-15 10:43:16 +01003343 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003344 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3345 if (status != PSA_SUCCESS) {
3346 return status;
3347 }
3348 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3349 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003350 status = PSA_ERROR_INVALID_ARGUMENT;
3351 goto exit;
3352 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003353
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003354 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3355 LOCAL_INPUT_ALLOC(salt_external, salt_length, salt);
3356 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmann93fa4e12024-03-12 15:02:28 +00003357
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003358 status = psa_driver_wrapper_asymmetric_encrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003359 &slot->attr, slot->key.data, slot->key.bytes,
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003360 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003361 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003362exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00003363 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003364
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003365 LOCAL_INPUT_FREE(input_external, input);
3366 LOCAL_INPUT_FREE(salt_external, salt);
3367 LOCAL_OUTPUT_FREE(output_external, output);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003368
Gilles Peskine449bd832023-01-11 14:50:10 +01003369 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003370}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003371
Gilles Peskine449bd832023-01-11 14:50:10 +01003372psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3373 psa_algorithm_t alg,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003374 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003375 size_t input_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003376 const uint8_t *salt_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003377 size_t salt_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003378 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003379 size_t output_size,
3380 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003381{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003382 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003383 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003384 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003385
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003386 LOCAL_INPUT_DECLARE(input_external, input);
3387 LOCAL_INPUT_DECLARE(salt_external, salt);
3388 LOCAL_OUTPUT_DECLARE(output_external, output);
3389
Darryl Green5cc689a2018-07-24 15:34:10 +01003390 (void) input;
3391 (void) input_length;
3392 (void) salt;
3393 (void) output;
3394 (void) output_size;
3395
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003396 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003397
Gilles Peskine449bd832023-01-11 14:50:10 +01003398 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3399 return PSA_ERROR_INVALID_ARGUMENT;
3400 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003401
Valerio Setti5bb454a2024-01-15 10:43:16 +01003402 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003403 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3404 if (status != PSA_SUCCESS) {
3405 return status;
3406 }
3407 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003408 status = PSA_ERROR_INVALID_ARGUMENT;
3409 goto exit;
3410 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003411
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003412 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3413 LOCAL_INPUT_ALLOC(salt_external, salt_length, salt);
3414 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmann93fa4e12024-03-12 15:02:28 +00003415
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003416 status = psa_driver_wrapper_asymmetric_decrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003417 &slot->attr, slot->key.data, slot->key.bytes,
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003418 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003419 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003420
3421exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00003422 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003423
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003424 LOCAL_INPUT_FREE(input_external, input);
3425 LOCAL_INPUT_FREE(salt_external, salt);
3426 LOCAL_OUTPUT_FREE(output_external, output);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003427
Gilles Peskine449bd832023-01-11 14:50:10 +01003428 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003429}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003430
Paul Elliott9fe12f62022-11-30 19:16:02 +00003431/****************************************************************/
3432/* Asymmetric interruptible cryptography */
3433/****************************************************************/
3434
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003435static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3436
Paul Elliott9fe12f62022-11-30 19:16:02 +00003437void psa_interruptible_set_max_ops(uint32_t max_ops)
3438{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003439 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003440}
3441
3442uint32_t psa_interruptible_get_max_ops(void)
3443{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003444 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003445}
3446
Paul Elliott9fe12f62022-11-30 19:16:02 +00003447uint32_t psa_sign_hash_get_num_ops(
3448 const psa_sign_hash_interruptible_operation_t *operation)
3449{
Paul Elliott296ede92022-12-15 17:00:30 +00003450 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003451}
3452
3453uint32_t psa_verify_hash_get_num_ops(
3454 const psa_verify_hash_interruptible_operation_t *operation)
3455{
Paul Elliott296ede92022-12-15 17:00:30 +00003456 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003457}
3458
Paul Elliott59ad9452022-12-18 15:09:02 +00003459static psa_status_t psa_sign_hash_abort_internal(
3460 psa_sign_hash_interruptible_operation_t *operation)
3461{
3462 if (operation->id == 0) {
3463 /* The object has (apparently) been initialized but it is not (yet)
3464 * in use. It's ok to call abort on such an object, and there's
3465 * nothing to do. */
3466 return PSA_SUCCESS;
3467 }
3468
3469 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3470
3471 status = psa_driver_wrapper_sign_hash_abort(operation);
3472
3473 operation->id = 0;
3474
Paul Elliotte6145dc2023-02-07 12:51:21 +00003475 /* Do not clear either the error_occurred or num_ops elements here as they
3476 * only want to be cleared by the application calling abort, not by abort
3477 * being called at completion of an operation. */
3478
Paul Elliott59ad9452022-12-18 15:09:02 +00003479 return status;
3480}
3481
Paul Elliott9fe12f62022-11-30 19:16:02 +00003482psa_status_t psa_sign_hash_start(
3483 psa_sign_hash_interruptible_operation_t *operation,
3484 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
David Horstmann4a523a62024-03-11 13:32:16 +00003485 const uint8_t *hash_external, size_t hash_length)
Paul Elliott9fe12f62022-11-30 19:16:02 +00003486{
3487 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3488 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3489 psa_key_slot_t *slot;
3490
David Horstmann4a523a62024-03-11 13:32:16 +00003491 LOCAL_INPUT_DECLARE(hash_external, hash);
3492
Paul Elliottc9774412023-02-06 15:14:07 +00003493 /* Check that start has not been previously called, or operation has not
3494 * previously errored. */
3495 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003496 return PSA_ERROR_BAD_STATE;
3497 }
3498
Paul Elliott9fe12f62022-11-30 19:16:02 +00003499 status = psa_sign_verify_check_alg(0, alg);
3500 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003501 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003502 return status;
3503 }
3504
3505 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3506 PSA_KEY_USAGE_SIGN_HASH,
3507 alg);
3508
3509 if (status != PSA_SUCCESS) {
3510 goto exit;
3511 }
3512
3513 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3514 status = PSA_ERROR_INVALID_ARGUMENT;
3515 goto exit;
3516 }
3517
David Horstmann4a523a62024-03-11 13:32:16 +00003518 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3519
Paul Elliott296ede92022-12-15 17:00:30 +00003520 /* Ensure ops count gets reset, in case of operation re-use. */
3521 operation->num_ops = 0;
3522
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003523 status = psa_driver_wrapper_sign_hash_start(operation, &slot->attr,
Paul Elliott9fe12f62022-11-30 19:16:02 +00003524 slot->key.data,
3525 slot->key.bytes, alg,
3526 hash, hash_length);
3527exit:
3528
3529 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003530 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003531 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003532 }
3533
Ryan Everettdcc03d52024-02-14 15:44:13 +00003534 unlock_status = psa_unregister_read_under_mutex(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003535
Paul Elliottc9774412023-02-06 15:14:07 +00003536 if (unlock_status != PSA_SUCCESS) {
3537 operation->error_occurred = 1;
3538 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003539
David Horstmann4a523a62024-03-11 13:32:16 +00003540 LOCAL_INPUT_FREE(hash_external, hash);
3541
Paul Elliottc9774412023-02-06 15:14:07 +00003542 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003543}
3544
3545
3546psa_status_t psa_sign_hash_complete(
3547 psa_sign_hash_interruptible_operation_t *operation,
David Horstmann4a523a62024-03-11 13:32:16 +00003548 uint8_t *signature_external, size_t signature_size,
Paul Elliott9fe12f62022-11-30 19:16:02 +00003549 size_t *signature_length)
3550{
3551 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3552
David Horstmann4a523a62024-03-11 13:32:16 +00003553 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3554
Paul Elliott9fe12f62022-11-30 19:16:02 +00003555 *signature_length = 0;
3556
Paul Elliottc9774412023-02-06 15:14:07 +00003557 /* Check that start has been called first, and that operation has not
3558 * previously errored. */
3559 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003560 status = PSA_ERROR_BAD_STATE;
3561 goto exit;
3562 }
3563
Paul Elliott096abc42023-02-03 18:33:23 +00003564 /* Immediately reject a zero-length signature buffer. This guarantees that
3565 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003566 if (signature_size == 0) {
3567 status = PSA_ERROR_BUFFER_TOO_SMALL;
3568 goto exit;
3569 }
3570
David Horstmann4a523a62024-03-11 13:32:16 +00003571 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3572
Paul Elliott9fe12f62022-11-30 19:16:02 +00003573 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3574 signature_size,
3575 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003576
Paul Elliott296ede92022-12-15 17:00:30 +00003577 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003578 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003579
Paul Elliottebe225c2023-02-10 14:32:53 +00003580exit:
3581
David Horstmannc5064c82024-03-11 17:02:03 +00003582 if (signature != NULL) {
3583 psa_wipe_tag_output_buffer(signature, status, signature_size,
3584 *signature_length);
3585 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003586
Paul Elliott53bb3122023-02-10 14:22:22 +00003587 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003588 if (status != PSA_SUCCESS) {
3589 operation->error_occurred = 1;
3590 }
3591
Paul Elliott59ad9452022-12-18 15:09:02 +00003592 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003593 }
3594
David Horstmann4a523a62024-03-11 13:32:16 +00003595 LOCAL_OUTPUT_FREE(signature_external, signature);
3596
Paul Elliott9fe12f62022-11-30 19:16:02 +00003597 return status;
3598}
3599
3600psa_status_t psa_sign_hash_abort(
3601 psa_sign_hash_interruptible_operation_t *operation)
3602{
Paul Elliott59ad9452022-12-18 15:09:02 +00003603 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3604
3605 status = psa_sign_hash_abort_internal(operation);
3606
3607 /* We clear the number of ops done here, so that it is not cleared when
3608 * the operation fails or succeeds, only on manual abort. */
3609 operation->num_ops = 0;
3610
Paul Elliottc9774412023-02-06 15:14:07 +00003611 /* Likewise, failure state. */
3612 operation->error_occurred = 0;
3613
Paul Elliott59ad9452022-12-18 15:09:02 +00003614 return status;
3615}
3616
3617static psa_status_t psa_verify_hash_abort_internal(
3618 psa_verify_hash_interruptible_operation_t *operation)
3619{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003620 if (operation->id == 0) {
3621 /* The object has (apparently) been initialized but it is not (yet)
3622 * in use. It's ok to call abort on such an object, and there's
3623 * nothing to do. */
3624 return PSA_SUCCESS;
3625 }
3626
Paul Elliott59ad9452022-12-18 15:09:02 +00003627 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3628
3629 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003630
3631 operation->id = 0;
3632
Paul Elliotte6145dc2023-02-07 12:51:21 +00003633 /* Do not clear either the error_occurred or num_ops elements here as they
3634 * only want to be cleared by the application calling abort, not by abort
3635 * being called at completion of an operation. */
3636
Paul Elliott59ad9452022-12-18 15:09:02 +00003637 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003638}
3639
3640psa_status_t psa_verify_hash_start(
3641 psa_verify_hash_interruptible_operation_t *operation,
3642 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
David Horstmann0fea6a52024-03-11 13:41:05 +00003643 const uint8_t *hash_external, size_t hash_length,
3644 const uint8_t *signature_external, size_t signature_length)
Paul Elliott9fe12f62022-11-30 19:16:02 +00003645{
3646 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3647 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3648 psa_key_slot_t *slot;
3649
David Horstmann0fea6a52024-03-11 13:41:05 +00003650 LOCAL_INPUT_DECLARE(hash_external, hash);
3651 LOCAL_INPUT_DECLARE(signature_external, signature);
3652
Paul Elliottc9774412023-02-06 15:14:07 +00003653 /* Check that start has not been previously called, or operation has not
3654 * previously errored. */
3655 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003656 return PSA_ERROR_BAD_STATE;
3657 }
3658
3659 status = psa_sign_verify_check_alg(0, alg);
3660 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003661 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003662 return status;
3663 }
3664
3665 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3666 PSA_KEY_USAGE_VERIFY_HASH,
3667 alg);
3668
3669 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003670 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003671 return status;
3672 }
3673
David Horstmann0fea6a52024-03-11 13:41:05 +00003674 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3675 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3676
Paul Elliott296ede92022-12-15 17:00:30 +00003677 /* Ensure ops count gets reset, in case of operation re-use. */
3678 operation->num_ops = 0;
3679
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003680 status = psa_driver_wrapper_verify_hash_start(operation, &slot->attr,
Paul Elliott9fe12f62022-11-30 19:16:02 +00003681 slot->key.data,
3682 slot->key.bytes,
3683 alg, hash, hash_length,
3684 signature, signature_length);
David Horstmann4a48bec2024-03-13 15:42:31 +00003685#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
David Horstmann0fea6a52024-03-11 13:41:05 +00003686exit:
3687#endif
Paul Elliott9fe12f62022-11-30 19:16:02 +00003688
3689 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003690 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003691 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003692 }
3693
Ryan Everett291267f2024-02-14 15:59:15 +00003694 unlock_status = psa_unregister_read_under_mutex(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003695
Paul Elliottc9774412023-02-06 15:14:07 +00003696 if (unlock_status != PSA_SUCCESS) {
3697 operation->error_occurred = 1;
3698 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003699
David Horstmann0fea6a52024-03-11 13:41:05 +00003700 LOCAL_INPUT_FREE(hash_external, hash);
3701 LOCAL_INPUT_FREE(signature_external, signature);
3702
Paul Elliottc9774412023-02-06 15:14:07 +00003703 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003704}
3705
3706psa_status_t psa_verify_hash_complete(
3707 psa_verify_hash_interruptible_operation_t *operation)
3708{
3709 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3710
Paul Elliottc9774412023-02-06 15:14:07 +00003711 /* Check that start has been called first, and that operation has not
3712 * previously errored. */
3713 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003714 status = PSA_ERROR_BAD_STATE;
3715 goto exit;
3716 }
3717
3718 status = psa_driver_wrapper_verify_hash_complete(operation);
3719
Paul Elliott296ede92022-12-15 17:00:30 +00003720 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003721 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003722 operation);
3723
Paul Elliottebe225c2023-02-10 14:32:53 +00003724exit:
3725
Paul Elliott9fe12f62022-11-30 19:16:02 +00003726 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003727 if (status != PSA_SUCCESS) {
3728 operation->error_occurred = 1;
3729 }
3730
Paul Elliott59ad9452022-12-18 15:09:02 +00003731 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003732 }
3733
3734 return status;
3735}
3736
3737psa_status_t psa_verify_hash_abort(
3738 psa_verify_hash_interruptible_operation_t *operation)
3739{
Paul Elliott59ad9452022-12-18 15:09:02 +00003740 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003741
Paul Elliott59ad9452022-12-18 15:09:02 +00003742 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003743
Paul Elliott59ad9452022-12-18 15:09:02 +00003744 /* We clear the number of ops done here, so that it is not cleared when
3745 * the operation fails or succeeds, only on manual abort. */
3746 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003747
Paul Elliottc9774412023-02-06 15:14:07 +00003748 /* Likewise, failure state. */
3749 operation->error_occurred = 0;
3750
Paul Elliott59ad9452022-12-18 15:09:02 +00003751 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003752}
3753
Paul Elliott588f8ed2022-12-02 18:10:26 +00003754/****************************************************************/
3755/* Asymmetric interruptible cryptography internal */
3756/* implementations */
3757/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003758
Paul Elliott588f8ed2022-12-02 18:10:26 +00003759void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3760{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003761
Paul Elliott588f8ed2022-12-02 18:10:26 +00003762#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3763 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3764 defined(MBEDTLS_ECP_RESTARTABLE)
3765
3766 /* Internal implementation uses zero to indicate infinite number max ops,
3767 * therefore avoid this value, and set to minimum possible. */
3768 if (max_ops == 0) {
3769 max_ops = 1;
3770 }
3771
Paul Elliott588f8ed2022-12-02 18:10:26 +00003772 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003773#else
3774 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003775#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3776 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3777 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3778}
3779
Paul Elliott588f8ed2022-12-02 18:10:26 +00003780uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003781 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003782{
3783#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3784 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3785 defined(MBEDTLS_ECP_RESTARTABLE)
3786
Paul Elliott93d9ca82023-02-15 18:14:21 +00003787 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003788#else
3789 (void) operation;
3790 return 0;
3791#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3792 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3793 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3794}
3795
3796uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003797 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003798{
3799 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3800 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3801 defined(MBEDTLS_ECP_RESTARTABLE)
3802
Paul Elliott93d9ca82023-02-15 18:14:21 +00003803 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003804#else
3805 (void) operation;
3806 return 0;
3807#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3808 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3809 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3810}
3811
3812psa_status_t mbedtls_psa_sign_hash_start(
3813 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3814 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3815 size_t key_buffer_size, psa_algorithm_t alg,
3816 const uint8_t *hash, size_t hash_length)
3817{
3818 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003819 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003820
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003821 if (!PSA_KEY_TYPE_IS_ECC(attributes->type)) {
Paul Elliott068fe072023-01-16 13:59:15 +00003822 return PSA_ERROR_NOT_SUPPORTED;
3823 }
3824
3825 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003826 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003827 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003828
3829#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003830 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3831 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003832
Paul Elliotta1c94092023-02-15 16:38:04 +00003833 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3834
Paul Elliott93d9ca82023-02-15 18:14:21 +00003835 /* Ensure num_ops is zero'ed in case of context re-use. */
3836 operation->num_ops = 0;
3837
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003838 status = mbedtls_psa_ecp_load_representation(attributes->type,
3839 attributes->bits,
Paul Elliott068fe072023-01-16 13:59:15 +00003840 key_buffer,
3841 key_buffer_size,
3842 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003843
Paul Elliott068fe072023-01-16 13:59:15 +00003844 if (status != PSA_SUCCESS) {
3845 return status;
3846 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003847
Paul Elliott1bc59df2023-02-05 13:41:57 +00003848 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003849 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003850
Paul Elliott068fe072023-01-16 13:59:15 +00003851 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003852 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003853 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003854
Paul Elliott0290a762023-02-09 14:30:24 +00003855 /* We only need to store the same length of hash as the private key size
3856 * here, it would be truncated by the internal implementation anyway. */
3857 required_hash_length = (hash_length < operation->coordinate_bytes ?
3858 hash_length : operation->coordinate_bytes);
3859
Paul Elliottba70ad42023-02-15 18:23:53 +00003860 if (required_hash_length > sizeof(operation->hash)) {
3861 /* Shouldn't happen, but better safe than sorry. */
3862 return PSA_ERROR_CORRUPTION_DETECTED;
3863 }
3864
Paul Elliott0290a762023-02-09 14:30:24 +00003865 memcpy(operation->hash, hash, required_hash_length);
3866 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003867
3868 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003869
3870#else
Paul Elliott068fe072023-01-16 13:59:15 +00003871 (void) operation;
3872 (void) key_buffer;
3873 (void) key_buffer_size;
3874 (void) alg;
3875 (void) hash;
3876 (void) hash_length;
3877 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003878 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003879
Paul Elliott068fe072023-01-16 13:59:15 +00003880 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003881#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3882 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3883 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003884}
3885
3886psa_status_t mbedtls_psa_sign_hash_complete(
3887 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3888 uint8_t *signature, size_t signature_size,
3889 size_t *signature_length)
3890{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003891#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3892 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3893 defined(MBEDTLS_ECP_RESTARTABLE)
3894
Paul Elliotta1c94092023-02-15 16:38:04 +00003895 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003896 mbedtls_mpi r;
3897 mbedtls_mpi s;
3898
Paul Elliott46845252023-02-03 14:59:11 +00003899 mbedtls_mpi_init(&r);
3900 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003901
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003902 /* Ensure max_ops is set to the current value (or default). */
3903 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3904
Paul Elliotta1c94092023-02-15 16:38:04 +00003905 if (signature_size < 2 * operation->coordinate_bytes) {
3906 status = PSA_ERROR_BUFFER_TOO_SMALL;
3907 goto exit;
3908 }
3909
Paul Elliott588f8ed2022-12-02 18:10:26 +00003910 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003911
Paul Elliott588f8ed2022-12-02 18:10:26 +00003912#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3913 status = mbedtls_to_psa_error(
3914 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003915 &r,
3916 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003917 &operation->ctx->d,
3918 operation->hash,
3919 operation->hash_length,
3920 operation->md_alg,
3921 mbedtls_psa_get_random,
3922 MBEDTLS_PSA_RANDOM_STATE,
3923 &operation->restart_ctx));
3924#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003925 status = PSA_ERROR_NOT_SUPPORTED;
3926 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003927#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3928 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003929 status = mbedtls_to_psa_error(
3930 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003931 &r,
3932 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003933 &operation->ctx->d,
3934 operation->hash,
3935 operation->hash_length,
3936 mbedtls_psa_get_random,
3937 MBEDTLS_PSA_RANDOM_STATE,
3938 mbedtls_psa_get_random,
3939 MBEDTLS_PSA_RANDOM_STATE,
3940 &operation->restart_ctx));
3941 }
3942
Paul Elliottf8e5b562023-02-19 18:43:45 +00003943 /* Hide the fact that the restart context only holds a delta of number of
3944 * ops done during the last operation, not an absolute value. */
3945 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3946
Paul Elliott724bd252023-02-08 12:35:08 +00003947 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003948 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003949 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003950 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003951 operation->coordinate_bytes)
3952 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003953
3954 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003955 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003956 }
3957
3958 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003959 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003960 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003961 operation->coordinate_bytes,
3962 operation->coordinate_bytes)
3963 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003964
3965 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003966 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003967 }
3968
Paul Elliott1bc59df2023-02-05 13:41:57 +00003969 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003970
Paul Elliott724bd252023-02-08 12:35:08 +00003971 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003972 }
Paul Elliott724bd252023-02-08 12:35:08 +00003973
3974exit:
3975
3976 mbedtls_mpi_free(&r);
3977 mbedtls_mpi_free(&s);
3978 return status;
3979
Paul Elliott588f8ed2022-12-02 18:10:26 +00003980 #else
3981
3982 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003983 (void) signature;
3984 (void) signature_size;
3985 (void) signature_length;
3986
3987 return PSA_ERROR_NOT_SUPPORTED;
3988
3989#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3990 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3991 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3992}
3993
3994psa_status_t mbedtls_psa_sign_hash_abort(
3995 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3996{
3997
3998#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3999 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4000 defined(MBEDTLS_ECP_RESTARTABLE)
4001
4002 if (operation->ctx) {
4003 mbedtls_ecdsa_free(operation->ctx);
4004 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004005 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004006 }
4007
4008 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4009
Paul Elliott93d9ca82023-02-15 18:14:21 +00004010 operation->num_ops = 0;
4011
Paul Elliott588f8ed2022-12-02 18:10:26 +00004012 return PSA_SUCCESS;
4013
4014#else
4015
4016 (void) operation;
4017
4018 return PSA_ERROR_NOT_SUPPORTED;
4019
4020#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4021 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4022 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4023}
4024
4025psa_status_t mbedtls_psa_verify_hash_start(
4026 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
4027 const psa_key_attributes_t *attributes,
4028 const uint8_t *key_buffer, size_t key_buffer_size,
4029 psa_algorithm_t alg,
4030 const uint8_t *hash, size_t hash_length,
4031 const uint8_t *signature, size_t signature_length)
4032{
4033 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00004034 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00004035 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004036
Gilles Peskine2f107ae2024-02-28 01:26:46 +01004037 if (!PSA_KEY_TYPE_IS_ECC(attributes->type)) {
Paul Elliott068fe072023-01-16 13:59:15 +00004038 return PSA_ERROR_NOT_SUPPORTED;
4039 }
4040
4041 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00004042 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00004043 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004044
4045#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00004046 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4047 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00004048
Paul Elliotta1c94092023-02-15 16:38:04 +00004049 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
4050 mbedtls_mpi_init(&operation->r);
4051 mbedtls_mpi_init(&operation->s);
4052
Paul Elliott93d9ca82023-02-15 18:14:21 +00004053 /* Ensure num_ops is zero'ed in case of context re-use. */
4054 operation->num_ops = 0;
4055
Gilles Peskine2f107ae2024-02-28 01:26:46 +01004056 status = mbedtls_psa_ecp_load_representation(attributes->type,
4057 attributes->bits,
Paul Elliott068fe072023-01-16 13:59:15 +00004058 key_buffer,
4059 key_buffer_size,
4060 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004061
Paul Elliott068fe072023-01-16 13:59:15 +00004062 if (status != PSA_SUCCESS) {
4063 return status;
4064 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004065
Paul Elliottc569fc22023-02-10 13:02:54 +00004066 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004067
Paul Elliott1bc59df2023-02-05 13:41:57 +00004068 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004069 return PSA_ERROR_INVALID_SIGNATURE;
4070 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004071
Paul Elliott068fe072023-01-16 13:59:15 +00004072 status = mbedtls_to_psa_error(
4073 mbedtls_mpi_read_binary(&operation->r,
4074 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004075 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004076
Paul Elliott068fe072023-01-16 13:59:15 +00004077 if (status != PSA_SUCCESS) {
4078 return status;
4079 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004080
Paul Elliott068fe072023-01-16 13:59:15 +00004081 status = mbedtls_to_psa_error(
4082 mbedtls_mpi_read_binary(&operation->s,
4083 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004084 coordinate_bytes,
4085 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004086
Paul Elliott068fe072023-01-16 13:59:15 +00004087 if (status != PSA_SUCCESS) {
4088 return status;
4089 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004090
Paul Elliott2c9843f2023-02-15 17:32:42 +00004091 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004092
Paul Elliott2c9843f2023-02-15 17:32:42 +00004093 if (status != PSA_SUCCESS) {
4094 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004095 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004096
Paul Elliott0290a762023-02-09 14:30:24 +00004097 /* We only need to store the same length of hash as the private key size
4098 * here, it would be truncated by the internal implementation anyway. */
4099 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4100 coordinate_bytes);
4101
Paul Elliottba70ad42023-02-15 18:23:53 +00004102 if (required_hash_length > sizeof(operation->hash)) {
4103 /* Shouldn't happen, but better safe than sorry. */
4104 return PSA_ERROR_CORRUPTION_DETECTED;
4105 }
4106
Paul Elliott0290a762023-02-09 14:30:24 +00004107 memcpy(operation->hash, hash, required_hash_length);
4108 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004109
4110 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004111#else
Paul Elliott068fe072023-01-16 13:59:15 +00004112 (void) operation;
4113 (void) key_buffer;
4114 (void) key_buffer_size;
4115 (void) alg;
4116 (void) hash;
4117 (void) hash_length;
4118 (void) signature;
4119 (void) signature_length;
4120 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004121 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004122 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004123
Paul Elliott068fe072023-01-16 13:59:15 +00004124 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004125#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4126 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4127 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004128}
4129
4130psa_status_t mbedtls_psa_verify_hash_complete(
4131 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4132{
4133
4134#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4135 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4136 defined(MBEDTLS_ECP_RESTARTABLE)
4137
Paul Elliottf8e5b562023-02-19 18:43:45 +00004138 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4139
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004140 /* Ensure max_ops is set to the current value (or default). */
4141 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4142
Paul Elliottf8e5b562023-02-19 18:43:45 +00004143 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004144 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4145 operation->hash,
4146 operation->hash_length,
4147 &operation->ctx->Q,
4148 &operation->r,
4149 &operation->s,
4150 &operation->restart_ctx));
4151
Paul Elliottf8e5b562023-02-19 18:43:45 +00004152 /* Hide the fact that the restart context only holds a delta of number of
4153 * ops done during the last operation, not an absolute value. */
4154 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4155
4156 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004157#else
4158 (void) operation;
4159
4160 return PSA_ERROR_NOT_SUPPORTED;
4161
4162#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4163 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4164 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4165}
4166
4167psa_status_t mbedtls_psa_verify_hash_abort(
4168 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4169{
4170
4171#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4172 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4173 defined(MBEDTLS_ECP_RESTARTABLE)
4174
4175 if (operation->ctx) {
4176 mbedtls_ecdsa_free(operation->ctx);
4177 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004178 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004179 }
4180
4181 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4182
Paul Elliott93d9ca82023-02-15 18:14:21 +00004183 operation->num_ops = 0;
4184
Paul Elliott588f8ed2022-12-02 18:10:26 +00004185 mbedtls_mpi_free(&operation->r);
4186 mbedtls_mpi_free(&operation->s);
4187
4188 return PSA_SUCCESS;
4189
4190#else
4191 (void) operation;
4192
4193 return PSA_ERROR_NOT_SUPPORTED;
4194
4195#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4196 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4197 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4198}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004199
David Horstmann6e99bb22024-02-06 15:27:49 +00004200static psa_status_t psa_generate_random_internal(uint8_t *output,
4201 size_t output_size)
4202{
4203 GUARD_MODULE_INITIALIZED;
4204
David Horstmann6e99bb22024-02-06 15:27:49 +00004205#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4206
David Horstmanndb909142024-03-12 16:07:08 +00004207 psa_status_t status;
David Horstmann6e99bb22024-02-06 15:27:49 +00004208 size_t output_length = 0;
4209 status = mbedtls_psa_external_get_random(&global_data.rng,
4210 output, output_size,
4211 &output_length);
4212 if (status != PSA_SUCCESS) {
David Horstmanndb909142024-03-12 16:07:08 +00004213 return status;
David Horstmann6e99bb22024-02-06 15:27:49 +00004214 }
4215 /* Breaking up a request into smaller chunks is currently not supported
4216 * for the external RNG interface. */
4217 if (output_length != output_size) {
David Horstmanndb909142024-03-12 16:07:08 +00004218 return PSA_ERROR_INSUFFICIENT_ENTROPY;
David Horstmann6e99bb22024-02-06 15:27:49 +00004219 }
David Horstmanndb909142024-03-12 16:07:08 +00004220 return PSA_SUCCESS;
David Horstmann6e99bb22024-02-06 15:27:49 +00004221
4222#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4223
4224 while (output_size > 0) {
David Horstmann93fa4e12024-03-12 15:02:28 +00004225 int ret = MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED;
David Horstmann6e99bb22024-02-06 15:27:49 +00004226 size_t request_size =
4227 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4228 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4229 output_size);
David Horstmann93fa4e12024-03-12 15:02:28 +00004230#if defined(MBEDTLS_CTR_DRBG_C)
4231 ret = mbedtls_ctr_drbg_random(&global_data.rng.drbg, output, request_size);
4232#elif defined(MBEDTLS_HMAC_DRBG_C)
4233 ret = mbedtls_hmac_drbg_random(&global_data.rng.drbg, output, request_size);
4234#endif /* !MBEDTLS_CTR_DRBG_C && !MBEDTLS_HMAC_DRBG_C */
David Horstmann6e99bb22024-02-06 15:27:49 +00004235 if (ret != 0) {
David Horstmann93fa4e12024-03-12 15:02:28 +00004236 return mbedtls_to_psa_error(ret);
David Horstmann6e99bb22024-02-06 15:27:49 +00004237 }
4238 output_size -= request_size;
4239 output += request_size;
4240 }
David Horstmann93fa4e12024-03-12 15:02:28 +00004241 return PSA_SUCCESS;
David Horstmann6e99bb22024-02-06 15:27:49 +00004242#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
David Horstmann6e99bb22024-02-06 15:27:49 +00004243}
4244
4245
mohammad1603503973b2018-03-12 15:59:30 +02004246/****************************************************************/
4247/* Symmetric cryptography */
4248/****************************************************************/
4249
Gilles Peskine449bd832023-01-11 14:50:10 +01004250static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4251 mbedtls_svc_key_id_t key,
4252 psa_algorithm_t alg,
4253 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004254{
4255 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4256 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004257 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004258 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4259 PSA_KEY_USAGE_ENCRYPT :
4260 PSA_KEY_USAGE_DECRYPT);
Ronald Cronab99ac22020-10-01 16:38:28 +02004261
4262 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004263 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004264 status = PSA_ERROR_BAD_STATE;
4265 goto exit;
4266 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004267
Gilles Peskine449bd832023-01-11 14:50:10 +01004268 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004269 status = PSA_ERROR_INVALID_ARGUMENT;
4270 goto exit;
4271 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004272
Gilles Peskine449bd832023-01-11 14:50:10 +01004273 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4274 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004275 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004276 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004277
Ronald Cron49fafa92021-03-10 08:34:23 +01004278 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004279 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004280 * so we only set it (in the driver wrapper) after resources have been
4281 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004282 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004283 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004284 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004285 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004286 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004287 }
4288 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004289
4290 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004291 if (cipher_operation == MBEDTLS_ENCRYPT) {
4292 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004293 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 slot->key.data,
4295 slot->key.bytes,
4296 alg);
4297 } else {
4298 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004299 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01004300 slot->key.data,
4301 slot->key.bytes,
4302 alg);
4303 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004304
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004305exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004306 if (status != PSA_SUCCESS) {
4307 psa_cipher_abort(operation);
4308 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004309
Ryan Everettc0053cc2024-02-14 16:27:13 +00004310 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004311
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004313}
4314
Gilles Peskine449bd832023-01-11 14:50:10 +01004315psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4316 mbedtls_svc_key_id_t key,
4317 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004318{
Gilles Peskine449bd832023-01-11 14:50:10 +01004319 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004320}
4321
Gilles Peskine449bd832023-01-11 14:50:10 +01004322psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4323 mbedtls_svc_key_id_t key,
4324 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004325{
Gilles Peskine449bd832023-01-11 14:50:10 +01004326 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004327}
4328
Gilles Peskine449bd832023-01-11 14:50:10 +01004329psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
Gabor Mezei358eb212024-02-07 18:10:13 +01004330 uint8_t *iv_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004331 size_t iv_size,
4332 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004333{
Ronald Cron6d051732020-10-01 14:10:20 +02004334 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Sergeybef1f632023-03-06 15:25:06 -07004335 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004336
Gabor Mezei358eb212024-02-07 18:10:13 +01004337 LOCAL_OUTPUT_DECLARE(iv_external, iv);
4338
Gilles Peskine449bd832023-01-11 14:50:10 +01004339 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004340 status = PSA_ERROR_BAD_STATE;
4341 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004342 }
4343
Gilles Peskine449bd832023-01-11 14:50:10 +01004344 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004345 status = PSA_ERROR_BAD_STATE;
4346 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004347 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004348
Ronald Cron2fb90522021-07-05 12:31:44 +02004349 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004350 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004351 status = PSA_ERROR_BUFFER_TOO_SMALL;
4352 goto exit;
4353 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004354
Gilles Peskine449bd832023-01-11 14:50:10 +01004355 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004356 status = PSA_ERROR_GENERIC_ERROR;
4357 goto exit;
4358 }
4359
Gabor Mezei358eb212024-02-07 18:10:13 +01004360 LOCAL_OUTPUT_ALLOC(iv_external, default_iv_length, iv);
4361
Gabor Mezei1b5b58d2024-03-04 17:15:08 +01004362 status = psa_generate_random_internal(iv, default_iv_length);
Gilles Peskine449bd832023-01-11 14:50:10 +01004363 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004364 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004365 }
Ronald Cron5618a392021-03-26 09:52:26 +01004366
Gilles Peskine449bd832023-01-11 14:50:10 +01004367 status = psa_driver_wrapper_cipher_set_iv(operation,
Gabor Mezei358eb212024-02-07 18:10:13 +01004368 iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004369
4370exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004371 if (status == PSA_SUCCESS) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004372 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004373 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004374 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004375 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004376 psa_cipher_abort(operation);
Gabor Mezei358eb212024-02-07 18:10:13 +01004377 if (iv != NULL) {
4378 mbedtls_platform_zeroize(iv, default_iv_length);
4379 }
Ronald Cron2fb90522021-07-05 12:31:44 +02004380 }
Ronald Cron6d051732020-10-01 14:10:20 +02004381
Gabor Mezei358eb212024-02-07 18:10:13 +01004382 LOCAL_OUTPUT_FREE(iv_external, iv);
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004384}
4385
Gilles Peskine449bd832023-01-11 14:50:10 +01004386psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004387 const uint8_t *iv_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004388 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004389{
Ronald Cron6d051732020-10-01 14:10:20 +02004390 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004391
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004392 LOCAL_INPUT_DECLARE(iv_external, iv);
4393
Gilles Peskine449bd832023-01-11 14:50:10 +01004394 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004395 status = PSA_ERROR_BAD_STATE;
4396 goto exit;
4397 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004398
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004400 status = PSA_ERROR_BAD_STATE;
4401 goto exit;
4402 }
Ronald Crona0d68172021-03-26 10:15:08 +01004403
Gilles Peskine449bd832023-01-11 14:50:10 +01004404 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004405 status = PSA_ERROR_INVALID_ARGUMENT;
4406 goto exit;
4407 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004408
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004409 LOCAL_INPUT_ALLOC(iv_external, iv_length, iv);
4410
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 status = psa_driver_wrapper_cipher_set_iv(operation,
4412 iv,
4413 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004414
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004415exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004416 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004417 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004418 } else {
4419 psa_cipher_abort(operation);
4420 }
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004421
4422 LOCAL_INPUT_FREE(iv_external, iv);
4423
Gilles Peskine449bd832023-01-11 14:50:10 +01004424 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004425}
4426
Gilles Peskine449bd832023-01-11 14:50:10 +01004427psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
Gabor Mezei212eb082024-01-24 16:56:00 +01004428 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004429 size_t input_length,
Gabor Mezei212eb082024-01-24 16:56:00 +01004430 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004431 size_t output_size,
4432 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004433{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004434 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004435
Gabor Mezei212eb082024-01-24 16:56:00 +01004436 LOCAL_INPUT_DECLARE(input_external, input);
4437 LOCAL_OUTPUT_DECLARE(output_external, output);
4438
Gilles Peskine449bd832023-01-11 14:50:10 +01004439 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004440 status = PSA_ERROR_BAD_STATE;
4441 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004442 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004443
Gilles Peskine449bd832023-01-11 14:50:10 +01004444 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004445 status = PSA_ERROR_BAD_STATE;
4446 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004447 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004448
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004449 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gabor Mezei0b041162024-02-29 10:08:16 +00004450 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004451
Gilles Peskine449bd832023-01-11 14:50:10 +01004452 status = psa_driver_wrapper_cipher_update(operation,
4453 input,
4454 input_length,
4455 output,
4456 output_size,
4457 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004458
4459exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004460 if (status != PSA_SUCCESS) {
4461 psa_cipher_abort(operation);
4462 }
Ronald Cron6d051732020-10-01 14:10:20 +02004463
Gabor Mezei212eb082024-01-24 16:56:00 +01004464 LOCAL_INPUT_FREE(input_external, input);
4465 LOCAL_OUTPUT_FREE(output_external, output);
4466
Gilles Peskine449bd832023-01-11 14:50:10 +01004467 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004468}
4469
Gilles Peskine449bd832023-01-11 14:50:10 +01004470psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
Gabor Mezei212eb082024-01-24 16:56:00 +01004471 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004472 size_t output_size,
4473 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004474{
David Saadab4ecc272019-02-14 13:48:10 +02004475 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004476
Gabor Mezei212eb082024-01-24 16:56:00 +01004477 LOCAL_OUTPUT_DECLARE(output_external, output);
4478
Gilles Peskine449bd832023-01-11 14:50:10 +01004479 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004480 status = PSA_ERROR_BAD_STATE;
4481 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004482 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004483
Gilles Peskine449bd832023-01-11 14:50:10 +01004484 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004485 status = PSA_ERROR_BAD_STATE;
4486 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004487 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004488
Gabor Mezei0b041162024-02-29 10:08:16 +00004489 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004490
Gilles Peskine449bd832023-01-11 14:50:10 +01004491 status = psa_driver_wrapper_cipher_finish(operation,
4492 output,
4493 output_size,
4494 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004495
4496exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004497 if (status == PSA_SUCCESS) {
Gabor Mezei212eb082024-01-24 16:56:00 +01004498 status = psa_cipher_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01004499 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004500 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004501 (void) psa_cipher_abort(operation);
Steven Cooremanef8575e2020-09-11 11:44:50 +02004502 }
Gabor Mezei212eb082024-01-24 16:56:00 +01004503
4504 LOCAL_OUTPUT_FREE(output_external, output);
4505
4506 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004507}
4508
Gilles Peskine449bd832023-01-11 14:50:10 +01004509psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004510{
Gilles Peskine449bd832023-01-11 14:50:10 +01004511 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004512 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004513 * in use. It's ok to call abort on such an object, and there's
4514 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004516 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004517
Gilles Peskine449bd832023-01-11 14:50:10 +01004518 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004519
Ronald Cron49fafa92021-03-10 08:34:23 +01004520 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004521 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004522 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004523
Gilles Peskine449bd832023-01-11 14:50:10 +01004524 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004525}
4526
Gilles Peskine449bd832023-01-11 14:50:10 +01004527psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4528 psa_algorithm_t alg,
David Horstmann36df4b22023-12-13 15:55:25 +00004529 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004530 size_t input_length,
David Horstmann36df4b22023-12-13 15:55:25 +00004531 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004532 size_t output_size,
4533 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004534{
4535 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004536 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004537 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004538 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4539 size_t default_iv_length = 0;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004540
David Horstmann62a56d92023-12-14 18:12:47 +00004541 LOCAL_INPUT_DECLARE(input_external, input);
4542 LOCAL_OUTPUT_DECLARE(output_external, output);
4543
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004545 status = PSA_ERROR_INVALID_ARGUMENT;
4546 goto exit;
4547 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004548
Gilles Peskine449bd832023-01-11 14:50:10 +01004549 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4550 PSA_KEY_USAGE_ENCRYPT,
4551 alg);
4552 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004553 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004554 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004555
Gilles Peskine449bd832023-01-11 14:50:10 +01004556 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4557 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004558 status = PSA_ERROR_GENERIC_ERROR;
4559 goto exit;
4560 }
4561
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 if (default_iv_length > 0) {
4563 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004564 status = PSA_ERROR_BUFFER_TOO_SMALL;
4565 goto exit;
4566 }
4567
David Horstmann6e99bb22024-02-06 15:27:49 +00004568 status = psa_generate_random_internal(local_iv, default_iv_length);
Gilles Peskine449bd832023-01-11 14:50:10 +01004569 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004570 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004571 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004572 }
4573
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004574 LOCAL_INPUT_ALLOC(input_external, input_length, input);
4575 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
4576
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004577 status = psa_driver_wrapper_cipher_encrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004578 &slot->attr, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004579 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004580 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004581 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004582
4583exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004584 unlock_status = psa_unregister_read_under_mutex(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004585 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004586 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004587 }
Ronald Cron23919522021-07-08 19:00:07 +02004588
Gilles Peskine449bd832023-01-11 14:50:10 +01004589 if (status == PSA_SUCCESS) {
4590 if (default_iv_length > 0) {
4591 memcpy(output, local_iv, default_iv_length);
4592 }
4593 *output_length += default_iv_length;
4594 } else {
4595 *output_length = 0;
4596 }
4597
David Horstmann62a56d92023-12-14 18:12:47 +00004598 LOCAL_INPUT_FREE(input_external, input);
4599 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004600
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004602}
4603
Gilles Peskine449bd832023-01-11 14:50:10 +01004604psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4605 psa_algorithm_t alg,
Gabor Mezei212eb082024-01-24 16:56:00 +01004606 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004607 size_t input_length,
Gabor Mezei212eb082024-01-24 16:56:00 +01004608 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004609 size_t output_size,
4610 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004611{
4612 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004613 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004614 psa_key_slot_t *slot = NULL;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004615
Gabor Mezei212eb082024-01-24 16:56:00 +01004616 LOCAL_INPUT_DECLARE(input_external, input);
4617 LOCAL_OUTPUT_DECLARE(output_external, output);
4618
Gilles Peskine449bd832023-01-11 14:50:10 +01004619 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004620 status = PSA_ERROR_INVALID_ARGUMENT;
4621 goto exit;
4622 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004623
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4625 PSA_KEY_USAGE_DECRYPT,
4626 alg);
4627 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004628 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004630
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4632 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004633 status = PSA_ERROR_INVALID_ARGUMENT;
4634 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004635 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004636 status = PSA_ERROR_INVALID_ARGUMENT;
4637 goto exit;
4638 }
4639
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004640 LOCAL_INPUT_ALLOC(input_external, input_length, input);
4641 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
4642
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004643 status = psa_driver_wrapper_cipher_decrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004644 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004645 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004646 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004647
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004648exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004649 unlock_status = psa_unregister_read_under_mutex(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004650 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004651 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004652 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004653
Gilles Peskine449bd832023-01-11 14:50:10 +01004654 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004655 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004656 }
Ronald Cron23919522021-07-08 19:00:07 +02004657
Gabor Mezei212eb082024-01-24 16:56:00 +01004658 LOCAL_INPUT_FREE(input_external, input);
4659 LOCAL_OUTPUT_FREE(output_external, output);
4660
Gilles Peskine449bd832023-01-11 14:50:10 +01004661 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004662}
4663
4664
mohammad16035955c982018-04-26 00:53:03 +03004665/****************************************************************/
4666/* AEAD */
4667/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004668
Paul Elliottbaff51c2021-09-28 17:44:45 +01004669/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004670static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004671{
Gilles Peskine449bd832023-01-11 14:50:10 +01004672 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004673}
4674
4675/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004676static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4677 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004678{
Gilles Peskine449bd832023-01-11 14:50:10 +01004679 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004680
Gilles Peskine449bd832023-01-11 14:50:10 +01004681 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004682#if defined(PSA_WANT_ALG_GCM)
4683 case PSA_ALG_GCM:
4684 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004685 * arbitrarily large nonces. Please note that we do not generally
4686 * recommend the usage of nonces of greater length than
4687 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4688 * size, which can then lead to collisions if you encrypt a very
4689 * large number of messages.*/
4690 if (nonce_length != 0) {
4691 return PSA_SUCCESS;
4692 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004693 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004694#endif /* PSA_WANT_ALG_GCM */
4695#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004696 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004697 if (nonce_length >= 7 && nonce_length <= 13) {
4698 return PSA_SUCCESS;
4699 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004700 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004701#endif /* PSA_WANT_ALG_CCM */
4702#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004703 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004704 if (nonce_length == 12) {
4705 return PSA_SUCCESS;
4706 } else if (nonce_length == 8) {
4707 return PSA_ERROR_NOT_SUPPORTED;
4708 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004709 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004710#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004711 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004712 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004714 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004715
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004717}
4718
Gilles Peskine449bd832023-01-11 14:50:10 +01004719static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004720{
Gilles Peskine449bd832023-01-11 14:50:10 +01004721 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4722 return PSA_ERROR_INVALID_ARGUMENT;
4723 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004724
Gilles Peskine449bd832023-01-11 14:50:10 +01004725 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004726}
4727
Gilles Peskine449bd832023-01-11 14:50:10 +01004728psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4729 psa_algorithm_t alg,
David Horstmann9d09a022023-11-28 19:25:00 +00004730 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004731 size_t nonce_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004732 const uint8_t *additional_data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004733 size_t additional_data_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004734 const uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004735 size_t plaintext_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004736 uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 size_t ciphertext_size,
4738 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004739{
Ronald Cron215633c2021-03-16 17:15:37 +01004740 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4741 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004742
David Horstmann9d09a022023-11-28 19:25:00 +00004743 LOCAL_INPUT_DECLARE(nonce_external, nonce);
4744 LOCAL_INPUT_DECLARE(additional_data_external, additional_data);
4745 LOCAL_INPUT_DECLARE(plaintext_external, plaintext);
4746 LOCAL_OUTPUT_DECLARE(ciphertext_external, ciphertext);
4747
mohammad1603f08a5502018-06-03 15:05:47 +03004748 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004749
Gilles Peskine449bd832023-01-11 14:50:10 +01004750 status = psa_aead_check_algorithm(alg);
4751 if (status != PSA_SUCCESS) {
4752 return status;
4753 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004754
Ronald Cron9a986162021-03-26 12:40:07 +01004755 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4757 if (status != PSA_SUCCESS) {
4758 return status;
4759 }
mohammad16035955c982018-04-26 00:53:03 +03004760
David Horstmann9d09a022023-11-28 19:25:00 +00004761 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
4762 LOCAL_INPUT_ALLOC(additional_data_external, additional_data_length, additional_data);
4763 LOCAL_INPUT_ALLOC(plaintext_external, plaintext_length, plaintext);
4764 LOCAL_OUTPUT_ALLOC(ciphertext_external, ciphertext_size, ciphertext);
4765
Gilles Peskine449bd832023-01-11 14:50:10 +01004766 status = psa_aead_check_nonce_length(alg, nonce_length);
4767 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004768 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004769 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004770
Ronald Cronde822812021-03-17 16:08:20 +01004771 status = psa_driver_wrapper_aead_encrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004772 &slot->attr, slot->key.data, slot->key.bytes,
Ronald Cron215633c2021-03-16 17:15:37 +01004773 alg,
4774 nonce, nonce_length,
4775 additional_data, additional_data_length,
4776 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004777 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004778
Gilles Peskine449bd832023-01-11 14:50:10 +01004779 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4780 memset(ciphertext, 0, ciphertext_size);
4781 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004782
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004783exit:
David Horstmann9d09a022023-11-28 19:25:00 +00004784 LOCAL_INPUT_FREE(nonce_external, nonce);
4785 LOCAL_INPUT_FREE(additional_data_external, additional_data);
4786 LOCAL_INPUT_FREE(plaintext_external, plaintext);
4787 LOCAL_OUTPUT_FREE(ciphertext_external, ciphertext);
4788
Ryan Everetta103ec92024-01-31 13:59:57 +00004789 psa_unregister_read_under_mutex(slot);
mohammad16035955c982018-04-26 00:53:03 +03004790
Gilles Peskine449bd832023-01-11 14:50:10 +01004791 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004792}
4793
Gilles Peskine449bd832023-01-11 14:50:10 +01004794psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4795 psa_algorithm_t alg,
David Horstmann7f2e0402023-11-28 19:43:53 +00004796 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 size_t nonce_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004798 const uint8_t *additional_data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 size_t additional_data_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004800 const uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004801 size_t ciphertext_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004802 uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004803 size_t plaintext_size,
4804 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004805{
Ronald Cron215633c2021-03-16 17:15:37 +01004806 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4807 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004808
David Horstmann7f2e0402023-11-28 19:43:53 +00004809 LOCAL_INPUT_DECLARE(nonce_external, nonce);
4810 LOCAL_INPUT_DECLARE(additional_data_external, additional_data);
4811 LOCAL_INPUT_DECLARE(ciphertext_external, ciphertext);
4812 LOCAL_OUTPUT_DECLARE(plaintext_external, plaintext);
4813
Gilles Peskineee652a32018-06-01 19:23:52 +02004814 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004815
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 status = psa_aead_check_algorithm(alg);
4817 if (status != PSA_SUCCESS) {
4818 return status;
4819 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004820
Ronald Cron9a986162021-03-26 12:40:07 +01004821 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004822 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4823 if (status != PSA_SUCCESS) {
4824 return status;
4825 }
mohammad16035955c982018-04-26 00:53:03 +03004826
David Horstmann7f2e0402023-11-28 19:43:53 +00004827 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
4828 LOCAL_INPUT_ALLOC(additional_data_external, additional_data_length,
4829 additional_data);
4830 LOCAL_INPUT_ALLOC(ciphertext_external, ciphertext_length, ciphertext);
4831 LOCAL_OUTPUT_ALLOC(plaintext_external, plaintext_size, plaintext);
4832
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 status = psa_aead_check_nonce_length(alg, nonce_length);
4834 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004835 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004836 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004837
Ronald Cronde822812021-03-17 16:08:20 +01004838 status = psa_driver_wrapper_aead_decrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004839 &slot->attr, slot->key.data, slot->key.bytes,
Ronald Cron215633c2021-03-16 17:15:37 +01004840 alg,
4841 nonce, nonce_length,
4842 additional_data, additional_data_length,
4843 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004844 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004845
Gilles Peskine449bd832023-01-11 14:50:10 +01004846 if (status != PSA_SUCCESS && plaintext_size != 0) {
4847 memset(plaintext, 0, plaintext_size);
4848 }
mohammad160360a64d02018-06-03 17:20:42 +03004849
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004850exit:
David Horstmann7f2e0402023-11-28 19:43:53 +00004851 LOCAL_INPUT_FREE(nonce_external, nonce);
4852 LOCAL_INPUT_FREE(additional_data_external, additional_data);
4853 LOCAL_INPUT_FREE(ciphertext_external, ciphertext);
4854 LOCAL_OUTPUT_FREE(plaintext_external, plaintext);
4855
Ryan Everetta103ec92024-01-31 13:59:57 +00004856 psa_unregister_read_under_mutex(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004857
Gilles Peskine449bd832023-01-11 14:50:10 +01004858 return status;
mohammad16035955c982018-04-26 00:53:03 +03004859}
4860
Gilles Peskine449bd832023-01-11 14:50:10 +01004861static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4862{
4863 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004864
Gilles Peskine449bd832023-01-11 14:50:10 +01004865 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004866#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004867 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004868 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004869 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4870 return PSA_ERROR_INVALID_ARGUMENT;
4871 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004872 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004873#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004874
Przemek Stekiel86679c72022-10-06 17:06:56 +02004875#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004877 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004878 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4879 return PSA_ERROR_INVALID_ARGUMENT;
4880 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004881 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004882#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004883
Przemek Stekiel86679c72022-10-06 17:06:56 +02004884#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004885 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004886 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 if (tag_len != 16) {
4888 return PSA_ERROR_INVALID_ARGUMENT;
4889 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004890 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004891#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004892
4893 default:
4894 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004895 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004896 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004897 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004898}
4899
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004900/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004901static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4902 int is_encrypt,
4903 mbedtls_svc_key_id_t key,
4904 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004905{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004906 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4907 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4908 psa_key_slot_t *slot = NULL;
4909 psa_key_usage_t key_usage = 0;
4910
Gilles Peskine449bd832023-01-11 14:50:10 +01004911 status = psa_aead_check_algorithm(alg);
4912 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004913 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004914 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004915
Gilles Peskine449bd832023-01-11 14:50:10 +01004916 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004917 status = PSA_ERROR_BAD_STATE;
4918 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004919 }
4920
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 if (operation->nonce_set || operation->lengths_set ||
4922 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004923 status = PSA_ERROR_BAD_STATE;
4924 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004925 }
4926
Gilles Peskine449bd832023-01-11 14:50:10 +01004927 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004928 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004929 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004930 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004931 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004932
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4934 alg);
4935 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004936 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004937 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004938
Gilles Peskine449bd832023-01-11 14:50:10 +01004939 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004940 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004941 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004942
Gilles Peskine449bd832023-01-11 14:50:10 +01004943 if (is_encrypt) {
4944 status = psa_driver_wrapper_aead_encrypt_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004945 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01004946 slot->key.data,
4947 slot->key.bytes,
4948 alg);
4949 } else {
4950 status = psa_driver_wrapper_aead_decrypt_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004951 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01004952 slot->key.data,
4953 slot->key.bytes,
4954 alg);
4955 }
4956 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004957 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004958 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004959
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004960 operation->key_type = psa_get_key_type(&slot->attr);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004961
4962exit:
Ryan Everett9af70e52024-02-14 18:38:56 +00004963 unlock_status = psa_unregister_read_under_mutex(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004964
Gilles Peskine449bd832023-01-11 14:50:10 +01004965 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004966 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004967 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004968 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004969 } else {
4970 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004971 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004972
Gilles Peskine449bd832023-01-11 14:50:10 +01004973 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004974}
4975
Paul Elliott302ff6b2021-04-20 18:10:30 +01004976/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004977psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4978 mbedtls_svc_key_id_t key,
4979 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004980{
Gilles Peskine449bd832023-01-11 14:50:10 +01004981 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004982}
4983
4984/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004985psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4986 mbedtls_svc_key_id_t key,
4987 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004988{
Gilles Peskine449bd832023-01-11 14:50:10 +01004989 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004990}
4991
David Horstmannfed23772023-12-19 17:49:20 +00004992static psa_status_t psa_aead_set_nonce_internal(psa_aead_operation_t *operation,
4993 const uint8_t *nonce,
4994 size_t nonce_length)
4995{
4996 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4997
4998 if (operation->id == 0) {
4999 status = PSA_ERROR_BAD_STATE;
5000 goto exit;
5001 }
5002
5003 if (operation->nonce_set) {
5004 status = PSA_ERROR_BAD_STATE;
5005 goto exit;
5006 }
5007
5008 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
5009 if (status != PSA_SUCCESS) {
5010 status = PSA_ERROR_INVALID_ARGUMENT;
5011 goto exit;
5012 }
5013
5014 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
5015 nonce_length);
5016
5017exit:
5018 if (status == PSA_SUCCESS) {
5019 operation->nonce_set = 1;
5020 } else {
5021 psa_aead_abort(operation);
5022 }
5023
5024 return status;
5025}
5026
Paul Elliott302ff6b2021-04-20 18:10:30 +01005027/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01005028psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
David Horstmannd3cad8b2023-12-11 14:46:04 +00005029 uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005030 size_t nonce_size,
5031 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005032{
5033 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01005034 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07005035 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005036
David Horstmannd3cad8b2023-12-11 14:46:04 +00005037 LOCAL_OUTPUT_DECLARE(nonce_external, nonce);
5038 LOCAL_OUTPUT_ALLOC(nonce_external, nonce_size, nonce);
5039
Paul Elliott8eb9daf2021-06-04 16:42:21 +01005040 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005041
Gilles Peskine449bd832023-01-11 14:50:10 +01005042 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005043 status = PSA_ERROR_BAD_STATE;
5044 goto exit;
5045 }
5046
Gilles Peskine449bd832023-01-11 14:50:10 +01005047 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005048 status = PSA_ERROR_BAD_STATE;
5049 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005050 }
5051
Paul Elliotte193ea82021-10-01 13:00:16 +01005052 /* For CCM, this size may not be correct according to the PSA
5053 * specification. The PSA Crypto 1.0.1 specification states:
5054 *
5055 * CCM encodes the plaintext length pLen in L octets, with L the smallest
5056 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
5057 *
5058 * However this restriction that L has to be the smallest integer is not
5059 * applied in practice, and it is not implementable here since the
5060 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005061 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
5062 operation->alg);
5063 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005064 status = PSA_ERROR_BUFFER_TOO_SMALL;
5065 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005066 }
5067
David Horstmann6e99bb22024-02-06 15:27:49 +00005068 status = psa_generate_random_internal(local_nonce, required_nonce_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01005069 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005070 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005071 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01005072
David Horstmannfed23772023-12-19 17:49:20 +00005073 status = psa_aead_set_nonce_internal(operation, local_nonce,
5074 required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005075
Paul Elliott39dc6b82021-05-11 19:16:09 +01005076exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005077 if (status == PSA_SUCCESS) {
5078 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005079 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01005080 } else {
5081 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01005082 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005083
David Horstmannd3cad8b2023-12-11 14:46:04 +00005084 LOCAL_OUTPUT_FREE(nonce_external, nonce);
5085
Gilles Peskine449bd832023-01-11 14:50:10 +01005086 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005087}
5088
5089/* Set the nonce for a multipart authenticated encryption or decryption
5090 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005091psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
David Horstmann8f0ef512023-12-11 15:17:11 +00005092 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005093 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005094{
David Horstmannfed23772023-12-19 17:49:20 +00005095 psa_status_t status;
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005096
David Horstmann8f0ef512023-12-11 15:17:11 +00005097 LOCAL_INPUT_DECLARE(nonce_external, nonce);
5098 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
Paul Elliottcee785c2021-05-20 14:29:20 +01005099
David Horstmannfed23772023-12-19 17:49:20 +00005100 status = psa_aead_set_nonce_internal(operation, nonce, nonce_length);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005101
David Horstmann18dc0322023-12-20 16:16:43 +00005102/* Exit label is only needed for buffer copying, prevent unused warnings. */
David Horstmann4a48bec2024-03-13 15:42:31 +00005103#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Paul Elliott39dc6b82021-05-11 19:16:09 +01005104exit:
David Horstmann18dc0322023-12-20 16:16:43 +00005105#endif
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005106
David Horstmann8f0ef512023-12-11 15:17:11 +00005107 LOCAL_INPUT_FREE(nonce_external, nonce);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005108
Gilles Peskine449bd832023-01-11 14:50:10 +01005109 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005110}
5111
5112/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005113psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
5114 size_t ad_length,
5115 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005116{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005117 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5118
Gilles Peskine449bd832023-01-11 14:50:10 +01005119 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005120 status = PSA_ERROR_BAD_STATE;
5121 goto exit;
5122 }
5123
Gilles Peskine449bd832023-01-11 14:50:10 +01005124 if (operation->lengths_set || operation->ad_started ||
5125 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005126 status = PSA_ERROR_BAD_STATE;
5127 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005128 }
5129
Gilles Peskine449bd832023-01-11 14:50:10 +01005130 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005131#if defined(PSA_WANT_ALG_GCM)
5132 case PSA_ALG_GCM:
5133 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01005134 * bits. Without the guard this code will generate warnings on 32bit
5135 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01005136#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01005137 if (((uint64_t) ad_length) >> 61 != 0 ||
5138 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005139 status = PSA_ERROR_INVALID_ARGUMENT;
5140 goto exit;
5141 }
Paul Elliott325d3742021-09-27 17:56:28 +01005142#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005143 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005144#endif /* PSA_WANT_ALG_GCM */
5145#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005146 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01005147 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005148 status = PSA_ERROR_INVALID_ARGUMENT;
5149 goto exit;
5150 }
5151 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005152#endif /* PSA_WANT_ALG_CCM */
5153#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005154 case PSA_ALG_CHACHA20_POLY1305:
5155 /* No length restrictions for ChaChaPoly. */
5156 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005157#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005158 default:
5159 break;
5160 }
Paul Elliott325d3742021-09-27 17:56:28 +01005161
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
5163 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005164
Paul Elliott39dc6b82021-05-11 19:16:09 +01005165exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005166 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005167 operation->ad_remaining = ad_length;
5168 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01005169 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 } else {
5171 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01005172 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005173
Gilles Peskine449bd832023-01-11 14:50:10 +01005174 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005175}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005176
5177/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005178psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
David Horstmann25dac6e2023-12-11 15:23:13 +00005179 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005180 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005181{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005182 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5183
David Horstmann25dac6e2023-12-11 15:23:13 +00005184 LOCAL_INPUT_DECLARE(input_external, input);
5185 LOCAL_INPUT_ALLOC(input_external, input_length, input);
5186
Gilles Peskine449bd832023-01-11 14:50:10 +01005187 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005188 status = PSA_ERROR_BAD_STATE;
5189 goto exit;
5190 }
5191
Gilles Peskine449bd832023-01-11 14:50:10 +01005192 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005193 status = PSA_ERROR_BAD_STATE;
5194 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005195 }
5196
Gilles Peskine449bd832023-01-11 14:50:10 +01005197 if (operation->lengths_set) {
5198 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005199 status = PSA_ERROR_INVALID_ARGUMENT;
5200 goto exit;
5201 }
5202
5203 operation->ad_remaining -= input_length;
5204 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005205#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005206 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005207 status = PSA_ERROR_BAD_STATE;
5208 goto exit;
5209 }
5210#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005211
Gilles Peskine449bd832023-01-11 14:50:10 +01005212 status = psa_driver_wrapper_aead_update_ad(operation, input,
5213 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005214
Paul Elliott39dc6b82021-05-11 19:16:09 +01005215exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005216 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005217 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005218 } else {
5219 psa_aead_abort(operation);
5220 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005221
David Horstmann25dac6e2023-12-11 15:23:13 +00005222 LOCAL_INPUT_FREE(input_external, input);
5223
Gilles Peskine449bd832023-01-11 14:50:10 +01005224 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005225}
5226
5227/* Encrypt or decrypt a message fragment in an active multipart AEAD
5228 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005229psa_status_t psa_aead_update(psa_aead_operation_t *operation,
David Horstmann2914fac2023-12-11 15:28:37 +00005230 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005231 size_t input_length,
David Horstmann2914fac2023-12-11 15:28:37 +00005232 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005233 size_t output_size,
5234 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005235{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005236 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005237
David Horstmann2914fac2023-12-11 15:28:37 +00005238
5239 LOCAL_INPUT_DECLARE(input_external, input);
5240 LOCAL_OUTPUT_DECLARE(output_external, output);
5241
5242 LOCAL_INPUT_ALLOC(input_external, input_length, input);
5243 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
5244
Paul Elliott302ff6b2021-04-20 18:10:30 +01005245 *output_length = 0;
5246
Gilles Peskine449bd832023-01-11 14:50:10 +01005247 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005248 status = PSA_ERROR_BAD_STATE;
5249 goto exit;
5250 }
5251
Gilles Peskine449bd832023-01-11 14:50:10 +01005252 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005253 status = PSA_ERROR_BAD_STATE;
5254 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005255 }
5256
Gilles Peskine449bd832023-01-11 14:50:10 +01005257 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005258 /* Additional data length was supplied, but not all the additional
5259 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005260 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005261 status = PSA_ERROR_INVALID_ARGUMENT;
5262 goto exit;
5263 }
5264
5265 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005267 status = PSA_ERROR_INVALID_ARGUMENT;
5268 goto exit;
5269 }
5270
5271 operation->body_remaining -= input_length;
5272 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005273#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005274 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005275 status = PSA_ERROR_BAD_STATE;
5276 goto exit;
5277 }
5278#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005279
Gilles Peskine449bd832023-01-11 14:50:10 +01005280 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5281 output, output_size,
5282 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005283
Paul Elliott39dc6b82021-05-11 19:16:09 +01005284exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005285 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005286 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005287 } else {
5288 psa_aead_abort(operation);
5289 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005290
David Horstmann2914fac2023-12-11 15:28:37 +00005291 LOCAL_INPUT_FREE(input_external, input);
5292 LOCAL_OUTPUT_FREE(output_external, output);
5293
Gilles Peskine449bd832023-01-11 14:50:10 +01005294 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005295}
5296
Gilles Peskine449bd832023-01-11 14:50:10 +01005297static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005298{
Gilles Peskine449bd832023-01-11 14:50:10 +01005299 if (operation->id == 0 || !operation->nonce_set) {
5300 return PSA_ERROR_BAD_STATE;
5301 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005302
Gilles Peskine449bd832023-01-11 14:50:10 +01005303 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5304 operation->body_remaining != 0)) {
5305 return PSA_ERROR_INVALID_ARGUMENT;
5306 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005307
Gilles Peskine449bd832023-01-11 14:50:10 +01005308 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005309}
5310
Paul Elliott302ff6b2021-04-20 18:10:30 +01005311/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005312psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
David Horstmann6db0e732023-12-11 15:35:59 +00005313 uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005314 size_t ciphertext_size,
5315 size_t *ciphertext_length,
David Horstmann6db0e732023-12-11 15:35:59 +00005316 uint8_t *tag_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005317 size_t tag_size,
5318 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005319{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005320 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5321
David Horstmann6db0e732023-12-11 15:35:59 +00005322 LOCAL_OUTPUT_DECLARE(ciphertext_external, ciphertext);
5323 LOCAL_OUTPUT_DECLARE(tag_external, tag);
5324
5325 LOCAL_OUTPUT_ALLOC(ciphertext_external, ciphertext_size, ciphertext);
5326 LOCAL_OUTPUT_ALLOC(tag_external, tag_size, tag);
5327
Paul Elliott302ff6b2021-04-20 18:10:30 +01005328 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005329 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005330
Gilles Peskine449bd832023-01-11 14:50:10 +01005331 status = psa_aead_final_checks(operation);
5332 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005333 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005334 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005335
Gilles Peskine449bd832023-01-11 14:50:10 +01005336 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005337 status = PSA_ERROR_BAD_STATE;
5338 goto exit;
5339 }
5340
Gilles Peskine449bd832023-01-11 14:50:10 +01005341 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5342 ciphertext_size,
5343 ciphertext_length,
5344 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005345
Paul Elliott39dc6b82021-05-11 19:16:09 +01005346exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005347
5348
Paul Elliottf47b0952021-05-21 18:02:33 +01005349 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005350 * the zero tag size, make sure the tag is set to something implausible.
5351 * Even if the operation succeeds, make sure we clear the rest of the
5352 * buffer to prevent potential leakage of anything previously placed in
5353 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005354 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005355
Gilles Peskine449bd832023-01-11 14:50:10 +01005356 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005357
David Horstmann6db0e732023-12-11 15:35:59 +00005358 LOCAL_OUTPUT_FREE(ciphertext_external, ciphertext);
5359 LOCAL_OUTPUT_FREE(tag_external, tag);
5360
Gilles Peskine449bd832023-01-11 14:50:10 +01005361 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005362}
5363
5364/* Finish authenticating and decrypting a message in a multipart AEAD
5365 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005366psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
David Horstmanne000a0a2023-12-11 16:37:04 +00005367 uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005368 size_t plaintext_size,
5369 size_t *plaintext_length,
David Horstmanne000a0a2023-12-11 16:37:04 +00005370 const uint8_t *tag_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005371 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005372{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005373 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5374
David Horstmanne000a0a2023-12-11 16:37:04 +00005375 LOCAL_OUTPUT_DECLARE(plaintext_external, plaintext);
5376 LOCAL_INPUT_DECLARE(tag_external, tag);
5377
5378 LOCAL_OUTPUT_ALLOC(plaintext_external, plaintext_size, plaintext);
5379 LOCAL_INPUT_ALLOC(tag_external, tag_length, tag);
5380
Paul Elliott302ff6b2021-04-20 18:10:30 +01005381 *plaintext_length = 0;
5382
Gilles Peskine449bd832023-01-11 14:50:10 +01005383 status = psa_aead_final_checks(operation);
5384 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005385 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005386 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005387
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 if (operation->is_encrypt) {
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 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5394 plaintext_size,
5395 plaintext_length,
5396 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005397
5398exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005399 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005400
David Horstmanne000a0a2023-12-11 16:37:04 +00005401 LOCAL_OUTPUT_FREE(plaintext_external, plaintext);
5402 LOCAL_INPUT_FREE(tag_external, tag);
5403
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005405}
5406
5407/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005408psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005409{
5410 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5411
Gilles Peskine449bd832023-01-11 14:50:10 +01005412 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005413 /* The object has (apparently) been initialized but it is not (yet)
5414 * in use. It's ok to call abort on such an object, and there's
5415 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005416 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005417 }
5418
Gilles Peskine449bd832023-01-11 14:50:10 +01005419 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005420
Gilles Peskine449bd832023-01-11 14:50:10 +01005421 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005422
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005424}
5425
Gilles Peskinee59236f2018-01-27 23:32:46 +01005426/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005427/* Generators */
5428/****************************************************************/
5429
Przemek Stekiel69c46792022-06-10 12:59:51 +02005430#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005431 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005432 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305433 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305434 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005435#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005436#endif /* At least one builtin KDF */
5437
Przemek Stekiel69c46792022-06-10 12:59:51 +02005438#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005439 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5440 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5441static psa_status_t psa_key_derivation_start_hmac(
5442 psa_mac_operation_t *operation,
5443 psa_algorithm_t hash_alg,
5444 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005445 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005446{
5447 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5448 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005449 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5450 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5451 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005452
Steven Cooreman72f736a2021-05-07 14:14:37 +02005453 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005454 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005455
Gilles Peskine449bd832023-01-11 14:50:10 +01005456 status = psa_driver_wrapper_mac_sign_setup(operation,
5457 &attributes,
5458 hmac_key, hmac_key_length,
5459 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005460
Gilles Peskine449bd832023-01-11 14:50:10 +01005461 psa_reset_key_attributes(&attributes);
5462 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005463}
5464#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005465
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005466#define HKDF_STATE_INIT 0 /* no input yet */
5467#define HKDF_STATE_STARTED 1 /* got salt */
5468#define HKDF_STATE_KEYED 2 /* got key */
5469#define HKDF_STATE_OUTPUT 3 /* output started */
5470
Gilles Peskinecbe66502019-05-16 16:59:18 +02005471static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005472 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005473{
Gilles Peskine449bd832023-01-11 14:50:10 +01005474 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5475 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5476 } else {
5477 return operation->alg;
5478 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005479}
5480
Gilles Peskine449bd832023-01-11 14:50:10 +01005481psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005482{
5483 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005484 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5485 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005486 /* The object has (apparently) been initialized but it is not
5487 * in use. It's ok to call abort on such an object, and there's
5488 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005489 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005490#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005491 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5492 mbedtls_free(operation->ctx.hkdf.info);
5493 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5494 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005495#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005496#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5497 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005498 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5499 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5500 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5501 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005502 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005503 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005504 }
5505
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005507 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005509 }
5510
Gilles Peskine449bd832023-01-11 14:50:10 +01005511 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005512 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005514 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005515#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005516 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005517 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005518 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005519 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005520#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005521 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005522
5523 /* We leave the fields Ai and output_block to be erased safely by the
5524 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005525 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005526#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5527 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005528#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005529 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5530 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5531 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5532 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005533#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305534#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305535 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305536 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005537 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305538 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305539 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305540
5541 status = PSA_SUCCESS;
5542 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305543#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005544 {
5545 status = PSA_ERROR_BAD_STATE;
5546 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005547 mbedtls_platform_zeroize(operation, sizeof(*operation));
5548 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005549}
5550
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005551psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005552 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005553{
Gilles Peskine449bd832023-01-11 14:50:10 +01005554 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005555 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005556 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005557 }
5558
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005559 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005560 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005561}
5562
Gilles Peskine449bd832023-01-11 14:50:10 +01005563psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5564 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005565{
Gilles Peskine449bd832023-01-11 14:50:10 +01005566 if (operation->alg == 0) {
5567 return PSA_ERROR_BAD_STATE;
5568 }
5569 if (capacity > operation->capacity) {
5570 return PSA_ERROR_INVALID_ARGUMENT;
5571 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005572 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005573 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005574}
5575
Przemek Stekiel69c46792022-06-10 12:59:51 +02005576#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005577/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005578static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5579 psa_algorithm_t kdf_alg,
5580 uint8_t *output,
5581 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005582{
Gilles Peskine449bd832023-01-11 14:50:10 +01005583 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5584 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005585 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005586 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005587#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005588 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005589#else
5590 const uint8_t last_block = 0xff;
5591#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005592
Gilles Peskine449bd832023-01-11 14:50:10 +01005593 if (hkdf->state < HKDF_STATE_KEYED ||
5594 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005595#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005596 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005597#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005598 )) {
5599 return PSA_ERROR_BAD_STATE;
5600 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005601 hkdf->state = HKDF_STATE_OUTPUT;
5602
Gilles Peskine449bd832023-01-11 14:50:10 +01005603 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005604 /* Copy what remains of the current block */
5605 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005606 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005607 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005608 }
5609 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005610 output += n;
5611 output_length -= n;
5612 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005613 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005614 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005615 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005616 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005617 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005618 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005619 * object was corrupted or if this function is called directly
5620 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005621 if (hkdf->block_number == last_block) {
5622 return PSA_ERROR_BAD_STATE;
5623 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005624
5625 /* We need a new block */
5626 ++hkdf->block_number;
5627 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005628
Gilles Peskine449bd832023-01-11 14:50:10 +01005629 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5630 hash_alg,
5631 hkdf->prk,
5632 hash_length);
5633 if (status != PSA_SUCCESS) {
5634 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005635 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005636
5637 if (hkdf->block_number != 1) {
5638 status = psa_mac_update(&hkdf->hmac,
5639 hkdf->output_block,
5640 hash_length);
5641 if (status != PSA_SUCCESS) {
5642 return status;
5643 }
5644 }
5645 status = psa_mac_update(&hkdf->hmac,
5646 hkdf->info,
5647 hkdf->info_length);
5648 if (status != PSA_SUCCESS) {
5649 return status;
5650 }
5651 status = psa_mac_update(&hkdf->hmac,
5652 &hkdf->block_number, 1);
5653 if (status != PSA_SUCCESS) {
5654 return status;
5655 }
5656 status = psa_mac_sign_finish(&hkdf->hmac,
5657 hkdf->output_block,
5658 sizeof(hkdf->output_block),
5659 &hmac_output_length);
5660 if (status != PSA_SUCCESS) {
5661 return status;
5662 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005663 }
5664
Gilles Peskine449bd832023-01-11 14:50:10 +01005665 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005666}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005667#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005668
John Durkop07cc04a2020-11-16 22:08:34 -08005669#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5670 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005671static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5672 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005673 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005674{
Gilles Peskine449bd832023-01-11 14:50:10 +01005675 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5676 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005677 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5678 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005679 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005680
Janos Follath7742fee2019-06-17 12:58:10 +01005681 /* We can't be wanting more output after block 0xff, otherwise
5682 * the capacity check in psa_key_derivation_output_bytes() would have
5683 * prevented this call. It could happen only if the operation
5684 * object was corrupted or if this function is called directly
5685 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005686 if (tls12_prf->block_number == 0xff) {
5687 return PSA_ERROR_CORRUPTION_DETECTED;
5688 }
Janos Follath7742fee2019-06-17 12:58:10 +01005689
5690 /* We need a new block */
5691 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005692 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005693
5694 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5695 *
5696 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5697 *
5698 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5699 * HMAC_hash(secret, A(2) + seed) +
5700 * HMAC_hash(secret, A(3) + seed) + ...
5701 *
5702 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005703 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005704 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005705 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005706 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005707 * is currently extracted as `output_block` and where i is
5708 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005709 */
5710
Gilles Peskine449bd832023-01-11 14:50:10 +01005711 status = psa_key_derivation_start_hmac(&hmac,
5712 hash_alg,
5713 tls12_prf->secret,
5714 tls12_prf->secret_length);
5715 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005716 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005717 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005718
5719 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005720 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005721 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5722 * the variable seed and in this instance means it in the context of the
5723 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005724 status = psa_mac_update(&hmac,
5725 tls12_prf->label,
5726 tls12_prf->label_length);
5727 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005728 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005729 }
5730 status = psa_mac_update(&hmac,
5731 tls12_prf->seed,
5732 tls12_prf->seed_length);
5733 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005734 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005735 }
5736 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005737 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005738 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5739 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005740 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005741 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005742 }
5743
Gilles Peskine449bd832023-01-11 14:50:10 +01005744 status = psa_mac_sign_finish(&hmac,
5745 tls12_prf->Ai, hash_length,
5746 &hmac_output_length);
5747 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005748 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005749 }
5750 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005751 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005752 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005753
5754 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005755 status = psa_key_derivation_start_hmac(&hmac,
5756 hash_alg,
5757 tls12_prf->secret,
5758 tls12_prf->secret_length);
5759 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005760 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005761 }
5762 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5763 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005764 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005765 }
5766 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5767 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005768 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005769 }
5770 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5771 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005772 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005773 }
5774 status = psa_mac_sign_finish(&hmac,
5775 tls12_prf->output_block, hash_length,
5776 &hmac_output_length);
5777 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005778 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005779 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005780
Janos Follath7742fee2019-06-17 12:58:10 +01005781
5782cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005783 cleanup_status = psa_mac_abort(&hmac);
5784 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005785 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005786 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005787
Gilles Peskine449bd832023-01-11 14:50:10 +01005788 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005789}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005790
Janos Follath844eb0e2019-06-19 12:10:49 +01005791static psa_status_t psa_key_derivation_tls12_prf_read(
5792 psa_tls12_prf_key_derivation_t *tls12_prf,
5793 psa_algorithm_t alg,
5794 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005795 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005796{
Gilles Peskine449bd832023-01-11 14:50:10 +01005797 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5798 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005799 psa_status_t status;
5800 uint8_t offset, length;
5801
Gilles Peskine449bd832023-01-11 14:50:10 +01005802 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005803 case PSA_TLS12_PRF_STATE_LABEL_SET:
5804 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5805 break;
5806 case PSA_TLS12_PRF_STATE_OUTPUT:
5807 break;
5808 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005809 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005810 }
5811
Gilles Peskine449bd832023-01-11 14:50:10 +01005812 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005813 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005814 if (tls12_prf->left_in_block == 0) {
5815 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5816 alg);
5817 if (status != PSA_SUCCESS) {
5818 return status;
5819 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005820
5821 continue;
5822 }
5823
Gilles Peskine449bd832023-01-11 14:50:10 +01005824 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005825 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005826 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005827 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005828 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005829
5830 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005831 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005832 output += length;
5833 output_length -= length;
5834 tls12_prf->left_in_block -= length;
5835 }
5836
Gilles Peskine449bd832023-01-11 14:50:10 +01005837 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005838}
John Durkop07cc04a2020-11-16 22:08:34 -08005839#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5840 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005841
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005842#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5843static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5844 psa_tls12_ecjpake_to_pms_t *ecjpake,
5845 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005847{
5848 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005849 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005850
Gilles Peskine449bd832023-01-11 14:50:10 +01005851 if (output_length != 32) {
5852 return PSA_ERROR_INVALID_ARGUMENT;
5853 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005854
Gilles Peskine449bd832023-01-11 14:50:10 +01005855 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5856 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5857 &output_size);
5858 if (status != PSA_SUCCESS) {
5859 return status;
5860 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005861
Gilles Peskine449bd832023-01-11 14:50:10 +01005862 if (output_size != output_length) {
5863 return PSA_ERROR_GENERIC_ERROR;
5864 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005865
Gilles Peskine449bd832023-01-11 14:50:10 +01005866 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005867}
5868#endif
5869
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305870#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305871static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5872 psa_pbkdf2_key_derivation_t *pbkdf2,
5873 psa_algorithm_t prf_alg,
5874 uint8_t prf_output_length,
5875 psa_key_attributes_t *attributes)
5876{
5877 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305878 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305879 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305880 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305881 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305882 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305883 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305884
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305885 mac_operation.is_sign = 1;
5886 mac_operation.mac_size = prf_output_length;
5887 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305888
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305889 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5890 attributes,
5891 pbkdf2->password,
5892 pbkdf2->password_length,
5893 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305894 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305895 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305896 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305897 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5898 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305899 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305900 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305901 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305902 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305903 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305904 }
5905 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5906 &mac_output_length);
5907 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305908 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305909 }
5910
5911 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305912 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305913 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305914 }
5915
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305916 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305917
5918 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305919 /* We are passing prf_output_length as mac_size because the driver
5920 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305921 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305922 status = psa_driver_wrapper_mac_compute(attributes,
5923 pbkdf2->password,
5924 pbkdf2->password_length,
5925 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305926 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305927 &mac_output_length);
5928 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305929 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305930 }
5931
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305932 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305933 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305934
5935cleanup:
5936 /* Zeroise buffers to clear sensitive data from memory. */
5937 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5938 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305939}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305940
5941static psa_status_t psa_key_derivation_pbkdf2_read(
5942 psa_pbkdf2_key_derivation_t *pbkdf2,
5943 psa_algorithm_t kdf_alg,
5944 uint8_t *output,
5945 size_t output_length)
5946{
5947 psa_status_t status;
5948 psa_algorithm_t prf_alg;
5949 uint8_t prf_output_length;
5950 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5951 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5952 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5953
5954 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5955 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5956 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5957 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305958 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5959 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305960 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305961 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305962 } else {
5963 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305964 }
5965
5966 switch (pbkdf2->state) {
5967 case PSA_PBKDF2_STATE_PASSWORD_SET:
5968 /* Initially we need a new block so bytes_used is equal to block size*/
5969 pbkdf2->bytes_used = prf_output_length;
5970 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5971 break;
5972 case PSA_PBKDF2_STATE_OUTPUT:
5973 break;
5974 default:
5975 return PSA_ERROR_BAD_STATE;
5976 }
5977
5978 while (output_length != 0) {
5979 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5980 if (n > output_length) {
5981 n = (uint8_t) output_length;
5982 }
5983 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5984 output += n;
5985 output_length -= n;
5986 pbkdf2->bytes_used += n;
5987
5988 if (output_length == 0) {
5989 break;
5990 }
5991
5992 /* We need a new block */
5993 pbkdf2->bytes_used = 0;
5994 pbkdf2->block_number++;
5995
5996 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5997 prf_output_length,
5998 &attributes);
5999 if (status != PSA_SUCCESS) {
6000 return status;
6001 }
6002 }
6003
6004 return PSA_SUCCESS;
6005}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306006#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306007
Janos Follath6c6c8fc2019-06-17 12:38:20 +01006008psa_status_t psa_key_derivation_output_bytes(
6009 psa_key_derivation_operation_t *operation,
Ryan Everettf943e222024-01-19 14:46:39 +00006010 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01006011 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006012{
6013 psa_status_t status;
Ryan Everettf943e222024-01-19 14:46:39 +00006014 LOCAL_OUTPUT_DECLARE(output_external, output);
6015
Gilles Peskine449bd832023-01-11 14:50:10 +01006016 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02006017
Gilles Peskine449bd832023-01-11 14:50:10 +01006018 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006019 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006020 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006021 }
6022
Gilles Peskine449bd832023-01-11 14:50:10 +01006023 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006024 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006025 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02006026 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
6027 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006028 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02006029 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006030 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006031 }
Ryan Everettf943e222024-01-19 14:46:39 +00006032
6033 LOCAL_OUTPUT_ALLOC(output_external, output_length, output);
Ryan Everettda9227d2024-01-25 11:37:22 +00006034 if (output_length > operation->capacity) {
6035 operation->capacity = 0;
6036 /* Go through the error path to wipe all confidential data now
6037 * that the operation object is useless. */
6038 status = PSA_ERROR_INSUFFICIENT_DATA;
6039 goto exit;
6040 }
6041
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006042 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006043
Przemek Stekiel69c46792022-06-10 12:59:51 +02006044#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006045 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6046 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
6047 output, output_length);
6048 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006049#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006050#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6051 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006052 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6053 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6054 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
6055 kdf_alg, output,
6056 output_length);
6057 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006058#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
6059 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006060#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006061 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006062 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01006063 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
6064 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006065#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306066#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306067 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05306068 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
6069 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05306070 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306071#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006072
Gilles Peskineeab56e42018-07-12 17:12:33 +02006073 {
Steven Cooreman74afe472021-02-10 17:19:22 +01006074 (void) kdf_alg;
Ryan Everettf943e222024-01-19 14:46:39 +00006075 status = PSA_ERROR_BAD_STATE;
6076 LOCAL_OUTPUT_FREE(output_external, output);
6077
6078 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006079 }
6080
6081exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006083 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006084 * This allows us to differentiate between exhausted operations and
6085 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
6086 * operations. */
6087 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006088 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006089 operation->alg = alg;
Ryan Everettee5920a2024-02-09 15:09:28 +00006090 if (output != NULL) {
6091 memset(output, '!', output_length);
6092 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006093 }
Ryan Everettda9227d2024-01-25 11:37:22 +00006094
6095 LOCAL_OUTPUT_FREE(output_external, output);
Gilles Peskine449bd832023-01-11 14:50:10 +01006096 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006097}
6098
David Brown7807bf72021-02-09 16:28:23 -07006099#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006100static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02006101{
Gilles Peskine449bd832023-01-11 14:50:10 +01006102 if (data_size >= 8) {
6103 mbedtls_des_key_set_parity(data);
6104 }
6105 if (data_size >= 16) {
6106 mbedtls_des_key_set_parity(data + 8);
6107 }
6108 if (data_size >= 24) {
6109 mbedtls_des_key_set_parity(data + 16);
6110 }
Gilles Peskine08542d82018-07-19 17:05:42 +02006111}
David Brown7807bf72021-02-09 16:28:23 -07006112#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02006113
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006114/*
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 * ECC keys on a Weierstrass elliptic curve require the generation
6116 * of a private key which is an integer
6117 * in the range [1, N - 1], where N is the boundary of the private key domain:
6118 * N is the prime p for Diffie-Hellman, or the order of the
6119 * curve’s base point for ECC.
6120 *
6121 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
6122 * This function generates the private key using the following process:
6123 *
6124 * 1. Draw a byte string of length ceiling(m/8) bytes.
6125 * 2. If m is not a multiple of 8, set the most significant
6126 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
6127 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
6128 * 4. If k > N - 2, discard the result and return to step 1.
6129 * 5. Output k + 1 as the private key.
6130 *
6131 * This method allows compliance to NIST standards, specifically the methods titled
6132 * Key-Pair Generation by Testing Candidates in the following publications:
6133 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
6134 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
6135 * Diffie-Hellman keys.
6136 *
6137 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
6138 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
6139 *
6140 * Note: Function allocates memory for *data buffer, so given *data should be
6141 * always NULL.
6142 */
Valerio Setti86587ab2023-06-27 13:09:30 +02006143#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
6144#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006145static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006146 psa_key_slot_t *slot,
6147 size_t bits,
6148 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006149 uint8_t **data
6150 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006151{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006152 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006153 mbedtls_mpi k;
6154 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006155 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006156 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006157 size_t m;
6158 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006159
Gilles Peskine449bd832023-01-11 14:50:10 +01006160 mbedtls_mpi_init(&k);
6161 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006162
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006163 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01006164 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006165 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01006166 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006167
Gilles Peskine449bd832023-01-11 14:50:10 +01006168 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006169 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01006170 goto cleanup;
6171 }
6172
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006173 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01006174 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006175
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006177
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006178 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006179 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006180 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006181
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006182 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006183
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006184 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006185 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006186
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006187 /* Note: This function is always called with *data == NULL and it
6188 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006189 *data = mbedtls_calloc(1, m_bytes);
6190 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006191 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006192 goto cleanup;
6193 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006194
Gilles Peskine449bd832023-01-11 14:50:10 +01006195 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006196 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006197 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006198 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01006199 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006200
6201 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006202 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006203 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006204 * (8 * ceiling(m/8) - m) bits of the first byte in
6205 * the string to zero.
6206 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006207 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006208 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006209 }
6210
6211 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01006212 * big-endian byte string.
6213 */
6214 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006215
6216 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01006217 * Result of comparison is returned. When it indicates error
6218 * then this function is called again.
6219 */
6220 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006221 }
6222
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006223 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006224 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6225 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006226cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006227 if (ret != 0) {
6228 status = mbedtls_to_psa_error(ret);
6229 }
6230 if (status != PSA_SUCCESS) {
6231 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006232 *data = NULL;
6233 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006234 mbedtls_mpi_free(&k);
6235 mbedtls_mpi_free(&diff_N_2);
6236 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006237}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006238
6239/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6240 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6241 *
6242 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6243 * draw a 32-byte string and process it as specified in
6244 * Elliptic Curves for Security [RFC7748] §5.
6245 *
6246 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6247 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6248 *
6249 * Note: Function allocates memory for *data buffer, so given *data should be
6250 * always NULL.
6251 */
6252
6253static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6254 size_t bits,
6255 psa_key_derivation_operation_t *operation,
6256 uint8_t **data
6257 )
6258{
6259 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006260 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006261
Gilles Peskine449bd832023-01-11 14:50:10 +01006262 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006263 case 255:
6264 output_length = 32;
6265 break;
6266 case 448:
6267 output_length = 56;
6268 break;
6269 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006270 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006271 break;
6272 }
6273
Gilles Peskine449bd832023-01-11 14:50:10 +01006274 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006275
Gilles Peskine449bd832023-01-11 14:50:10 +01006276 if (*data == NULL) {
6277 return PSA_ERROR_INSUFFICIENT_MEMORY;
6278 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006279
Gilles Peskine449bd832023-01-11 14:50:10 +01006280 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006281
Gilles Peskine449bd832023-01-11 14:50:10 +01006282 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006283 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006284 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006285
Gilles Peskine449bd832023-01-11 14:50:10 +01006286 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006287 case 255:
6288 (*data)[0] &= 248;
6289 (*data)[31] &= 127;
6290 (*data)[31] |= 64;
6291 break;
6292 case 448:
6293 (*data)[0] &= 252;
6294 (*data)[55] |= 128;
6295 break;
6296 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006297 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006298 break;
6299 }
6300
6301 return status;
6302}
Valerio Setti86587ab2023-06-27 13:09:30 +02006303#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6304static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6305 psa_key_slot_t *slot, size_t bits,
6306 psa_key_derivation_operation_t *operation, uint8_t **data)
6307{
6308 (void) slot;
6309 (void) bits;
6310 (void) operation;
6311 (void) data;
6312 return PSA_ERROR_NOT_SUPPORTED;
6313}
6314
6315static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6316 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6317{
6318 (void) bits;
6319 (void) operation;
6320 (void) data;
6321 return PSA_ERROR_NOT_SUPPORTED;
6322}
6323#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6324#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006325
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006326static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006327 psa_key_slot_t *slot,
6328 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006329 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006330{
6331 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006332 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306333 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006334 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006335
Gilles Peskine449bd832023-01-11 14:50:10 +01006336 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6337 return PSA_ERROR_INVALID_ARGUMENT;
6338 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006339
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006340#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006341 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006342 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6343 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6344 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006345 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006346 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6347 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006348 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006349 }
6350 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006351 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006352 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6353 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006354 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006355 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006356 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006357 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006358#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006359 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006360 if (key_type_is_raw_bytes(slot->attr.type)) {
6361 if (bits % 8 != 0) {
6362 return PSA_ERROR_INVALID_ARGUMENT;
6363 }
6364 data = mbedtls_calloc(1, bytes);
6365 if (data == NULL) {
6366 return PSA_ERROR_INSUFFICIENT_MEMORY;
6367 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006368
Gilles Peskine449bd832023-01-11 14:50:10 +01006369 status = psa_key_derivation_output_bytes(operation, data, bytes);
6370 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006371 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006372 }
David Brown12ca5032021-02-11 11:02:00 -07006373#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006374 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6375 psa_des_set_key_parity(data, bytes);
6376 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006377#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006378 } else {
6379 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006380 }
Ronald Crondd04d422020-11-28 15:14:42 +01006381
Ronald Cronbf33c932020-11-28 18:06:53 +01006382 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006383
Gilles Peskine2f107ae2024-02-28 01:26:46 +01006384 if (psa_key_lifetime_is_external(slot->attr.lifetime)) {
Gilles Peskine7a5d9202024-02-28 01:18:23 +01006385 status = psa_driver_wrapper_get_key_buffer_size(&slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01006386 &storage_size);
6387 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306388 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006389 }
Archanad8a83dc2021-06-14 10:04:16 +05306390 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006391 status = psa_allocate_buffer_to_slot(slot, storage_size);
6392 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306393 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006394 }
Archanad8a83dc2021-06-14 10:04:16 +05306395
Gilles Peskine7a5d9202024-02-28 01:18:23 +01006396 status = psa_driver_wrapper_import_key(&slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01006397 data, bytes,
6398 slot->key.data,
6399 slot->key.bytes,
6400 &slot->key.bytes, &bits);
6401 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006402 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006403 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006404
6405exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006406 mbedtls_free(data);
6407 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006408}
6409
Gilles Peskine092ce512024-02-20 12:31:24 +01006410static const psa_key_production_parameters_t default_production_parameters =
6411 PSA_KEY_PRODUCTION_PARAMETERS_INIT;
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006412
Gilles Peskine092ce512024-02-20 12:31:24 +01006413int psa_key_production_parameters_are_default(
6414 const psa_key_production_parameters_t *params,
6415 size_t params_data_length)
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006416{
Gilles Peskine092ce512024-02-20 12:31:24 +01006417 if (params->flags != 0) {
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006418 return 0;
6419 }
Gilles Peskine092ce512024-02-20 12:31:24 +01006420 if (params_data_length != 0) {
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006421 return 0;
6422 }
6423 return 1;
6424}
6425
6426psa_status_t psa_key_derivation_output_key_ext(
6427 const psa_key_attributes_t *attributes,
6428 psa_key_derivation_operation_t *operation,
Gilles Peskine092ce512024-02-20 12:31:24 +01006429 const psa_key_production_parameters_t *params,
6430 size_t params_data_length,
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006431 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006432{
6433 psa_status_t status;
6434 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006435 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006436
Ronald Cron81709fc2020-11-14 12:10:32 +01006437 *key = MBEDTLS_SVC_KEY_ID_INIT;
6438
Gilles Peskine0f84d622019-09-12 19:03:13 +02006439 /* Reject any attempt to create a zero-length key so that we don't
6440 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006441 if (psa_get_key_bits(attributes) == 0) {
6442 return PSA_ERROR_INVALID_ARGUMENT;
6443 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006444
Gilles Peskine092ce512024-02-20 12:31:24 +01006445 if (!psa_key_production_parameters_are_default(params, params_data_length)) {
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006446 return PSA_ERROR_INVALID_ARGUMENT;
6447 }
6448
Gilles Peskine449bd832023-01-11 14:50:10 +01006449 if (operation->alg == PSA_ALG_NONE) {
6450 return PSA_ERROR_BAD_STATE;
6451 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006452
Gilles Peskine449bd832023-01-11 14:50:10 +01006453 if (!operation->can_output_key) {
6454 return PSA_ERROR_NOT_PERMITTED;
6455 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006456
Gilles Peskine449bd832023-01-11 14:50:10 +01006457 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6458 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006459#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006460 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006461 /* Deriving a key in a secure element is not implemented yet. */
6462 status = PSA_ERROR_NOT_SUPPORTED;
6463 }
6464#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006465 if (status == PSA_SUCCESS) {
6466 status = psa_generate_derived_key_internal(slot,
Gilles Peskine2f107ae2024-02-28 01:26:46 +01006467 attributes->bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006468 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006469 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006470 if (status == PSA_SUCCESS) {
6471 status = psa_finish_key_creation(slot, driver, key);
6472 }
6473 if (status != PSA_SUCCESS) {
6474 psa_fail_key_creation(slot, driver);
6475 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006476
Gilles Peskine449bd832023-01-11 14:50:10 +01006477 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006478}
6479
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006480psa_status_t psa_key_derivation_output_key(
6481 const psa_key_attributes_t *attributes,
6482 psa_key_derivation_operation_t *operation,
6483 mbedtls_svc_key_id_t *key)
6484{
Gilles Peskinec81393b2024-02-14 20:51:28 +01006485 return psa_key_derivation_output_key_ext(attributes, operation,
Gilles Peskine092ce512024-02-20 12:31:24 +01006486 &default_production_parameters, 0,
Gilles Peskinec81393b2024-02-14 20:51:28 +01006487 key);
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006488}
Gilles Peskineeab56e42018-07-12 17:12:33 +02006489
6490
6491/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006492/* Key derivation */
6493/****************************************************************/
6494
Steven Cooreman932ffb72021-02-15 12:14:32 +01006495#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006496static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006497{
6498#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006499 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6500 return 1;
6501 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006502#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006503#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006504 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6505 return 1;
6506 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006507#endif
6508#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006509 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6510 return 1;
6511 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006512#endif
6513#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006514 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6515 return 1;
6516 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006517#endif
6518#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006519 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6520 return 1;
6521 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006522#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006523#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006524 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6525 return 1;
6526 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006527#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306528#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6529 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6530 return 1;
6531 }
6532#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306533#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6534 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6535 return 1;
6536 }
6537#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006538 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006539}
6540
Gilles Peskine449bd832023-01-11 14:50:10 +01006541static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006542{
6543 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006544 psa_status_t status = psa_hash_setup(&operation, alg);
6545 psa_hash_abort(&operation);
6546 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006547}
6548
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306549static psa_status_t psa_key_derivation_set_maximum_capacity(
6550 psa_key_derivation_operation_t *operation,
6551 psa_algorithm_t kdf_alg)
6552{
6553#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6554 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6555 operation->capacity = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6556 return PSA_SUCCESS;
6557 }
6558#endif
6559#if defined(PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128)
6560 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6561#if (SIZE_MAX > UINT32_MAX)
Kusumit Ghoderao7d4db632023-12-07 16:17:46 +05306562 operation->capacity = UINT32_MAX * (size_t) PSA_MAC_LENGTH(
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306563 PSA_KEY_TYPE_AES,
6564 128U,
6565 PSA_ALG_CMAC);
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306566#else
6567 operation->capacity = SIZE_MAX;
6568#endif
6569 return PSA_SUCCESS;
6570 }
6571#endif /* PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128 */
6572
6573 /* After this point, if kdf_alg is not valid then value of hash_alg may be
6574 * invalid or meaningless but it does not affect this function */
6575 psa_algorithm_t hash_alg = PSA_ALG_GET_HASH(kdf_alg);
6576 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306577 if (hash_size == 0) {
6578 return PSA_ERROR_NOT_SUPPORTED;
6579 }
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306580
6581 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6582 * we might fail later, which is somewhat unfriendly and potentially
6583 * risk-prone. */
6584 psa_status_t status = psa_hash_try_support(hash_alg);
6585 if (status != PSA_SUCCESS) {
6586 return status;
6587 }
6588
6589#if defined(PSA_WANT_ALG_HKDF)
6590 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6591 operation->capacity = 255 * hash_size;
6592 } else
6593#endif
6594#if defined(PSA_WANT_ALG_HKDF_EXTRACT)
6595 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6596 operation->capacity = hash_size;
6597 } else
6598#endif
6599#if defined(PSA_WANT_ALG_HKDF_EXPAND)
6600 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6601 operation->capacity = 255 * hash_size;
6602 } else
6603#endif
6604#if defined(PSA_WANT_ALG_TLS12_PRF)
6605 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) &&
6606 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6607 operation->capacity = SIZE_MAX;
6608 } else
6609#endif
6610#if defined(PSA_WANT_ALG_TLS12_PSK_TO_MS)
6611 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg) &&
6612 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6613 /* Master Secret is always 48 bytes
6614 * https://datatracker.ietf.org/doc/html/rfc5246.html#section-8.1 */
6615 operation->capacity = 48U;
6616 } else
6617#endif
6618#if defined(PSA_WANT_ALG_PBKDF2_HMAC)
6619 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6620#if (SIZE_MAX > UINT32_MAX)
6621 operation->capacity = UINT32_MAX * hash_size;
6622#else
6623 operation->capacity = SIZE_MAX;
6624#endif
6625 } else
6626#endif /* PSA_WANT_ALG_PBKDF2_HMAC */
6627 {
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306628 (void) hash_size;
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306629 status = PSA_ERROR_NOT_SUPPORTED;
6630 }
6631 return status;
6632}
6633
Gilles Peskine969c5d62019-01-16 15:53:06 +01006634static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006635 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006636 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006637{
Janos Follath5fe19732019-06-20 15:09:30 +01006638 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6639 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006640 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006641
Gilles Peskine969c5d62019-01-16 15:53:06 +01006642 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006643 if (!is_kdf_alg_supported(kdf_alg)) {
6644 return PSA_ERROR_NOT_SUPPORTED;
6645 }
John Durkop07cc04a2020-11-16 22:08:34 -08006646
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306647 psa_status_t status = psa_key_derivation_set_maximum_capacity(operation,
6648 kdf_alg);
Kusumit Ghoderao5f3a9382023-09-13 16:28:12 +05306649 return status;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006650}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006651
Gilles Peskine449bd832023-01-11 14:50:10 +01006652static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006653{
6654#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006655 if (alg == PSA_ALG_ECDH) {
6656 return PSA_SUCCESS;
6657 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006658#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006659#if defined(PSA_WANT_ALG_FFDH)
6660 if (alg == PSA_ALG_FFDH) {
6661 return PSA_SUCCESS;
6662 }
6663#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006664 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006665 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006666}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006667
6668static int psa_key_derivation_allows_free_form_secret_input(
6669 psa_algorithm_t kdf_alg)
6670{
6671#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6672 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6673 return 0;
6674 }
6675#endif
6676 (void) kdf_alg;
6677 return 1;
6678}
John Durkop07cc04a2020-11-16 22:08:34 -08006679#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006680
Gilles Peskine449bd832023-01-11 14:50:10 +01006681psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6682 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006683{
6684 psa_status_t status;
6685
Gilles Peskine449bd832023-01-11 14:50:10 +01006686 if (operation->alg != 0) {
6687 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006688 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006689
Gilles Peskine449bd832023-01-11 14:50:10 +01006690 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6691 return PSA_ERROR_INVALID_ARGUMENT;
6692 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6693#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6694 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6695 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6696 status = psa_key_agreement_try_support(ka_alg);
6697 if (status != PSA_SUCCESS) {
6698 return status;
6699 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006700 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6701 return PSA_ERROR_INVALID_ARGUMENT;
6702 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006703 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6704#else
6705 return PSA_ERROR_NOT_SUPPORTED;
6706#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6707 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6708#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6709 status = psa_key_derivation_setup_kdf(operation, alg);
6710#else
6711 return PSA_ERROR_NOT_SUPPORTED;
6712#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6713 } else {
6714 return PSA_ERROR_INVALID_ARGUMENT;
6715 }
6716
6717 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006718 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006719 }
6720 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006721}
6722
Przemek Stekiel69c46792022-06-10 12:59:51 +02006723#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006724static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6725 psa_algorithm_t kdf_alg,
6726 psa_key_derivation_step_t step,
6727 const uint8_t *data,
6728 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006729{
Gilles Peskine449bd832023-01-11 14:50:10 +01006730 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006731 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006732 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006733 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006734#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006735 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6736 return PSA_ERROR_INVALID_ARGUMENT;
6737 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006738#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006739 if (hkdf->state != HKDF_STATE_INIT) {
6740 return PSA_ERROR_BAD_STATE;
6741 } else {
6742 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6743 hash_alg,
6744 data, data_length);
6745 if (status != PSA_SUCCESS) {
6746 return status;
6747 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006748 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006749 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006750 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006751 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006752#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006753 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006754 /* We shouldn't be in different state as HKDF_EXPAND only allows
6755 * two inputs: SECRET (this case) and INFO which does not modify
6756 * the state. It could happen only if the hkdf
6757 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006758 if (hkdf->state != HKDF_STATE_INIT) {
6759 return PSA_ERROR_BAD_STATE;
6760 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006761
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006762 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006763 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6764 return PSA_ERROR_INVALID_ARGUMENT;
6765 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006766
Gilles Peskine449bd832023-01-11 14:50:10 +01006767 memcpy(hkdf->prk, data, data_length);
6768 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006769#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006770 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006771 /* HKDF: If no salt was provided, use an empty salt.
6772 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006773 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006774#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006775 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6776 return PSA_ERROR_BAD_STATE;
6777 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006778#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006779 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6780 hash_alg,
6781 NULL, 0);
6782 if (status != PSA_SUCCESS) {
6783 return status;
6784 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006785 hkdf->state = HKDF_STATE_STARTED;
6786 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006787 if (hkdf->state != HKDF_STATE_STARTED) {
6788 return PSA_ERROR_BAD_STATE;
6789 }
6790 status = psa_mac_update(&hkdf->hmac,
6791 data, data_length);
6792 if (status != PSA_SUCCESS) {
6793 return status;
6794 }
6795 status = psa_mac_sign_finish(&hkdf->hmac,
6796 hkdf->prk,
6797 sizeof(hkdf->prk),
6798 &data_length);
6799 if (status != PSA_SUCCESS) {
6800 return status;
6801 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006802 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006803
Gilles Peskine2b522db2019-04-12 15:11:49 +02006804 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006805 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006806#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006807 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006808 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006809 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006810 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006811 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006812#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006813 {
6814 /* Block 0 is empty, and the next block will be
6815 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006816 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006817 }
6818
Gilles Peskine449bd832023-01-11 14:50:10 +01006819 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006820 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006821#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006822 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6823 return PSA_ERROR_INVALID_ARGUMENT;
6824 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006825#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006826#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006827 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6828 hkdf->state == HKDF_STATE_INIT) {
6829 return PSA_ERROR_BAD_STATE;
6830 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006831#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006832 if (hkdf->state == HKDF_STATE_OUTPUT) {
6833 return PSA_ERROR_BAD_STATE;
6834 }
6835 if (hkdf->info_set) {
6836 return PSA_ERROR_BAD_STATE;
6837 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006838 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006839 if (data_length != 0) {
6840 hkdf->info = mbedtls_calloc(1, data_length);
6841 if (hkdf->info == NULL) {
6842 return PSA_ERROR_INSUFFICIENT_MEMORY;
6843 }
6844 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006845 }
6846 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006847 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006848 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006849 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006850 }
6851}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006852#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006853
John Durkop07cc04a2020-11-16 22:08:34 -08006854#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6855 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006856static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6857 const uint8_t *data,
6858 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006859{
Gilles Peskine449bd832023-01-11 14:50:10 +01006860 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6861 return PSA_ERROR_BAD_STATE;
6862 }
Janos Follathf08e2652019-06-13 09:05:41 +01006863
Gilles Peskine449bd832023-01-11 14:50:10 +01006864 if (data_length != 0) {
6865 prf->seed = mbedtls_calloc(1, data_length);
6866 if (prf->seed == NULL) {
6867 return PSA_ERROR_INSUFFICIENT_MEMORY;
6868 }
Janos Follathf08e2652019-06-13 09:05:41 +01006869
Gilles Peskine449bd832023-01-11 14:50:10 +01006870 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006871 prf->seed_length = data_length;
6872 }
Janos Follathf08e2652019-06-13 09:05:41 +01006873
Gilles Peskine43f958b2020-12-13 14:55:14 +01006874 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006875
Gilles Peskine449bd832023-01-11 14:50:10 +01006876 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006877}
6878
Gilles Peskine449bd832023-01-11 14:50:10 +01006879static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6880 const uint8_t *data,
6881 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006882{
Gilles Peskine449bd832023-01-11 14:50:10 +01006883 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6884 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6885 return PSA_ERROR_BAD_STATE;
6886 }
Janos Follath81550542019-06-13 14:26:34 +01006887
Gilles Peskine449bd832023-01-11 14:50:10 +01006888 if (data_length != 0) {
6889 prf->secret = mbedtls_calloc(1, data_length);
6890 if (prf->secret == NULL) {
6891 return PSA_ERROR_INSUFFICIENT_MEMORY;
6892 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006893
Gilles Peskine449bd832023-01-11 14:50:10 +01006894 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006895 prf->secret_length = data_length;
6896 }
Janos Follath81550542019-06-13 14:26:34 +01006897
Gilles Peskine43f958b2020-12-13 14:55:14 +01006898 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006899
Gilles Peskine449bd832023-01-11 14:50:10 +01006900 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006901}
6902
Gilles Peskine449bd832023-01-11 14:50:10 +01006903static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6904 const uint8_t *data,
6905 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006906{
Gilles Peskine449bd832023-01-11 14:50:10 +01006907 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6908 return PSA_ERROR_BAD_STATE;
6909 }
Janos Follath63028dd2019-06-13 09:15:47 +01006910
Gilles Peskine449bd832023-01-11 14:50:10 +01006911 if (data_length != 0) {
6912 prf->label = mbedtls_calloc(1, data_length);
6913 if (prf->label == NULL) {
6914 return PSA_ERROR_INSUFFICIENT_MEMORY;
6915 }
Janos Follath63028dd2019-06-13 09:15:47 +01006916
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006918 prf->label_length = data_length;
6919 }
Janos Follath63028dd2019-06-13 09:15:47 +01006920
Gilles Peskine43f958b2020-12-13 14:55:14 +01006921 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006922
Gilles Peskine449bd832023-01-11 14:50:10 +01006923 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006924}
6925
Gilles Peskine449bd832023-01-11 14:50:10 +01006926static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6927 psa_key_derivation_step_t step,
6928 const uint8_t *data,
6929 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006930{
Gilles Peskine449bd832023-01-11 14:50:10 +01006931 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006932 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006933 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006934 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006935 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006936 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006937 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006938 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006939 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006940 }
6941}
John Durkop07cc04a2020-11-16 22:08:34 -08006942#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6943 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6944
6945#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6946static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6947 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006948 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006949 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006950{
6951 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006952 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6953 4 + data_length + prf->other_secret_length :
6954 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006955
Gilles Peskine449bd832023-01-11 14:50:10 +01006956 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6957 return PSA_ERROR_INVALID_ARGUMENT;
6958 }
John Durkop07cc04a2020-11-16 22:08:34 -08006959
Gilles Peskine449bd832023-01-11 14:50:10 +01006960 uint8_t *pms = mbedtls_calloc(1, pms_len);
6961 if (pms == NULL) {
6962 return PSA_ERROR_INSUFFICIENT_MEMORY;
6963 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006964 uint8_t *cur = pms;
6965
6966 /* pure-PSK:
6967 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006968 *
6969 * The premaster secret is formed as follows: if the PSK is N octets
6970 * long, concatenate a uint16 with the value N, N zero octets, a second
6971 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006972 *
6973 * mixed-PSK:
6974 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6975 * follows: concatenate a uint16 with the length of the other secret,
6976 * the other secret itself, uint16 with the length of PSK, and the
6977 * PSK itself.
6978 * For details please check:
6979 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6980 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6981 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006982 */
6983
Gilles Peskine449bd832023-01-11 14:50:10 +01006984 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6985 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6986 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6987 if (prf->other_secret_length != 0) {
6988 memcpy(cur, prf->other_secret, prf->other_secret_length);
6989 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006990 cur += prf->other_secret_length;
6991 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006992 } else {
6993 *cur++ = MBEDTLS_BYTE_1(data_length);
6994 *cur++ = MBEDTLS_BYTE_0(data_length);
6995 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006996 cur += data_length;
6997 }
6998
Gilles Peskine449bd832023-01-11 14:50:10 +01006999 *cur++ = MBEDTLS_BYTE_1(data_length);
7000 *cur++ = MBEDTLS_BYTE_0(data_length);
7001 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08007002 cur += data_length;
7003
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007004 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08007005
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01007006 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01007007 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08007008}
Janos Follath6660f0e2019-06-17 08:44:03 +01007009
Przemek Stekiele47201b2022-04-19 13:53:28 +02007010static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
7011 psa_tls12_prf_key_derivation_t *prf,
7012 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007013 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02007014{
Gilles Peskine449bd832023-01-11 14:50:10 +01007015 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
7016 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02007017 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007018
7019 if (data_length != 0) {
7020 prf->other_secret = mbedtls_calloc(1, data_length);
7021 if (prf->other_secret == NULL) {
7022 return PSA_ERROR_INSUFFICIENT_MEMORY;
7023 }
7024
7025 memcpy(prf->other_secret, data, data_length);
7026 prf->other_secret_length = data_length;
7027 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02007028 prf->other_secret_length = 0;
7029 }
7030
7031 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
7032
Gilles Peskine449bd832023-01-11 14:50:10 +01007033 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02007034}
7035
Janos Follath6660f0e2019-06-17 08:44:03 +01007036static psa_status_t psa_tls12_prf_psk_to_ms_input(
7037 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01007038 psa_key_derivation_step_t step,
7039 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007040 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01007041{
Gilles Peskine449bd832023-01-11 14:50:10 +01007042 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02007043 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007044 return psa_tls12_prf_psk_to_ms_set_key(prf,
7045 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02007046 break;
7047 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007048 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
7049 data,
7050 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02007051 break;
7052 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007053 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02007054 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01007055
Przemek Stekiele47201b2022-04-19 13:53:28 +02007056 }
Janos Follath6660f0e2019-06-17 08:44:03 +01007057}
John Durkop07cc04a2020-11-16 22:08:34 -08007058#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007059
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007060#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
7061static psa_status_t psa_tls12_ecjpake_to_pms_input(
7062 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04007063 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007064 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007065 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007066{
Gilles Peskine449bd832023-01-11 14:50:10 +01007067 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
7068 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
7069 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04007070 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007071
7072 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01007073 if (data[0] != 0x04) {
7074 return PSA_ERROR_INVALID_ARGUMENT;
7075 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007076
7077 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007078 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007079
Gilles Peskine449bd832023-01-11 14:50:10 +01007080 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007081}
7082#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307083
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307084#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307085static psa_status_t psa_pbkdf2_set_input_cost(
7086 psa_pbkdf2_key_derivation_t *pbkdf2,
7087 psa_key_derivation_step_t step,
7088 uint64_t data)
7089{
7090 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
7091 return PSA_ERROR_INVALID_ARGUMENT;
7092 }
7093
7094 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
7095 return PSA_ERROR_BAD_STATE;
7096 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307097
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05307098 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307099 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307100 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307101
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307102 if (data == 0) {
7103 return PSA_ERROR_INVALID_ARGUMENT;
7104 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05307105
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307106 pbkdf2->input_cost = data;
7107 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
7108
7109 return PSA_SUCCESS;
7110}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307111
7112static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
7113 const uint8_t *data,
7114 size_t data_length)
7115{
Gilles Peskineead17662023-08-20 22:02:51 +02007116 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
7117 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
7118 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
7119 /* Appending to existing salt. No state change. */
7120 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307121 return PSA_ERROR_BAD_STATE;
7122 }
7123
Gilles Peskineca57d782023-07-20 19:08:06 +02007124 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02007125 /* Appending an empty string, nothing to do. */
7126 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307127 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05307128
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307129 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
7130 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05307131 return PSA_ERROR_INSUFFICIENT_MEMORY;
7132 }
7133
Gilles Peskineead17662023-08-20 22:02:51 +02007134 if (pbkdf2->salt_length != 0) {
7135 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
7136 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307137 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05307138 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307139 mbedtls_free(pbkdf2->salt);
7140 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307141 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307142 return PSA_SUCCESS;
7143}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307144
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307145#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307146static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307147 const uint8_t *input,
7148 size_t input_len,
7149 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05307150 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307151{
7152 psa_status_t status = PSA_SUCCESS;
7153 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
Ryan Everett5d2e82f2024-02-07 17:24:59 +00007154 return psa_hash_compute(hash_alg, input, input_len, output,
7155 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
7156 } else if (input_len > 0) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307157 memcpy(output, input, input_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307158 }
Ryan Everett5d2e82f2024-02-07 17:24:59 +00007159 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307160 return status;
7161}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307162#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307163
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307164#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307165static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
7166 size_t input_len,
7167 uint8_t *output,
7168 size_t *output_len)
7169{
7170 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307171 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307172 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05307173 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307174 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
7175 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
7176 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307177 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05307178 * mac_size as the driver function sets mac_output_length = mac_size
7179 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307180 status = psa_driver_wrapper_mac_compute(&attributes,
7181 zeros, sizeof(zeros),
7182 PSA_ALG_CMAC, input, input_len,
7183 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307184 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
7185 128U,
7186 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307187 output_len);
7188 } else {
7189 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307190 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307191 }
7192 return status;
7193}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307194#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307195
7196static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307197 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307198 const uint8_t *data,
7199 size_t data_length)
7200{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307201 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307202 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
7203 return PSA_ERROR_BAD_STATE;
7204 }
7205
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307206#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307207 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
7208 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
7209 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
7210 pbkdf2->password,
7211 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307212 } else
7213#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
7214#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
7215 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307216 status = psa_pbkdf2_cmac_set_password(data, data_length,
7217 pbkdf2->password,
7218 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307219 } else
7220#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
7221 {
7222 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307223 }
7224
7225 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
7226
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307227 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307228}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307229
7230static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307231 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307232 psa_key_derivation_step_t step,
7233 const uint8_t *data,
7234 size_t data_length)
7235{
7236 switch (step) {
7237 case PSA_KEY_DERIVATION_INPUT_SALT:
7238 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
7239 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307240 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307241 default:
7242 return PSA_ERROR_INVALID_ARGUMENT;
7243 }
7244}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307245#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307246
Gilles Peskineb8965192019-09-24 16:21:10 +02007247/** Check whether the given key type is acceptable for the given
7248 * input step of a key derivation.
7249 *
7250 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
7251 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
7252 * Both secret and non-secret inputs can alternatively have the type
7253 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
7254 * that the input was passed as a buffer rather than via a key object.
7255 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02007256static int psa_key_derivation_check_input_type(
7257 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007258 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02007259{
Gilles Peskine449bd832023-01-11 14:50:10 +01007260 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007261 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007262 if (key_type == PSA_KEY_TYPE_DERIVE) {
7263 return PSA_SUCCESS;
7264 }
7265 if (key_type == PSA_KEY_TYPE_NONE) {
7266 return PSA_SUCCESS;
7267 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007268 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02007269 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007270 if (key_type == PSA_KEY_TYPE_DERIVE) {
7271 return PSA_SUCCESS;
7272 }
7273 if (key_type == PSA_KEY_TYPE_NONE) {
7274 return PSA_SUCCESS;
7275 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02007276 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007277 case PSA_KEY_DERIVATION_INPUT_LABEL:
7278 case PSA_KEY_DERIVATION_INPUT_SALT:
7279 case PSA_KEY_DERIVATION_INPUT_INFO:
7280 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01007281 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
7282 return PSA_SUCCESS;
7283 }
7284 if (key_type == PSA_KEY_TYPE_NONE) {
7285 return PSA_SUCCESS;
7286 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007287 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307288 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
7289 if (key_type == PSA_KEY_TYPE_PASSWORD) {
7290 return PSA_SUCCESS;
7291 }
7292 if (key_type == PSA_KEY_TYPE_DERIVE) {
7293 return PSA_SUCCESS;
7294 }
7295 if (key_type == PSA_KEY_TYPE_NONE) {
7296 return PSA_SUCCESS;
7297 }
7298 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007299 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007300 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007301}
7302
Janos Follathb80a94e2019-06-12 15:54:46 +01007303static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007304 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007305 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007306 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007307 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007308 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007309{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007310 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007311 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007312
Gilles Peskine449bd832023-01-11 14:50:10 +01007313 status = psa_key_derivation_check_input_type(step, key_type);
7314 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007315 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007316 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007317
Przemek Stekiel69c46792022-06-10 12:59:51 +02007318#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007319 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7320 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7321 step, data, data_length);
7322 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007323#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007324#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007325 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7326 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7327 step, data, data_length);
7328 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007329#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7330#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007331 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7332 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7333 step, data, data_length);
7334 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007335#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007336#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007337 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007338 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007339 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7340 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007341#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307342#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307343 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307344 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7345 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307346 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307347#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007348 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007349 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007350 (void) data;
7351 (void) data_length;
7352 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007353 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007354 }
7355
Gilles Peskine224b0d62019-09-23 18:13:17 +02007356exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007357 if (status != PSA_SUCCESS) {
7358 psa_key_derivation_abort(operation);
7359 }
7360 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007361}
7362
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307363static psa_status_t psa_key_derivation_input_integer_internal(
7364 psa_key_derivation_operation_t *operation,
7365 psa_key_derivation_step_t step,
7366 uint64_t value)
7367{
7368 psa_status_t status;
7369 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7370
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307371#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307372 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307373 status = psa_pbkdf2_set_input_cost(
7374 &operation->ctx.pbkdf2, step, value);
7375 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307376#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307377 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307378 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307379 (void) value;
7380 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307381 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307382 }
7383
7384 if (status != PSA_SUCCESS) {
7385 psa_key_derivation_abort(operation);
7386 }
7387 return status;
7388}
7389
Janos Follath51f4a0f2019-06-14 11:35:55 +01007390psa_status_t psa_key_derivation_input_bytes(
7391 psa_key_derivation_operation_t *operation,
7392 psa_key_derivation_step_t step,
Ryan Everettd1e398c2024-01-19 14:46:00 +00007393 const uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007394 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007395{
Ryan Everettd1e398c2024-01-19 14:46:00 +00007396 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7397 LOCAL_INPUT_DECLARE(data_external, data);
7398
7399 LOCAL_INPUT_ALLOC(data_external, data_length, data);
7400
7401 status = psa_key_derivation_input_internal(operation, step,
7402 PSA_KEY_TYPE_NONE,
7403 data, data_length);
David Horstmann4a48bec2024-03-13 15:42:31 +00007404#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Ryan Everettd1e398c2024-01-19 14:46:00 +00007405exit:
Ryan Everettb41c3c92024-01-25 11:56:35 +00007406#endif
Ryan Everettd1e398c2024-01-19 14:46:00 +00007407 LOCAL_INPUT_FREE(data_external, data);
7408 return status;
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007409}
7410
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307411psa_status_t psa_key_derivation_input_integer(
7412 psa_key_derivation_operation_t *operation,
7413 psa_key_derivation_step_t step,
7414 uint64_t value)
7415{
7416 return psa_key_derivation_input_integer_internal(operation, step, value);
7417}
7418
Janos Follath51f4a0f2019-06-14 11:35:55 +01007419psa_status_t psa_key_derivation_input_key(
7420 psa_key_derivation_operation_t *operation,
7421 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007422 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007423{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007424 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007425 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007426 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007427
Ronald Cron5c522922020-11-14 16:35:34 +01007428 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007429 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7430 if (status != PSA_SUCCESS) {
7431 psa_key_derivation_abort(operation);
7432 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007433 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007434
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307435 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7436 * permission to output to a key object. */
7437 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7438 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007439 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007441
Gilles Peskine449bd832023-01-11 14:50:10 +01007442 status = psa_key_derivation_input_internal(operation,
7443 step, slot->attr.type,
7444 slot->key.data,
7445 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007446
Ryan Everett5ac6fa72024-02-14 17:11:36 +00007447 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007448
Gilles Peskine449bd832023-01-11 14:50:10 +01007449 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007450}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007451
7452
7453
7454/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007455/* Key agreement */
7456/****************************************************************/
7457
Gilles Peskine449bd832023-01-11 14:50:10 +01007458psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7459 const uint8_t *key_buffer,
7460 size_t key_buffer_size,
7461 psa_algorithm_t alg,
7462 const uint8_t *peer_key,
7463 size_t peer_key_length,
7464 uint8_t *shared_secret,
7465 size_t shared_secret_size,
7466 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007467{
Gilles Peskine449bd832023-01-11 14:50:10 +01007468 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007469#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007470 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007471 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7472 key_buffer_size, alg,
7473 peer_key, peer_key_length,
7474 shared_secret,
7475 shared_secret_size,
7476 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007477#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007478
7479#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7480 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007481 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007482 peer_key,
7483 peer_key_length,
7484 key_buffer,
7485 key_buffer_size,
7486 shared_secret,
7487 shared_secret_size,
7488 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007489#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7490
Gilles Peskine01d718c2018-09-18 12:01:02 +02007491 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007492 (void) attributes;
7493 (void) key_buffer;
7494 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007495 (void) peer_key;
7496 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007497 (void) shared_secret;
7498 (void) shared_secret_size;
7499 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007500 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007501 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007502}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007503
Aditya Deshpande17845b82022-10-13 17:21:01 +01007504/** Internal function for raw key agreement
7505 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007506 * to the driver's implementation if a driver is present.
7507 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007508 * (psa_key_agreement_raw_builtin).
7509 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007510static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7511 psa_key_slot_t *private_key,
7512 const uint8_t *peer_key,
7513 size_t peer_key_length,
7514 uint8_t *shared_secret,
7515 size_t shared_secret_size,
7516 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007517{
Gilles Peskine449bd832023-01-11 14:50:10 +01007518 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7519 return PSA_ERROR_NOT_SUPPORTED;
7520 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007521
Gilles Peskine7a5d9202024-02-28 01:18:23 +01007522 return psa_driver_wrapper_key_agreement(&private_key->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01007523 private_key->key.data,
7524 private_key->key.bytes, alg,
7525 peer_key, peer_key_length,
7526 shared_secret,
7527 shared_secret_size,
7528 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007529}
7530
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007531/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007532 * to potentially free embedded data structures and wipe confidential data.
7533 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007534static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7535 psa_key_derivation_step_t step,
7536 psa_key_slot_t *private_key,
7537 const uint8_t *peer_key,
7538 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007539{
7540 psa_status_t status;
Moritz Fischer967f8cd2024-03-02 00:55:06 +00007541 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE] = { 0 };
Gilles Peskine01d718c2018-09-18 12:01:02 +02007542 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007544
7545 /* Step 1: run the secret agreement algorithm to generate the shared
7546 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007547 status = psa_key_agreement_raw_internal(ka_alg,
7548 private_key,
7549 peer_key, peer_key_length,
7550 shared_secret,
7551 sizeof(shared_secret),
7552 &shared_secret_length);
7553 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007554 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007555 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007556
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007557 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007558 * the shared secret. A shared secret is permitted wherever a key
7559 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007560 status = psa_key_derivation_input_internal(operation, step,
7561 PSA_KEY_TYPE_DERIVE,
7562 shared_secret,
7563 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007564exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007565 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7566 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007567}
7568
Gilles Peskine449bd832023-01-11 14:50:10 +01007569psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7570 psa_key_derivation_step_t step,
7571 mbedtls_svc_key_id_t private_key,
Thomas Daubney9739ac02024-02-15 13:15:47 +00007572 const uint8_t *peer_key_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007573 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007574{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007575 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007576 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007577 psa_key_slot_t *slot;
Thomas Daubney9739ac02024-02-15 13:15:47 +00007578 LOCAL_INPUT_DECLARE(peer_key_external, peer_key);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007579
Gilles Peskine449bd832023-01-11 14:50:10 +01007580 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7581 return PSA_ERROR_INVALID_ARGUMENT;
7582 }
Ronald Cron5c522922020-11-14 16:35:34 +01007583 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007584 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7585 if (status != PSA_SUCCESS) {
7586 return status;
7587 }
Thomas Daubney9739ac02024-02-15 13:15:47 +00007588
Thomas Daubney692fb3c2024-03-12 16:20:41 +00007589 LOCAL_INPUT_ALLOC(peer_key_external, peer_key_length, peer_key);
Gilles Peskine449bd832023-01-11 14:50:10 +01007590 status = psa_key_agreement_internal(operation, step,
7591 slot,
7592 peer_key, peer_key_length);
Thomas Daubney9739ac02024-02-15 13:15:47 +00007593
David Horstmann4a48bec2024-03-13 15:42:31 +00007594#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney9739ac02024-02-15 13:15:47 +00007595exit:
Thomas Daubney50f58fc2024-02-15 14:24:03 +00007596#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007597 if (status != PSA_SUCCESS) {
7598 psa_key_derivation_abort(operation);
7599 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007600 /* If a private key has been added as SECRET, we allow the derived
7601 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007602 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007603 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007604 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007605 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007606
Ryan Everett5ac6fa72024-02-14 17:11:36 +00007607 unlock_status = psa_unregister_read_under_mutex(slot);
Thomas Daubney9739ac02024-02-15 13:15:47 +00007608 LOCAL_INPUT_FREE(peer_key_external, peer_key);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007609
Gilles Peskine449bd832023-01-11 14:50:10 +01007610 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007611}
7612
Gilles Peskine449bd832023-01-11 14:50:10 +01007613psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7614 mbedtls_svc_key_id_t private_key,
Thomas Daubney81899ab2024-02-15 12:57:26 +00007615 const uint8_t *peer_key_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 size_t peer_key_length,
Thomas Daubney81899ab2024-02-15 12:57:26 +00007617 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007618 size_t output_size,
7619 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007620{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007621 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007622 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007623 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007624 size_t expected_length;
Thomas Daubney81899ab2024-02-15 12:57:26 +00007625 LOCAL_INPUT_DECLARE(peer_key_external, peer_key);
7626 LOCAL_OUTPUT_DECLARE(output_external, output);
Thomas Daubney89d8c2a2024-02-21 11:16:16 +00007627 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007628
Gilles Peskine449bd832023-01-11 14:50:10 +01007629 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007630 status = PSA_ERROR_INVALID_ARGUMENT;
7631 goto exit;
7632 }
Ronald Cron5c522922020-11-14 16:35:34 +01007633 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007634 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7635 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007636 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007637 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007638
Gilles Peskine3e561302022-04-14 00:17:15 +02007639 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7640 * for the output size. The PSA specification only guarantees that this
7641 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7642 * but it might be nice to allow smaller buffers if the output fits.
7643 * At the time of writing this comment, with only ECDH implemented,
7644 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7645 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7646 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007647 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007648 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7649 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007650 status = PSA_ERROR_BUFFER_TOO_SMALL;
7651 goto exit;
7652 }
7653
Thomas Daubney81899ab2024-02-15 12:57:26 +00007654 LOCAL_INPUT_ALLOC(peer_key_external, peer_key_length, peer_key);
Gilles Peskine449bd832023-01-11 14:50:10 +01007655 status = psa_key_agreement_raw_internal(alg, slot,
7656 peer_key, peer_key_length,
7657 output, output_size,
7658 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007659
7660exit:
Thomas Daubney5390aca2024-02-22 11:06:04 +00007661 /* Check for successful allocation of output,
7662 * with an unsuccessful status. */
Thomas Daubney0576a6a2024-02-21 15:15:00 +00007663 if (output != NULL && status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007664 /* If an error happens and is not handled properly, the output
7665 * may be used as a key to protect sensitive data. Arrange for such
7666 * a key to be random, which is likely to result in decryption or
7667 * verification errors. This is better than filling the buffer with
7668 * some constant data such as zeros, which would result in the data
7669 * being protected with a reproducible, easily knowable key.
7670 */
David Horstmann6e99bb22024-02-06 15:27:49 +00007671 psa_generate_random_internal(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007672 *output_length = output_size;
7673 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007674
Thomas Daubney5390aca2024-02-22 11:06:04 +00007675 if (output == NULL) {
Thomas Daubney89d8c2a2024-02-21 11:16:16 +00007676 /* output allocation failed. */
7677 *output_length = 0;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007678 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007679
Ryan Everetta103ec92024-01-31 13:59:57 +00007680 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007681
Thomas Daubney81899ab2024-02-15 12:57:26 +00007682 LOCAL_INPUT_FREE(peer_key_external, peer_key);
7683 LOCAL_OUTPUT_FREE(output_external, output);
Gilles Peskine449bd832023-01-11 14:50:10 +01007684 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007685}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007686
7687
7688/****************************************************************/
7689/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007690/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007691
Gilles Peskine672a7712023-04-28 21:00:28 +02007692#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7693#include "entropy_poll.h"
7694#endif
7695
Gilles Peskine30524eb2020-11-13 17:02:26 +01007696/** Initialize the PSA random generator.
Paul Elliottd35dce62024-03-15 13:57:16 +00007697 *
7698 * Note: the mbedtls_threading_psa_rngdata_mutex should be held when calling
7699 * this function if mutexes are enabled.
Gilles Peskine30524eb2020-11-13 17:02:26 +01007700 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007701static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007702{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007703#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007704 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007705#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7706
Gilles Peskine30524eb2020-11-13 17:02:26 +01007707 /* Set default configuration if
7708 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007709 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007710 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007711 }
7712 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007713 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007714 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007715
Gilles Peskine449bd832023-01-11 14:50:10 +01007716 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007717#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7718 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7719 /* The PSA entropy injection feature depends on using NV seed as an entropy
7720 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007721 mbedtls_entropy_add_source(&rng->entropy,
7722 mbedtls_nv_seed_poll, NULL,
7723 MBEDTLS_ENTROPY_BLOCK_SIZE,
7724 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007725#endif
7726
Valerio Setti061d4e42024-02-26 12:52:44 +01007727 mbedtls_psa_drbg_init(&rng->drbg);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007728#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007729}
7730
7731/** Deinitialize the PSA random generator.
Paul Elliottd35dce62024-03-15 13:57:16 +00007732 *
7733 * Note: the mbedtls_threading_psa_rngdata_mutex should be held when calling
7734 * this function if mutexes are enabled.
Gilles Peskine30524eb2020-11-13 17:02:26 +01007735 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007736static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007737{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007738#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007739 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007740#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti061d4e42024-02-26 12:52:44 +01007741 mbedtls_psa_drbg_free(&rng->drbg);
Gilles Peskine449bd832023-01-11 14:50:10 +01007742 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007743#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007744}
7745
7746/** Seed the PSA random generator.
7747 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007748static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007749{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007750#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7751 /* Do nothing: the external RNG seeds itself. */
7752 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007753 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007754#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007755 const unsigned char drbg_seed[] = "PSA";
Valerio Setti061d4e42024-02-26 12:52:44 +01007756 int ret = mbedtls_psa_drbg_seed(&rng->drbg, &rng->entropy,
Gilles Peskine449bd832023-01-11 14:50:10 +01007757 drbg_seed, sizeof(drbg_seed) - 1);
7758 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007759#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007760}
7761
David Horstmann6e99bb22024-02-06 15:27:49 +00007762psa_status_t psa_generate_random(uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007763 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007764{
David Horstmann6e99bb22024-02-06 15:27:49 +00007765 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007766
David Horstmann6e99bb22024-02-06 15:27:49 +00007767 LOCAL_OUTPUT_DECLARE(output_external, output);
7768 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007769
David Horstmann6e99bb22024-02-06 15:27:49 +00007770 status = psa_generate_random_internal(output, output_size);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007771
David Horstmann4a48bec2024-03-13 15:42:31 +00007772#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
David Horstmann6e99bb22024-02-06 15:27:49 +00007773exit:
David Horstmanne097bbd2024-02-28 14:17:10 +00007774#endif
David Horstmann6e99bb22024-02-06 15:27:49 +00007775 LOCAL_OUTPUT_FREE(output_external, output);
7776 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007777}
7778
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007779#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007780psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7781 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007782{
Paul Elliott600472b2024-02-23 17:26:58 +00007783 if (psa_get_initialized()) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007784 return PSA_ERROR_NOT_PERMITTED;
7785 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007786
Gilles Peskine449bd832023-01-11 14:50:10 +01007787 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7788 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7789 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7790 return PSA_ERROR_INVALID_ARGUMENT;
7791 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007792
Gilles Peskine449bd832023-01-11 14:50:10 +01007793 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007794}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007795#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007796
Ronald Cron3772afe2021-02-08 16:10:05 +01007797/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007798 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007799 * \param type The key type
7800 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007801 *
7802 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007803 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007804 * \retval #PSA_ERROR_INVALID_ARGUMENT
7805 * The size in bits of the key is not valid.
7806 * \retval #PSA_ERROR_NOT_SUPPORTED
7807 * The type and/or the size in bits of the key or the combination of
7808 * the two is not supported.
7809 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007810static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007811 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007812{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007813 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007814
Gilles Peskine449bd832023-01-11 14:50:10 +01007815 if (key_type_is_raw_bytes(type)) {
7816 status = psa_validate_unstructured_key_bit_size(type, bits);
7817 if (status != PSA_SUCCESS) {
7818 return status;
7819 }
7820 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007821#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007822 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7823 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7824 return PSA_ERROR_NOT_SUPPORTED;
7825 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007826 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007827 return PSA_ERROR_NOT_SUPPORTED;
7828 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007829
Ronald Cron01b2aba2020-10-05 09:42:02 +02007830 /* Accept only byte-aligned keys, for the same reasons as
7831 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007832 if (bits % 8 != 0) {
7833 return PSA_ERROR_NOT_SUPPORTED;
7834 }
7835 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007836#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007837
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007838#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007839 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007840 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007841 return PSA_SUCCESS;
7842 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007843#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007844
Valerio Settia55f0422023-07-10 15:34:41 +02007845#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007846 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007847 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007848 return PSA_ERROR_NOT_SUPPORTED;
7849 }
7850 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007851#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007852 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007853 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007854 }
7855
Gilles Peskine449bd832023-01-11 14:50:10 +01007856 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007857}
7858
Ronald Cron55ed0592020-10-05 10:30:40 +02007859psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007860 const psa_key_attributes_t *attributes,
Gilles Peskine092ce512024-02-20 12:31:24 +01007861 const psa_key_production_parameters_t *params, size_t params_data_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01007862 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007863{
7864 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f107ae2024-02-28 01:26:46 +01007865 psa_key_type_t type = attributes->type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007866
Gilles Peskine7a18f962024-02-12 16:48:11 +01007867 /* Only used for RSA */
Gilles Peskine092ce512024-02-20 12:31:24 +01007868 (void) params;
7869 (void) params_data_length;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007870
Gilles Peskine449bd832023-01-11 14:50:10 +01007871 if (key_type_is_raw_bytes(type)) {
David Horstmann93fa4e12024-03-12 15:02:28 +00007872 status = psa_generate_random_internal(key_buffer, key_buffer_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007873 if (status != PSA_SUCCESS) {
7874 return status;
7875 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007876
David Brown12ca5032021-02-11 11:02:00 -07007877#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007878 if (type == PSA_KEY_TYPE_DES) {
7879 psa_des_set_key_parity(key_buffer, key_buffer_size);
7880 }
David Brown8107e312021-02-12 08:08:46 -07007881#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007882 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007883
Valerio Setti76df8c12023-07-11 14:11:28 +02007884#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007885 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7886 return mbedtls_psa_rsa_generate_key(attributes,
Gilles Peskine4c32b692024-02-16 00:11:09 +01007887 params, params_data_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01007888 key_buffer,
7889 key_buffer_size,
7890 key_buffer_length);
7891 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007892#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007893
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007894#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007895 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7896 return mbedtls_psa_ecp_generate_key(attributes,
7897 key_buffer,
7898 key_buffer_size,
7899 key_buffer_length);
7900 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007901#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007902
Valerio Settia55f0422023-07-10 15:34:41 +02007903#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007904 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7905 return mbedtls_psa_ffdh_generate_key(attributes,
7906 key_buffer,
7907 key_buffer_size,
7908 key_buffer_length);
7909 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007910#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007911 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007912 (void) key_buffer_length;
7913 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007914 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007915
Gilles Peskine449bd832023-01-11 14:50:10 +01007916 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007917}
Darryl Green0c6575a2018-11-07 16:05:30 +00007918
Gilles Peskinef0765fa2024-02-12 16:46:16 +01007919psa_status_t psa_generate_key_ext(const psa_key_attributes_t *attributes,
Gilles Peskine092ce512024-02-20 12:31:24 +01007920 const psa_key_production_parameters_t *params,
7921 size_t params_data_length,
Gilles Peskinef0765fa2024-02-12 16:46:16 +01007922 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007923{
7924 psa_status_t status;
7925 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007926 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007927 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007928
Ronald Cron81709fc2020-11-14 12:10:32 +01007929 *key = MBEDTLS_SVC_KEY_ID_INIT;
7930
Gilles Peskine0f84d622019-09-12 19:03:13 +02007931 /* Reject any attempt to create a zero-length key so that we don't
7932 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007933 if (psa_get_key_bits(attributes) == 0) {
7934 return PSA_ERROR_INVALID_ARGUMENT;
7935 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007936
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007937 /* Reject any attempt to create a public key. */
Gilles Peskine2f107ae2024-02-28 01:26:46 +01007938 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007939 return PSA_ERROR_INVALID_ARGUMENT;
7940 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007941
Gilles Peskine7a18f962024-02-12 16:48:11 +01007942#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine2f107ae2024-02-28 01:26:46 +01007943 if (attributes->type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
Gilles Peskine092ce512024-02-20 12:31:24 +01007944 if (params->flags != 0) {
Gilles Peskine7a18f962024-02-12 16:48:11 +01007945 return PSA_ERROR_INVALID_ARGUMENT;
7946 }
7947 } else
7948#endif
Gilles Peskine092ce512024-02-20 12:31:24 +01007949 if (!psa_key_production_parameters_are_default(params, params_data_length)) {
Ronald Cron81709fc2020-11-14 12:10:32 +01007950 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine11792082019-08-06 18:36:36 +02007951 }
7952
Gilles Peskine449bd832023-01-11 14:50:10 +01007953 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7954 &slot, &driver);
7955 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007956 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007957 }
Gilles Peskine11792082019-08-06 18:36:36 +02007958
Ronald Cron977c2472020-10-13 08:32:21 +02007959 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307960 * storage ( thus not in the case of generating a key in a secure element
7961 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7962 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007963 if (slot->key.data == NULL) {
Gilles Peskine2f107ae2024-02-28 01:26:46 +01007964 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->lifetime) ==
Gilles Peskine449bd832023-01-11 14:50:10 +01007965 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007966 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine2f107ae2024-02-28 01:26:46 +01007967 attributes->type, attributes->bits);
Gilles Peskine449bd832023-01-11 14:50:10 +01007968 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007969 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007970 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007971
7972 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine2f107ae2024-02-28 01:26:46 +01007973 attributes->type,
7974 attributes->bits);
Gilles Peskine449bd832023-01-11 14:50:10 +01007975 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007976 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007977 attributes, &key_buffer_size);
7978 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007979 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007980 }
Ronald Cron977c2472020-10-13 08:32:21 +02007981 }
Ronald Cron977c2472020-10-13 08:32:21 +02007982
Gilles Peskine449bd832023-01-11 14:50:10 +01007983 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7984 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007985 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007986 }
Ronald Cron977c2472020-10-13 08:32:21 +02007987 }
7988
Gilles Peskine449bd832023-01-11 14:50:10 +01007989 status = psa_driver_wrapper_generate_key(attributes,
Gilles Peskine092ce512024-02-20 12:31:24 +01007990 params, params_data_length,
Gilles Peskine7a18f962024-02-12 16:48:11 +01007991 slot->key.data, slot->key.bytes,
7992 &slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01007993 if (status != PSA_SUCCESS) {
7994 psa_remove_key_data_from_memory(slot);
7995 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007996
Gilles Peskine11792082019-08-06 18:36:36 +02007997exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007998 if (status == PSA_SUCCESS) {
7999 status = psa_finish_key_creation(slot, driver, key);
8000 }
8001 if (status != PSA_SUCCESS) {
8002 psa_fail_key_creation(slot, driver);
8003 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02008004
Gilles Peskine449bd832023-01-11 14:50:10 +01008005 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008006}
8007
Gilles Peskinef0765fa2024-02-12 16:46:16 +01008008psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
8009 mbedtls_svc_key_id_t *key)
8010{
8011 return psa_generate_key_ext(attributes,
Gilles Peskine092ce512024-02-20 12:31:24 +01008012 &default_production_parameters, 0,
Gilles Peskinef0765fa2024-02-12 16:46:16 +01008013 key);
8014}
8015
Gilles Peskinee59236f2018-01-27 23:32:46 +01008016/****************************************************************/
8017/* Module setup */
8018/****************************************************************/
8019
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01008020#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01008021psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01008022 void (* entropy_init)(mbedtls_entropy_context *ctx),
8023 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01008024{
Paul Elliott8e151532024-02-23 17:35:29 +00008025 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8026
8027#if defined(MBEDTLS_THREADING_C)
8028 mbedtls_mutex_lock(&mbedtls_threading_psa_rngdata_mutex);
8029#endif /* defined(MBEDTLS_THREADING_C) */
8030
Gilles Peskine449bd832023-01-11 14:50:10 +01008031 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
Paul Elliott8e151532024-02-23 17:35:29 +00008032 status = PSA_ERROR_BAD_STATE;
8033 } else {
8034 global_data.rng.entropy_init = entropy_init;
8035 global_data.rng.entropy_free = entropy_free;
8036 status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01008037 }
Paul Elliott8e151532024-02-23 17:35:29 +00008038
8039#if defined(MBEDTLS_THREADING_C)
8040 mbedtls_mutex_unlock(&mbedtls_threading_psa_rngdata_mutex);
8041#endif /* defined(MBEDTLS_THREADING_C) */
8042
8043 return status;
Gilles Peskine5e769522018-11-20 21:59:56 +01008044}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01008045#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01008046
Gilles Peskine449bd832023-01-11 14:50:10 +01008047void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01008048{
Paul Elliott47cee8e2024-03-08 21:38:02 +00008049
Paul Elliott600472b2024-02-23 17:26:58 +00008050#if defined(MBEDTLS_THREADING_C)
8051 mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex);
8052#endif /* defined(MBEDTLS_THREADING_C) */
8053
Paul Elliott47cee8e2024-03-08 21:38:02 +00008054 /* Nothing to do to free transaction. */
8055 if (global_data.initialized & PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED) {
8056 global_data.initialized &= ~PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED;
Valerio Setti83e0de82023-11-24 12:13:05 +01008057 }
Paul Elliott600472b2024-02-23 17:26:58 +00008058
Paul Elliott47cee8e2024-03-08 21:38:02 +00008059 if (global_data.initialized & PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS_INITIALIZED) {
8060 psa_wipe_all_key_slots();
8061 global_data.initialized &= ~PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS_INITIALIZED;
8062 }
Ronald Cron9ba76912021-04-10 16:57:30 +02008063
Paul Elliott600472b2024-02-23 17:26:58 +00008064#if defined(MBEDTLS_THREADING_C)
8065 mbedtls_mutex_unlock(&mbedtls_threading_psa_globaldata_mutex);
8066#endif /* defined(MBEDTLS_THREADING_C) */
8067
Paul Elliott47cee8e2024-03-08 21:38:02 +00008068#if defined(MBEDTLS_THREADING_C)
8069 mbedtls_mutex_lock(&mbedtls_threading_psa_rngdata_mutex);
8070#endif /* defined(MBEDTLS_THREADING_C) */
8071
Gilles Peskinec6b69072018-11-20 21:42:52 +01008072 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01008073 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01008074 }
Paul Elliott47cee8e2024-03-08 21:38:02 +00008075 global_data.rng_state = RNG_NOT_INITIALIZED;
8076 mbedtls_platform_zeroize(&global_data.rng, sizeof(global_data.rng));
8077
8078#if defined(MBEDTLS_THREADING_C)
8079 mbedtls_mutex_unlock(&mbedtls_threading_psa_rngdata_mutex);
8080#endif /* defined(MBEDTLS_THREADING_C) */
8081
8082#if defined(MBEDTLS_THREADING_C)
8083 mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex);
8084#endif /* defined(MBEDTLS_THREADING_C) */
Ronald Cron9ba76912021-04-10 16:57:30 +02008085
8086 /* Terminate drivers */
Paul Elliott47cee8e2024-03-08 21:38:02 +00008087 if (global_data.initialized & PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS_INITIALIZED) {
8088 psa_driver_wrapper_free();
8089 global_data.initialized &= ~PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS_INITIALIZED;
8090 }
8091
8092#if defined(MBEDTLS_THREADING_C)
8093 mbedtls_mutex_unlock(&mbedtls_threading_psa_globaldata_mutex);
8094#endif /* defined(MBEDTLS_THREADING_C) */
8095
Gilles Peskinee59236f2018-01-27 23:32:46 +01008096}
8097
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008098#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
8099/** Recover a transaction that was interrupted by a power failure.
8100 *
8101 * This function is called during initialization, before psa_crypto_init()
8102 * returns. If this function returns a failure status, the initialization
8103 * fails.
8104 */
8105static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01008106 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008107{
Gilles Peskine449bd832023-01-11 14:50:10 +01008108 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008109 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
8110 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008111 /* TODO - fall through to the failure case until this
8112 * is implemented.
8113 * https://github.com/ARMmbed/mbed-crypto/issues/218
8114 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008115 default:
8116 /* We found an unsupported transaction in the storage.
8117 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008118 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008119 }
8120}
8121#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
8122
Paul Elliott47cee8e2024-03-08 21:38:02 +00008123static psa_status_t mbedtls_psa_crypto_init_subsystem(mbedtls_psa_crypto_subsystem subsystem)
8124{
8125 psa_status_t status = PSA_SUCCESS;
8126 uint8_t driver_wrappers_initialized = 0;
8127
8128 switch (subsystem) {
8129 case PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS:
8130
8131#if defined(MBEDTLS_THREADING_C)
8132 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex));
8133#endif /* defined(MBEDTLS_THREADING_C) */
8134
8135 if (!(global_data.initialized & PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS_INITIALIZED)) {
8136 /* Init drivers */
8137 status = psa_driver_wrapper_init();
8138
8139 /* Drivers need shutdown regardless of startup errors. */
8140 global_data.initialized |= PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS_INITIALIZED;
8141
8142
8143 }
8144#if defined(MBEDTLS_THREADING_C)
8145 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_unlock(
8146 &mbedtls_threading_psa_globaldata_mutex));
8147#endif /* defined(MBEDTLS_THREADING_C) */
8148
8149 break;
8150
8151 case PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS:
8152
8153#if defined(MBEDTLS_THREADING_C)
8154 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex));
8155#endif /* defined(MBEDTLS_THREADING_C) */
8156
8157 if (!(global_data.initialized & PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS_INITIALIZED)) {
8158 status = psa_initialize_key_slots();
8159
8160 /* Need to wipe keys even if initialization fails. */
8161 global_data.initialized |= PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS_INITIALIZED;
8162
8163 }
8164#if defined(MBEDTLS_THREADING_C)
8165 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_unlock(
8166 &mbedtls_threading_psa_globaldata_mutex));
8167#endif /* defined(MBEDTLS_THREADING_C) */
8168
8169 break;
8170
8171 case PSA_CRYPTO_SUBSYSTEM_RNG:
8172
8173#if defined(MBEDTLS_THREADING_C)
8174 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex));
8175#endif /* defined(MBEDTLS_THREADING_C) */
8176
8177 driver_wrappers_initialized =
8178 (global_data.initialized & PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS_INITIALIZED);
8179
8180#if defined(MBEDTLS_THREADING_C)
8181 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_unlock(
8182 &mbedtls_threading_psa_globaldata_mutex));
8183#endif /* defined(MBEDTLS_THREADING_C) */
8184
8185 /* Need to use separate mutex here, as initialisation can require
8186 * testing of init flags, which requires locking the global data
8187 * mutex. */
8188#if defined(MBEDTLS_THREADING_C)
8189 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(&mbedtls_threading_psa_rngdata_mutex));
8190#endif /* defined(MBEDTLS_THREADING_C) */
8191
8192 /* Initialize and seed the random generator. */
8193 if (global_data.rng_state == RNG_NOT_INITIALIZED && driver_wrappers_initialized) {
8194 mbedtls_psa_random_init(&global_data.rng);
8195 global_data.rng_state = RNG_INITIALIZED;
8196
8197 status = mbedtls_psa_random_seed(&global_data.rng);
8198 if (status == PSA_SUCCESS) {
8199 global_data.rng_state = RNG_SEEDED;
8200 }
8201 }
8202
8203#if defined(MBEDTLS_THREADING_C)
8204 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_unlock(
8205 &mbedtls_threading_psa_rngdata_mutex));
8206#endif /* defined(MBEDTLS_THREADING_C) */
8207
Paul Elliott47cee8e2024-03-08 21:38:02 +00008208 break;
8209
8210 case PSA_CRYPTO_SUBSYSTEM_TRANSACTION:
8211
8212#if defined(MBEDTLS_THREADING_C)
8213 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex));
8214#endif /* defined(MBEDTLS_THREADING_C) */
8215
8216 if (!(global_data.initialized & PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED)) {
8217#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
8218 status = psa_crypto_load_transaction();
8219 if (status == PSA_SUCCESS) {
8220 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
8221 if (status == PSA_SUCCESS) {
8222 global_data.initialized |= PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED;
8223 }
8224 status = psa_crypto_stop_transaction();
8225 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
8226 /* There's no transaction to complete. It's all good. */
8227 global_data.initialized |= PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED;
8228 status = PSA_SUCCESS;
8229 }
8230#else /* defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS) */
8231 global_data.initialized |= PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED;
8232 status = PSA_SUCCESS;
8233#endif /* defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS) */
8234 }
8235
8236#if defined(MBEDTLS_THREADING_C)
8237 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_unlock(
8238 &mbedtls_threading_psa_globaldata_mutex));
8239#endif /* defined(MBEDTLS_THREADING_C) */
8240
8241 break;
8242
8243 default:
8244 status = PSA_ERROR_CORRUPTION_DETECTED;
8245 }
8246
8247 /* Exit label only required when using threading macros. */
8248#if defined(MBEDTLS_THREADING_C)
8249exit:
8250#endif /* defined(MBEDTLS_THREADING_C) */
8251
8252 return status;
8253}
8254
Gilles Peskine449bd832023-01-11 14:50:10 +01008255psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01008256{
Gilles Peskine66fb1262018-12-10 16:29:04 +01008257 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008258
Paul Elliott47cee8e2024-03-08 21:38:02 +00008259 /* Double initialization is explicitly allowed. Early out if everything is
8260 * done. */
8261 if (psa_get_initialized()) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008262 return PSA_SUCCESS;
8263 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01008264
Paul Elliott47cee8e2024-03-08 21:38:02 +00008265 status = mbedtls_psa_crypto_init_subsystem(PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS);
Valerio Setti402cfba2023-11-13 10:24:32 +01008266 if (status != PSA_SUCCESS) {
8267 goto exit;
8268 }
8269
Paul Elliott47cee8e2024-03-08 21:38:02 +00008270 status = mbedtls_psa_crypto_init_subsystem(PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS);
Gilles Peskine449bd832023-01-11 14:50:10 +01008271 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01008272 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008273 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01008274
Paul Elliott47cee8e2024-03-08 21:38:02 +00008275 status = mbedtls_psa_crypto_init_subsystem(PSA_CRYPTO_SUBSYSTEM_RNG);
8276 if (status != PSA_SUCCESS) {
8277 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02008278 }
Gilles Peskinefc762652019-07-22 19:30:34 +02008279
Paul Elliott47cee8e2024-03-08 21:38:02 +00008280 status = mbedtls_psa_crypto_init_subsystem(PSA_CRYPTO_SUBSYSTEM_TRANSACTION);
Gilles Peskinee59236f2018-01-27 23:32:46 +01008281
8282exit:
Paul Elliott600472b2024-02-23 17:26:58 +00008283
Gilles Peskine449bd832023-01-11 14:50:10 +01008284 if (status != PSA_SUCCESS) {
8285 mbedtls_psa_crypto_free();
8286 }
Paul Elliott47cee8e2024-03-08 21:38:02 +00008287
Gilles Peskine449bd832023-01-11 14:50:10 +01008288 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008289}
8290
Yanray Wangffc3c482023-07-11 12:01:04 +08008291#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008292psa_status_t psa_crypto_driver_pake_get_password_len(
8293 const psa_crypto_driver_pake_inputs_t *inputs,
8294 size_t *password_len)
8295{
8296 if (inputs->password_len == 0) {
8297 return PSA_ERROR_BAD_STATE;
8298 }
8299
8300 *password_len = inputs->password_len;
8301
8302 return PSA_SUCCESS;
8303}
8304
8305psa_status_t psa_crypto_driver_pake_get_password(
8306 const psa_crypto_driver_pake_inputs_t *inputs,
8307 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
8308{
8309 if (inputs->password_len == 0) {
8310 return PSA_ERROR_BAD_STATE;
8311 }
8312
8313 if (buffer_size < inputs->password_len) {
8314 return PSA_ERROR_BUFFER_TOO_SMALL;
8315 }
8316
8317 memcpy(buffer, inputs->password, inputs->password_len);
8318 *buffer_length = inputs->password_len;
8319
8320 return PSA_SUCCESS;
8321}
8322
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008323psa_status_t psa_crypto_driver_pake_get_user_len(
8324 const psa_crypto_driver_pake_inputs_t *inputs,
8325 size_t *user_len)
8326{
8327 if (inputs->user_len == 0) {
8328 return PSA_ERROR_BAD_STATE;
8329 }
8330
8331 *user_len = inputs->user_len;
8332
8333 return PSA_SUCCESS;
8334}
8335
8336psa_status_t psa_crypto_driver_pake_get_user(
8337 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008338 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008339{
8340 if (inputs->user_len == 0) {
8341 return PSA_ERROR_BAD_STATE;
8342 }
8343
Przemek Stekielc0e62502023-03-14 11:49:36 +01008344 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008345 return PSA_ERROR_BUFFER_TOO_SMALL;
8346 }
8347
Przemek Stekielc0e62502023-03-14 11:49:36 +01008348 memcpy(user_id, inputs->user, inputs->user_len);
8349 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008350
8351 return PSA_SUCCESS;
8352}
8353
8354psa_status_t psa_crypto_driver_pake_get_peer_len(
8355 const psa_crypto_driver_pake_inputs_t *inputs,
8356 size_t *peer_len)
8357{
8358 if (inputs->peer_len == 0) {
8359 return PSA_ERROR_BAD_STATE;
8360 }
8361
8362 *peer_len = inputs->peer_len;
8363
8364 return PSA_SUCCESS;
8365}
8366
8367psa_status_t psa_crypto_driver_pake_get_peer(
8368 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008369 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008370{
8371 if (inputs->peer_len == 0) {
8372 return PSA_ERROR_BAD_STATE;
8373 }
8374
Przemek Stekielc0e62502023-03-14 11:49:36 +01008375 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008376 return PSA_ERROR_BUFFER_TOO_SMALL;
8377 }
8378
Przemek Stekielc0e62502023-03-14 11:49:36 +01008379 memcpy(peer_id, inputs->peer, inputs->peer_len);
8380 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008381
8382 return PSA_SUCCESS;
8383}
8384
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008385psa_status_t psa_crypto_driver_pake_get_cipher_suite(
8386 const psa_crypto_driver_pake_inputs_t *inputs,
8387 psa_pake_cipher_suite_t *cipher_suite)
8388{
8389 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
8390 return PSA_ERROR_BAD_STATE;
8391 }
8392
8393 *cipher_suite = inputs->cipher_suite;
8394
8395 return PSA_SUCCESS;
8396}
8397
Neil Armstronga7d08c32022-06-01 18:21:20 +02008398psa_status_t psa_pake_setup(
8399 psa_pake_operation_t *operation,
8400 const psa_pake_cipher_suite_t *cipher_suite)
8401{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008402 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008403
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008404 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008405 status = PSA_ERROR_BAD_STATE;
8406 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008407 }
8408
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008409 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01008410 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008411 status = PSA_ERROR_INVALID_ARGUMENT;
8412 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008413 }
8414
Przemek Stekiel51eac532022-12-07 11:04:51 +01008415 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
8416
Przemek Stekiele12ed362022-12-21 12:54:46 +01008417 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01008418 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
8419 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008420 operation->data.inputs.cipher_suite = *cipher_suite;
8421
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008422#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008423 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008424 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01008425 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008426
David Horstmann16f01512023-06-14 17:21:07 +01008427 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01008428 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008429 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008430#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008431 {
8432 status = PSA_ERROR_NOT_SUPPORTED;
8433 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008434 }
8435
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008436 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
8437
Przemek Stekiel51eac532022-12-07 11:04:51 +01008438 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008439exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008440 psa_pake_abort(operation);
8441 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008442}
8443
8444psa_status_t psa_pake_set_password_key(
8445 psa_pake_operation_t *operation,
8446 mbedtls_svc_key_id_t password)
8447{
Neil Armstrong5ae60962022-09-15 11:29:46 +02008448 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01008449 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
8450 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008451 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008452
Przemek Stekiel51eac532022-12-07 11:04:51 +01008453 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008454 status = PSA_ERROR_BAD_STATE;
8455 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008456 }
8457
Przemek Stekiel6c764412022-11-22 14:05:12 +01008458 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
8459 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008460 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008461 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008462 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008463 }
8464
Gilles Peskine7a5d9202024-02-28 01:18:23 +01008465 type = psa_get_key_type(&slot->attr);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008466
Przemek Stekiel51eac532022-12-07 11:04:51 +01008467 if (type != PSA_KEY_TYPE_PASSWORD &&
8468 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8469 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008470 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008471 }
8472
Przemek Stekiel51eac532022-12-07 11:04:51 +01008473 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8474 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008475 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008476 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008477 }
8478
8479 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8480 operation->data.inputs.password_len = slot->key.bytes;
Gilles Peskine7fad3ef2024-02-28 01:08:27 +01008481 operation->data.inputs.attributes = slot->attr;
8482
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008483exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008484 if (status != PSA_SUCCESS) {
8485 psa_pake_abort(operation);
8486 }
Ryan Everettbbedfce2024-02-14 18:22:09 +00008487 unlock_status = psa_unregister_read_under_mutex(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008488 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008489}
8490
8491psa_status_t psa_pake_set_user(
8492 psa_pake_operation_t *operation,
David Horstmann4f534ae2024-01-22 17:35:59 +00008493 const uint8_t *user_id_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008494 size_t user_id_len)
8495{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008496 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
David Horstmann4f534ae2024-01-22 17:35:59 +00008497 LOCAL_INPUT_DECLARE(user_id_external, user_id);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008498
8499 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008500 status = PSA_ERROR_BAD_STATE;
8501 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008502 }
8503
Przemek Stekiel51eac532022-12-07 11:04:51 +01008504 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008505 status = PSA_ERROR_INVALID_ARGUMENT;
8506 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008507 }
8508
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008509 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008510 status = PSA_ERROR_BAD_STATE;
8511 goto exit;
8512 }
8513
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008514 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8515 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008516 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8517 goto exit;
8518 }
8519
David Horstmann4f534ae2024-01-22 17:35:59 +00008520 LOCAL_INPUT_ALLOC(user_id_external, user_id_len, user_id);
8521
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008522 memcpy(operation->data.inputs.user, user_id, user_id_len);
8523 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008524
David Horstmann4f534ae2024-01-22 17:35:59 +00008525 status = PSA_SUCCESS;
8526
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008527exit:
David Horstmann4f534ae2024-01-22 17:35:59 +00008528 LOCAL_INPUT_FREE(user_id_external, user_id);
8529 if (status != PSA_SUCCESS) {
8530 psa_pake_abort(operation);
8531 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008532 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008533}
8534
8535psa_status_t psa_pake_set_peer(
8536 psa_pake_operation_t *operation,
David Horstmann4f534ae2024-01-22 17:35:59 +00008537 const uint8_t *peer_id_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008538 size_t peer_id_len)
8539{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008540 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
David Horstmann4f534ae2024-01-22 17:35:59 +00008541 LOCAL_INPUT_DECLARE(peer_id_external, peer_id);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008542
8543 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008544 status = PSA_ERROR_BAD_STATE;
8545 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008546 }
8547
Przemek Stekiel51eac532022-12-07 11:04:51 +01008548 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008549 status = PSA_ERROR_INVALID_ARGUMENT;
8550 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008551 }
8552
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008553 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008554 status = PSA_ERROR_BAD_STATE;
8555 goto exit;
8556 }
8557
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008558 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8559 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008560 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8561 goto exit;
8562 }
8563
David Horstmann4f534ae2024-01-22 17:35:59 +00008564 LOCAL_INPUT_ALLOC(peer_id_external, peer_id_len, peer_id);
8565
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008566 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8567 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008568
David Horstmann4f534ae2024-01-22 17:35:59 +00008569 status = PSA_SUCCESS;
8570
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008571exit:
David Horstmann4f534ae2024-01-22 17:35:59 +00008572 LOCAL_INPUT_FREE(peer_id_external, peer_id);
8573 if (status != PSA_SUCCESS) {
8574 psa_pake_abort(operation);
8575 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008576 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008577}
8578
8579psa_status_t psa_pake_set_role(
8580 psa_pake_operation_t *operation,
8581 psa_pake_role_t role)
8582{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008583 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008584
Przemek Stekiel51eac532022-12-07 11:04:51 +01008585 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008586 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008587 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008588 }
8589
Przemek Stekiel09104b82023-03-06 14:11:51 +01008590 switch (operation->alg) {
8591#if defined(PSA_WANT_ALG_JPAKE)
8592 case PSA_ALG_JPAKE:
8593 if (role == PSA_PAKE_ROLE_NONE) {
8594 return PSA_SUCCESS;
8595 }
8596 status = PSA_ERROR_INVALID_ARGUMENT;
8597 break;
8598#endif
8599 default:
8600 (void) role;
8601 status = PSA_ERROR_NOT_SUPPORTED;
8602 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008603 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008604exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008605 psa_pake_abort(operation);
8606 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008607}
8608
David Horstmanne7f21e62023-05-12 18:17:21 +01008609/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008610#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008611static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008612 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008613{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008614 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008615 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008616 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008617
David Horstmann024e5c52023-06-14 15:48:21 +01008618 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008619 is_x1 = (stage->outputs < 1);
8620 } else {
8621 is_x1 = (stage->inputs < 1);
8622 }
8623
David Horstmann74a3d8c2023-06-14 18:28:19 +01008624 key_share_step = is_x1 ?
8625 PSA_JPAKE_X1_STEP_KEY_SHARE :
8626 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008627 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008628 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8629 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8630 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8631 } else {
8632 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008633 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008634 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008635}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008636#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008637
Przemek Stekiel2797d372022-12-22 11:19:22 +01008638static psa_status_t psa_pake_complete_inputs(
8639 psa_pake_operation_t *operation)
8640{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008641 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008642 /* Create copy of the inputs on stack as inputs share memory
8643 with the driver context which will be setup by the driver. */
8644 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008645
Przemek Stekielfde11282023-03-13 16:06:09 +01008646 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008647 return PSA_ERROR_BAD_STATE;
8648 }
8649
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008650 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008651 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8652 return PSA_ERROR_BAD_STATE;
8653 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008654 }
8655
Przemek Stekiel18620a32023-01-17 16:34:52 +01008656 /* Clear driver context */
8657 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8658
8659 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008660
8661 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008662 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008663
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008664 /* User and peer are translated to role. */
8665 mbedtls_free(inputs.user);
8666 mbedtls_free(inputs.peer);
8667
Przemek Stekiel2797d372022-12-22 11:19:22 +01008668 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008669#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008670 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008671 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008672 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008673#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008674 {
8675 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008676 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008677 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008678 return status;
8679}
8680
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008681#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008682static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008683 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008684 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008685 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008686{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008687 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8688 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8689 step != PSA_PAKE_STEP_ZK_PROOF) {
8690 return PSA_ERROR_INVALID_ARGUMENT;
8691 }
8692
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008693 psa_jpake_computation_stage_t *computation_stage =
8694 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008695
David Horstmann5da95602023-06-08 15:37:12 +01008696 if (computation_stage->round != PSA_JPAKE_FIRST &&
8697 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008698 return PSA_ERROR_BAD_STATE;
8699 }
8700
David Horstmanne7f21e62023-05-12 18:17:21 +01008701 /* Check that the step we are given is the one we were expecting */
8702 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008703 return PSA_ERROR_BAD_STATE;
8704 }
8705
David Horstmanne7f21e62023-05-12 18:17:21 +01008706 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8707 computation_stage->inputs == 0 &&
8708 computation_stage->outputs == 0) {
8709 /* Start of the round, so function decides whether we are inputting
8710 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008711 computation_stage->io_mode = io_mode;
8712 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008713 /* Middle of the round so the mode we are in must match the function
8714 * called by the user */
8715 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008716 }
8717
8718 return PSA_SUCCESS;
8719}
8720
David Horstmanne7f21e62023-05-12 18:17:21 +01008721static psa_status_t psa_jpake_epilogue(
8722 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008723 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008724{
David Horstmanne7f21e62023-05-12 18:17:21 +01008725 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008726 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008727
David Horstmanne7f21e62023-05-12 18:17:21 +01008728 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8729 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008730 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008731 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008732 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008733 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008734 }
8735 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008736 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008737 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008738 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008739 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008740 }
8741 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008742 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8743 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008744 /* End of a round, move to the next round */
8745 stage->inputs = 0;
8746 stage->outputs = 0;
8747 stage->round++;
8748 }
8749 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008750 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008751 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008752 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008753 return PSA_SUCCESS;
8754}
David Horstmanne7f21e62023-05-12 18:17:21 +01008755
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008756#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008757
Neil Armstronga7d08c32022-06-01 18:21:20 +02008758psa_status_t psa_pake_output(
8759 psa_pake_operation_t *operation,
8760 psa_pake_step_t step,
David Horstmannc75639d2024-01-22 17:56:39 +00008761 uint8_t *output_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008762 size_t output_size,
8763 size_t *output_length)
8764{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008765 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008766 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
David Horstmannc75639d2024-01-22 17:56:39 +00008767 LOCAL_OUTPUT_DECLARE(output_external, output);
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008768 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008769
8770 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008771 status = psa_pake_complete_inputs(operation);
8772 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008773 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008774 }
8775 }
8776
8777 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008778 status = PSA_ERROR_BAD_STATE;
8779 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008780 }
8781
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008782 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008783 status = PSA_ERROR_INVALID_ARGUMENT;
8784 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008785 }
8786
Przemek Stekiele12ed362022-12-21 12:54:46 +01008787 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008788#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008789 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008790 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008791 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008792 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008793 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008794 driver_step = convert_jpake_computation_stage_to_driver_step(
8795 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008796 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008797#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008798 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008799 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008800 status = PSA_ERROR_NOT_SUPPORTED;
8801 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008802 }
8803
David Horstmannc75639d2024-01-22 17:56:39 +00008804 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
8805
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008806 status = psa_driver_wrapper_pake_output(operation, driver_step,
8807 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008808
8809 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008810 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008811 }
8812
8813 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008814#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008815 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008816 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008817 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008818 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008819 }
8820 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008821#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008822 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008823 status = PSA_ERROR_NOT_SUPPORTED;
8824 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008825 }
8826
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008827exit:
David Horstmannc75639d2024-01-22 17:56:39 +00008828 LOCAL_OUTPUT_FREE(output_external, output);
8829 if (status != PSA_SUCCESS) {
8830 psa_pake_abort(operation);
8831 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008832 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008833}
8834
8835psa_status_t psa_pake_input(
8836 psa_pake_operation_t *operation,
8837 psa_pake_step_t step,
David Horstmannc75639d2024-01-22 17:56:39 +00008838 const uint8_t *input_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008839 size_t input_length)
8840{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008841 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008842 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008843 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8844 operation->primitive,
8845 step);
David Horstmannc75639d2024-01-22 17:56:39 +00008846 LOCAL_INPUT_DECLARE(input_external, input);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008847
8848 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008849 status = psa_pake_complete_inputs(operation);
8850 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008851 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008852 }
8853 }
8854
8855 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008856 status = PSA_ERROR_BAD_STATE;
8857 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008858 }
8859
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008860 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008861 status = PSA_ERROR_INVALID_ARGUMENT;
8862 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008863 }
8864
Przemek Stekiele12ed362022-12-21 12:54:46 +01008865 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008866#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008867 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008868 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008869 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008870 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008871 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008872 driver_step = convert_jpake_computation_stage_to_driver_step(
8873 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008874 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008875#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008876 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008877 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008878 status = PSA_ERROR_NOT_SUPPORTED;
8879 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008880 }
8881
David Horstmannc75639d2024-01-22 17:56:39 +00008882 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008883 status = psa_driver_wrapper_pake_input(operation, driver_step,
8884 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008885
8886 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008887 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008888 }
8889
8890 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008891#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008892 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008893 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008894 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008895 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008896 }
8897 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008898#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008899 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008900 status = PSA_ERROR_NOT_SUPPORTED;
8901 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008902 }
8903
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008904exit:
David Horstmannc75639d2024-01-22 17:56:39 +00008905 LOCAL_INPUT_FREE(input_external, input);
8906 if (status != PSA_SUCCESS) {
8907 psa_pake_abort(operation);
8908 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008909 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008910}
8911
8912psa_status_t psa_pake_get_implicit_key(
8913 psa_pake_operation_t *operation,
8914 psa_key_derivation_operation_t *output)
8915{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008916 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008917 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008918 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008919 size_t shared_key_len = 0;
8920
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008921 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008922 status = PSA_ERROR_BAD_STATE;
8923 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008924 }
8925
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008926#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008927 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008928 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008929 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008930 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008931 status = PSA_ERROR_BAD_STATE;
8932 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008933 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008934 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008935#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008936 {
8937 status = PSA_ERROR_NOT_SUPPORTED;
8938 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008939 }
8940
Przemek Stekiel0c781802022-11-29 14:53:13 +01008941 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8942 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008943 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008944 &shared_key_len);
8945
8946 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008947 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008948 }
8949
8950 status = psa_key_derivation_input_bytes(output,
8951 PSA_KEY_DERIVATION_INPUT_SECRET,
8952 shared_key,
8953 shared_key_len);
8954
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008955 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008956exit:
8957 abort_status = psa_pake_abort(operation);
8958 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008959}
8960
8961psa_status_t psa_pake_abort(
8962 psa_pake_operation_t *operation)
8963{
Przemek Stekield69dca92023-01-31 19:59:20 +01008964 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008965
Przemek Stekield69dca92023-01-31 19:59:20 +01008966 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008967 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008968 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008969
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008970 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8971 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008972 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008973 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008974 }
8975 if (operation->data.inputs.user != NULL) {
8976 mbedtls_free(operation->data.inputs.user);
8977 }
8978 if (operation->data.inputs.peer != NULL) {
8979 mbedtls_free(operation->data.inputs.peer);
8980 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008981 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008982 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008983
Przemek Stekield69dca92023-01-31 19:59:20 +01008984 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008985}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008986#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008987
David Horstmann00d7a042023-12-07 18:39:17 +00008988/* Memory copying test hooks. These are called before input copy, after input
8989 * copy, before output copy and after output copy, respectively.
8990 * They are used by memory-poisoning tests to temporarily unpoison buffers
8991 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00008992#if defined(MBEDTLS_TEST_HOOKS)
8993void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8994void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8995void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8996void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8997#endif
David Horstmannfde97392023-10-30 20:29:43 +00008998
David Horstmann1b7279a2023-11-15 15:18:30 +00008999/** Copy from an input buffer to a local copy.
9000 *
9001 * \param[in] input Pointer to input buffer.
9002 * \param[in] input_len Length of the input buffer.
9003 * \param[out] input_copy Pointer to a local copy in which to store the input data.
9004 * \param[out] input_copy_len Length of the local copy buffer.
9005 * \return #PSA_SUCCESS, if the buffer was successfully
9006 * copied.
9007 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
9008 * copy is too small to hold contents of the
9009 * input buffer.
9010 */
9011MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00009012psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
9013 uint8_t *input_copy, size_t input_copy_len)
9014{
9015 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00009016 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00009017 }
9018
David Horstmann372b8bb2023-11-24 16:21:04 +00009019#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00009020 if (psa_input_pre_copy_hook != NULL) {
9021 psa_input_pre_copy_hook(input, input_len);
9022 }
David Horstmann372b8bb2023-11-24 16:21:04 +00009023#endif
9024
David Horstmann777e7412023-11-15 17:33:47 +00009025 if (input_len > 0) {
9026 memcpy(input_copy, input, input_len);
9027 }
David Horstmannfde97392023-10-30 20:29:43 +00009028
David Horstmann372b8bb2023-11-24 16:21:04 +00009029#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00009030 if (psa_input_post_copy_hook != NULL) {
9031 psa_input_post_copy_hook(input, input_len);
9032 }
David Horstmann372b8bb2023-11-24 16:21:04 +00009033#endif
9034
David Horstmannfde97392023-10-30 20:29:43 +00009035 return PSA_SUCCESS;
9036}
9037
David Horstmann1b7279a2023-11-15 15:18:30 +00009038/** Copy from a local output buffer into a user-supplied one.
9039 *
9040 * \param[in] output_copy Pointer to a local buffer containing the output.
9041 * \param[in] output_copy_len Length of the local buffer.
9042 * \param[out] output Pointer to user-supplied output buffer.
9043 * \param[out] output_len Length of the user-supplied output buffer.
9044 * \return #PSA_SUCCESS, if the buffer was successfully
9045 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00009046 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00009047 * user-supplied output buffer is too small to
9048 * hold the contents of the local buffer.
9049 */
9050MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00009051psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
9052 uint8_t *output, size_t output_len)
9053{
9054 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00009055 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00009056 }
David Horstmann777e7412023-11-15 17:33:47 +00009057
David Horstmann372b8bb2023-11-24 16:21:04 +00009058#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00009059 if (psa_output_pre_copy_hook != NULL) {
9060 psa_output_pre_copy_hook(output, output_len);
9061 }
David Horstmann372b8bb2023-11-24 16:21:04 +00009062#endif
9063
David Horstmann777e7412023-11-15 17:33:47 +00009064 if (output_copy_len > 0) {
9065 memcpy(output, output_copy, output_copy_len);
9066 }
9067
David Horstmann372b8bb2023-11-24 16:21:04 +00009068#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00009069 if (psa_output_post_copy_hook != NULL) {
9070 psa_output_post_copy_hook(output, output_len);
9071 }
David Horstmann372b8bb2023-11-24 16:21:04 +00009072#endif
9073
David Horstmann8978f5c2023-10-30 20:37:12 +00009074 return PSA_SUCCESS;
9075}
9076
David Horstmannf1734052023-11-20 17:15:32 +00009077psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
9078 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00009079{
9080 psa_status_t status;
9081
David Horstmann9db14482023-11-23 15:50:37 +00009082 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00009083
David Horstmannc5cc1c32023-11-15 18:11:26 +00009084 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00009085 return PSA_SUCCESS;
9086 }
9087
David Horstmannf1734052023-11-20 17:15:32 +00009088 local_input->buffer = mbedtls_calloc(input_len, 1);
9089 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00009090 /* Since we dealt with the zero-length case above, we know that
9091 * a NULL return value means a failure of allocation. */
9092 return PSA_ERROR_INSUFFICIENT_MEMORY;
9093 }
David Horstmannf1734052023-11-20 17:15:32 +00009094 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00009095
David Horstmannf1734052023-11-20 17:15:32 +00009096 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00009097
9098 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00009099 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00009100 if (status != PSA_SUCCESS) {
9101 goto error;
9102 }
9103
9104 return PSA_SUCCESS;
9105
9106error:
David Horstmannf1734052023-11-20 17:15:32 +00009107 mbedtls_free(local_input->buffer);
9108 local_input->buffer = NULL;
9109 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00009110 return status;
9111}
9112
David Horstmannf1734052023-11-20 17:15:32 +00009113void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00009114{
David Horstmannf1734052023-11-20 17:15:32 +00009115 mbedtls_free(local_input->buffer);
9116 local_input->buffer = NULL;
9117 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00009118}
9119
David Horstmann89875a42023-11-20 12:54:09 +00009120psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
9121 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00009122{
David Horstmann9db14482023-11-23 15:50:37 +00009123 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00009124
David Horstmannc5cc1c32023-11-15 18:11:26 +00009125 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00009126 return PSA_SUCCESS;
9127 }
David Horstmann89875a42023-11-20 12:54:09 +00009128 local_output->buffer = mbedtls_calloc(output_len, 1);
9129 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00009130 /* Since we dealt with the zero-length case above, we know that
9131 * a NULL return value means a failure of allocation. */
9132 return PSA_ERROR_INSUFFICIENT_MEMORY;
9133 }
David Horstmann89875a42023-11-20 12:54:09 +00009134 local_output->length = output_len;
9135 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00009136
9137 return PSA_SUCCESS;
9138}
9139
David Horstmann89875a42023-11-20 12:54:09 +00009140psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00009141{
David Horstmannc335a4e2023-11-15 15:57:32 +00009142 psa_status_t status;
9143
David Horstmann89875a42023-11-20 12:54:09 +00009144 if (local_output->buffer == NULL) {
9145 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00009146 return PSA_SUCCESS;
9147 }
David Horstmann89875a42023-11-20 12:54:09 +00009148 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00009149 /* We have an internal copy but nothing to copy back to. */
9150 return PSA_ERROR_CORRUPTION_DETECTED;
9151 }
9152
David Horstmann89875a42023-11-20 12:54:09 +00009153 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
9154 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00009155 if (status != PSA_SUCCESS) {
9156 return status;
9157 }
David Horstmann9467ea32023-11-08 17:44:18 +00009158
David Horstmann89875a42023-11-20 12:54:09 +00009159 mbedtls_free(local_output->buffer);
9160 local_output->buffer = NULL;
9161 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00009162
9163 return PSA_SUCCESS;
9164}
9165
Gilles Peskinee59236f2018-01-27 23:32:46 +01009166#endif /* MBEDTLS_PSA_CRYPTO_C */