blob: 1a5658d35135363999c8e98bcf31787e60630205 [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));
Ryan Everettb5a20d32023-11-15 16:26:01 +00001838 if (status != PSA_SUCCESS) {
1839 return status;
1840 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001841 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001842
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001844 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001846 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001847#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1848
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001850}
Gilles Peskine4747d192019-04-17 15:05:45 +02001851
1852/** Finalize the creation of a key once its key material has been set.
1853 *
1854 * This entails writing the key to persistent storage.
1855 *
1856 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001857 * See the documentation of psa_start_key_creation() for the intended use
1858 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001859 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001860 * If the finalization succeeds, the function sets the key slot's state to
1861 * PSA_SLOT_FULL, and the key slot can no longer be accessed as part of the
1862 * key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001863 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001864 * \param[in,out] slot Pointer to the slot with key material.
1865 * \param[in] driver The secure element driver for the key,
1866 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001867 * \param[out] key On success, identifier of the key. Note that the
1868 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001869 *
1870 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001871 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001872 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1873 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1874 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1875 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1876 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1877 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001878 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001879 * \return If this function fails, the key slot is an invalid state.
1880 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001881 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001882static psa_status_t psa_finish_key_creation(
1883 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001884 psa_se_drv_table_entry_t *driver,
1885 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001886{
1887 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001888 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001889 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001890
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001891#if defined(MBEDTLS_THREADING_C)
1892 PSA_THREADING_CHK_RET(mbedtls_mutex_lock(
1893 &mbedtls_threading_key_slot_mutex));
1894#endif
1895
Gilles Peskine4747d192019-04-17 15:05:45 +02001896#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001897 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001898#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001899 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001900 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001901 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001902 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001903
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001904 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1905 sizeof(data.slot_number),
1906 "Slot number size does not match psa_se_key_data_storage_t");
1907
Gilles Peskine449bd832023-01-11 14:50:10 +01001908 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1909 status = psa_save_persistent_key(&slot->attr,
1910 (uint8_t *) &data,
1911 sizeof(data));
1912 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001913#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1914 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001915 /* Key material is saved in export representation in the slot, so
1916 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001917 status = psa_save_persistent_key(&slot->attr,
1918 slot->key.data,
1919 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001920 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001921 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001922#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1923
Gilles Peskinecbaff462019-07-12 23:46:04 +02001924#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001925 /* Finish the transaction for a key creation. This does not
1926 * happen when registering an existing key. Detect this case
1927 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001928 * creation of a persistent key in a secure element requires a transaction,
1929 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001930 if (driver != NULL &&
1931 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1932 status = psa_save_se_persistent_data(driver);
1933 if (status != PSA_SUCCESS) {
1934 psa_destroy_persistent_key(slot->attr.id);
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001935
1936#if defined(MBEDTLS_THREADING_C)
1937 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1938 &mbedtls_threading_key_slot_mutex));
1939#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001940 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001941 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001942 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001943 }
1944#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1945
Gilles Peskine449bd832023-01-11 14:50:10 +01001946 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001947 *key = slot->attr.id;
Ryan Everettb69118e2024-01-02 15:54:32 +00001948 status = psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1949 PSA_SLOT_FULL);
Gilles Peskine449bd832023-01-11 14:50:10 +01001950 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001951 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001953 }
Ronald Cron50972942020-11-14 11:28:25 +01001954
Ryan Everett91ffe5b2024-01-23 20:05:42 +00001955#if defined(MBEDTLS_THREADING_C)
1956 PSA_THREADING_CHK_RET(mbedtls_mutex_unlock(
1957 &mbedtls_threading_key_slot_mutex));
1958#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001960}
1961
1962/** Abort the creation of a key.
1963 *
1964 * You may call this function after calling psa_start_key_creation(),
1965 * or after psa_finish_key_creation() fails. In other circumstances, this
1966 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001967 * See the documentation of psa_start_key_creation() for the intended use
Ryan Everettb69118e2024-01-02 15:54:32 +00001968 * of this function. Sets the slot's state to PSA_SLOT_EMPTY.
Gilles Peskine4747d192019-04-17 15:05:45 +02001969 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001970 * \param[in,out] slot Pointer to the slot with key material.
1971 * \param[in] driver The secure element driver for the key,
1972 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001973 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001974static void psa_fail_key_creation(psa_key_slot_t *slot,
1975 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001976{
Gilles Peskine011e4282019-06-26 18:34:38 +02001977 (void) driver;
1978
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001980 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001982
Ryan Everettb7101442024-01-23 20:09:49 +00001983#if defined(MBEDTLS_THREADING_C)
Ryan Everett73feaf22024-02-14 11:36:41 +00001984 /* If the lock operation fails we still wipe the slot.
1985 * Operations will no longer work after a failed lock,
1986 * but we still need to wipe the slot of confidential data. */
Ryan Everettb7101442024-01-23 20:09:49 +00001987 mbedtls_mutex_lock(&mbedtls_threading_key_slot_mutex);
1988#endif
1989
Gilles Peskine011e4282019-06-26 18:34:38 +02001990#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001991 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001992 * element, and the failure happened later (when saving metadata
1993 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001994 * element.
1995 * https://github.com/ARMmbed/mbed-crypto/issues/217
1996 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001997
Gilles Peskined7729582019-08-05 15:55:54 +02001998 /* Abort the ongoing transaction if any (there may not be one if
1999 * the creation process failed before starting one, or if the
2000 * key creation is a registration of a key in a secure element).
2001 * Earlier functions must already have done what it takes to undo any
2002 * partial creation. All that's left is to update the transaction data
2003 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002004 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02002005#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2006
Gilles Peskine449bd832023-01-11 14:50:10 +01002007 psa_wipe_key_slot(slot);
Ryan Everettb7101442024-01-23 20:09:49 +00002008
2009#if defined(MBEDTLS_THREADING_C)
2010 mbedtls_mutex_unlock(&mbedtls_threading_key_slot_mutex);
2011#endif
Gilles Peskine4747d192019-04-17 15:05:45 +02002012}
2013
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002014/** Validate optional attributes during key creation.
2015 *
2016 * Some key attributes are optional during key creation. If they are
2017 * specified in the attributes structure, check that they are consistent
2018 * with the data in the slot.
2019 *
2020 * This function should be called near the end of key creation, after
2021 * the slot in memory is fully populated but before saving persistent data.
2022 */
2023static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002024 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01002025 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002026{
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002027 if (attributes->type != 0) {
2028 if (attributes->type != slot->attr.type) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002029 return PSA_ERROR_INVALID_ARGUMENT;
2030 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002031 }
2032
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002033 if (attributes->bits != 0) {
2034 if (attributes->bits != slot->attr.bits) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 return PSA_ERROR_INVALID_ARGUMENT;
2036 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002037 }
2038
Gilles Peskine449bd832023-01-11 14:50:10 +01002039 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002040}
2041
Gilles Peskine449bd832023-01-11 14:50:10 +01002042psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
Ryan Everettf028fe12024-01-08 17:14:44 +00002043 const uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002044 size_t data_length,
2045 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002046{
2047 psa_status_t status;
Ryan Everettf028fe12024-01-08 17:14:44 +00002048 LOCAL_INPUT_DECLARE(data_external, data);
Gilles Peskine4747d192019-04-17 15:05:45 +02002049 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002050 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002051 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302052 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002053
Ronald Cron81709fc2020-11-14 12:10:32 +01002054 *key = MBEDTLS_SVC_KEY_ID_INIT;
2055
Gilles Peskine0f84d622019-09-12 19:03:13 +02002056 /* Reject zero-length symmetric keys (including raw data key objects).
2057 * This also rejects any key which might be encoded as an empty string,
2058 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002059 if (data_length == 0) {
2060 return PSA_ERROR_INVALID_ARGUMENT;
2061 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002062
Archana449608b2021-09-08 15:36:05 +05302063 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002064 if (data_length > SIZE_MAX / 8) {
2065 return PSA_ERROR_NOT_SUPPORTED;
2066 }
Archana6ed4bda2021-08-04 10:47:15 +05302067
Ryan Everettf028fe12024-01-08 17:14:44 +00002068 LOCAL_INPUT_ALLOC(data_external, data_length, data);
2069
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2071 &slot, &driver);
2072 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002073 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002075
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002076 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302077 * storage ( thus not in the case of importing a key in a secure element
2078 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2079 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002080 if (slot->key.data == NULL) {
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002081 if (psa_key_lifetime_is_external(attributes->lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302082 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 attributes, data, data_length, &storage_size);
2084 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302085 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002086 }
Archanad8a83dc2021-06-14 10:04:16 +05302087 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002088 status = psa_allocate_buffer_to_slot(slot, storage_size);
2089 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002090 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002091 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002092 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002093
2094 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 status = psa_driver_wrapper_import_key(attributes,
2096 data, data_length,
2097 slot->key.data,
2098 slot->key.bytes,
2099 &slot->key.bytes, &bits);
2100 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002101 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002102 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002103
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002105 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002107 status = PSA_ERROR_INVALID_ARGUMENT;
2108 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002109 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002110
Archana6ed4bda2021-08-04 10:47:15 +05302111 /* Enforce a size limit, and in particular ensure that the bit
2112 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302114 status = PSA_ERROR_NOT_SUPPORTED;
2115 goto exit;
2116 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 status = psa_validate_optional_attributes(slot, attributes);
2118 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002119 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002121
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002123exit:
Ryan Everettf028fe12024-01-08 17:14:44 +00002124 LOCAL_INPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 if (status != PSA_SUCCESS) {
2126 psa_fail_key_creation(slot, driver);
2127 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002128
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002130}
2131
Gilles Peskined7729582019-08-05 15:55:54 +02002132#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2133psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002135{
2136 psa_status_t status;
2137 psa_key_slot_t *slot = NULL;
2138 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002139 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002140
2141 /* Leaving attributes unspecified is not currently supported.
2142 * It could make sense to query the key type and size from the
2143 * secure element, but not all secure elements support this
2144 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002145 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2146 return PSA_ERROR_NOT_SUPPORTED;
2147 }
2148 if (psa_get_key_bits(attributes) == 0) {
2149 return PSA_ERROR_NOT_SUPPORTED;
2150 }
Gilles Peskined7729582019-08-05 15:55:54 +02002151
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2153 &slot, &driver);
2154 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002155 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 }
Gilles Peskined7729582019-08-05 15:55:54 +02002157
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002159
2160exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002161 if (status != PSA_SUCCESS) {
2162 psa_fail_key_creation(slot, driver);
2163 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002164
Gilles Peskined7729582019-08-05 15:55:54 +02002165 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 psa_close_key(key);
2167 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002168}
2169#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2170
Gilles Peskine449bd832023-01-11 14:50:10 +01002171psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2172 const psa_key_attributes_t *specified_attributes,
2173 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002174{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002175 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002176 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002177 psa_key_slot_t *source_slot = NULL;
2178 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002179 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002180 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302181 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002182
Ronald Cron81709fc2020-11-14 12:10:32 +01002183 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2184
Archana8a180362021-07-05 02:18:48 +05302185 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002186 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2187 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002188 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002190
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 status = psa_validate_optional_attributes(source_slot,
2192 specified_attributes);
2193 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002194 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002196
Archana9d17bf42021-09-10 06:22:44 +05302197 /* The target key type and number of bits have been validated by
2198 * psa_validate_optional_attributes() to be either equal to zero or
2199 * equal to the ones of the source key. So it is safe to inherit
2200 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302201 * */
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002202 actual_attributes.bits = source_slot->attr.bits;
2203 actual_attributes.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302204
2205
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 status = psa_restrict_key_policy(source_slot->attr.type,
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002207 &actual_attributes.policy,
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 &source_slot->attr.policy);
2209 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002210 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002212
Gilles Peskine449bd832023-01-11 14:50:10 +01002213 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2214 &target_slot, &driver);
2215 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002216 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 }
2218 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2219 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302220 /*
Archana9d17bf42021-09-10 06:22:44 +05302221 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302222 * the source key would need to be exported as plaintext and re-imported
2223 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302224 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302225 * appropriate API invocations from the application, if needed.
2226 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002227 status = PSA_ERROR_NOT_SUPPORTED;
2228 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002229 }
Archana8a180362021-07-05 02:18:48 +05302230 /*
2231 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302232 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302233 * - For opaque keys this translates to an invocation of the drivers'
2234 * copy_key entry point through the dispatch layer.
2235 * */
Gilles Peskine2f107ae2024-02-28 01:26:46 +01002236 if (psa_key_lifetime_is_external(actual_attributes.lifetime)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002237 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2238 &storage_size);
2239 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302240 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002241 }
Archana374fe5b2021-09-08 15:50:28 +05302242
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2244 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302245 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 }
Archana374fe5b2021-09-08 15:50:28 +05302247
Gilles Peskine449bd832023-01-11 14:50:10 +01002248 status = psa_driver_wrapper_copy_key(&actual_attributes,
2249 source_slot->key.data,
2250 source_slot->key.bytes,
2251 target_slot->key.data,
2252 target_slot->key.bytes,
2253 &target_slot->key.bytes);
2254 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302255 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 }
2257 } else {
2258 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302259 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002260 source_slot->key.bytes);
2261 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302262 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002263 }
Archana8a180362021-07-05 02:18:48 +05302264 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002266exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 if (status != PSA_SUCCESS) {
2268 psa_fail_key_creation(target_slot, driver);
2269 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002270
Ryan Everetta103ec92024-01-31 13:59:57 +00002271 unlock_status = psa_unregister_read_under_mutex(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002272
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002274}
2275
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002276
2277
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002278/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002279/* Message digests */
2280/****************************************************************/
2281
Gilles Peskine449bd832023-01-11 14:50:10 +01002282psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002283{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002284 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002285 if (operation->id == 0) {
2286 return PSA_SUCCESS;
2287 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002288
Gilles Peskine449bd832023-01-11 14:50:10 +01002289 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002290 operation->id = 0;
2291
Gilles Peskine449bd832023-01-11 14:50:10 +01002292 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002293}
2294
Gilles Peskine449bd832023-01-11 14:50:10 +01002295psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2296 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002297{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002298 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002299
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002300 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002302 status = PSA_ERROR_BAD_STATE;
2303 goto exit;
2304 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002305
Gilles Peskine449bd832023-01-11 14:50:10 +01002306 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002307 status = PSA_ERROR_INVALID_ARGUMENT;
2308 goto exit;
2309 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002310
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002311 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2312 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002314
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002316
2317exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002318 if (status != PSA_SUCCESS) {
2319 psa_hash_abort(operation);
2320 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002321
2322 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002323}
2324
Gilles Peskine449bd832023-01-11 14:50:10 +01002325psa_status_t psa_hash_update(psa_hash_operation_t *operation,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002326 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002328{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002329 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002330 LOCAL_INPUT_DECLARE(input_external, input);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002331
Gilles Peskine449bd832023-01-11 14:50:10 +01002332 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002333 status = PSA_ERROR_BAD_STATE;
2334 goto exit;
2335 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002336
Steven Cooremanc8288352021-03-04 14:02:19 +01002337 /* Don't require hash implementations to behave correctly on a
2338 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002339 if (input_length == 0) {
2340 return PSA_SUCCESS;
2341 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002342
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002343 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002345
2346exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002347 if (status != PSA_SUCCESS) {
2348 psa_hash_abort(operation);
2349 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002350
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002351 LOCAL_INPUT_FREE(input_external, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002353}
2354
Thomas Daubney31d8c0b2024-01-18 15:26:59 +00002355static psa_status_t psa_hash_finish_internal(psa_hash_operation_t *operation,
Thomas Daubneyd2411562024-01-25 17:25:07 +00002356 uint8_t *hash,
2357 size_t hash_size,
2358 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002359{
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002360 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2361
Steven Cooremanfbe09282021-03-08 18:41:12 +01002362 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002363 if (operation->id == 0) {
2364 return PSA_ERROR_BAD_STATE;
2365 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002366
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002367 status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002368 operation, hash, hash_size, hash_length);
2369 psa_hash_abort(operation);
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002370
2371 return status;
2372}
2373
2374psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2375 uint8_t *hash_external,
2376 size_t hash_size,
2377 size_t *hash_length)
2378{
2379 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2380 LOCAL_OUTPUT_DECLARE(hash_external, hash);
2381
2382 LOCAL_OUTPUT_ALLOC(hash_external, hash_size, hash);
2383 status = psa_hash_finish_internal(operation, hash, hash_size, hash_length);
2384
David Horstmann4a48bec2024-03-13 15:42:31 +00002385#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002386exit:
Thomas Daubneydedd1002024-01-25 16:52:50 +00002387#endif
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002388 LOCAL_OUTPUT_FREE(hash_external, hash);
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002390}
2391
Gilles Peskine449bd832023-01-11 14:50:10 +01002392psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002393 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002395{
Ronald Cron69a63422021-10-18 09:47:58 +02002396 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002397 size_t actual_hash_length;
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002398 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2399 LOCAL_INPUT_DECLARE(hash_external, hash);
2400
2401 status = psa_hash_finish_internal(
Gilles Peskine449bd832023-01-11 14:50:10 +01002402 operation,
2403 actual_hash, sizeof(actual_hash),
2404 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002405
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002407 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002409
Gilles Peskine449bd832023-01-11 14:50:10 +01002410 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002411 status = PSA_ERROR_INVALID_SIGNATURE;
2412 goto exit;
2413 }
2414
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002415 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
Dave Rodgman78701152023-08-29 14:20:18 +01002416 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002417 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002419
2420exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002421 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2422 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002423 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002424 }
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002425 LOCAL_INPUT_FREE(hash_external, hash);
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002427}
2428
Gilles Peskine449bd832023-01-11 14:50:10 +01002429psa_status_t psa_hash_compute(psa_algorithm_t alg,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002430 const uint8_t *input_external, size_t input_length,
2431 uint8_t *hash_external, size_t hash_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002433{
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002434 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2435 LOCAL_INPUT_DECLARE(input_external, input);
2436 LOCAL_OUTPUT_DECLARE(hash_external, hash);
2437
Steven Cooremanfbe09282021-03-08 18:41:12 +01002438 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002439 if (!PSA_ALG_IS_HASH(alg)) {
2440 return PSA_ERROR_INVALID_ARGUMENT;
2441 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002442
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002443 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2444 LOCAL_OUTPUT_ALLOC(hash_external, hash_size, hash);
2445 status = psa_driver_wrapper_hash_compute(alg, input, input_length,
Thomas Daubneyd2411562024-01-25 17:25:07 +00002446 hash, hash_size, hash_length);
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002447
David Horstmann4a48bec2024-03-13 15:42:31 +00002448#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002449exit:
Thomas Daubneydedd1002024-01-25 16:52:50 +00002450#endif
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002451 LOCAL_INPUT_FREE(input_external, input);
2452 LOCAL_OUTPUT_FREE(hash_external, hash);
2453 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002454}
2455
Gilles Peskine449bd832023-01-11 14:50:10 +01002456psa_status_t psa_hash_compare(psa_algorithm_t alg,
Thomas Daubney51ffac92024-01-18 15:46:26 +00002457 const uint8_t *input_external, size_t input_length,
2458 const uint8_t *hash_external, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002459{
Ronald Cron69a63422021-10-18 09:47:58 +02002460 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002461 size_t actual_hash_length;
Thomas Daubney51ffac92024-01-18 15:46:26 +00002462 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2463
2464 LOCAL_INPUT_DECLARE(input_external, input);
2465 LOCAL_INPUT_DECLARE(hash_external, hash);
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002466
Gilles Peskine449bd832023-01-11 14:50:10 +01002467 if (!PSA_ALG_IS_HASH(alg)) {
Thomas Daubney51ffac92024-01-18 15:46:26 +00002468 status = PSA_ERROR_INVALID_ARGUMENT;
2469 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002470 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002471
Thomas Daubney51ffac92024-01-18 15:46:26 +00002472 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2473 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002474 alg, input, input_length,
2475 actual_hash, sizeof(actual_hash),
2476 &actual_hash_length);
2477 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002478 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002479 }
2480 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002481 status = PSA_ERROR_INVALID_SIGNATURE;
2482 goto exit;
2483 }
Thomas Daubney51ffac92024-01-18 15:46:26 +00002484
2485 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
Dave Rodgman78701152023-08-29 14:20:18 +01002486 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002487 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002488 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002489
2490exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002491 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
Thomas Daubney51ffac92024-01-18 15:46:26 +00002492
2493 LOCAL_INPUT_FREE(input_external, input);
2494 LOCAL_INPUT_FREE(hash_external, hash);
2495
Gilles Peskine449bd832023-01-11 14:50:10 +01002496 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002497}
2498
Gilles Peskine449bd832023-01-11 14:50:10 +01002499psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2500 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002501{
Gilles Peskine449bd832023-01-11 14:50:10 +01002502 if (source_operation->id == 0 ||
2503 target_operation->id != 0) {
2504 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002505 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002506
Gilles Peskine449bd832023-01-11 14:50:10 +01002507 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2508 target_operation);
2509 if (status != PSA_SUCCESS) {
2510 psa_hash_abort(target_operation);
2511 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002512
Gilles Peskine449bd832023-01-11 14:50:10 +01002513 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002514}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002515
2516
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002517/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002518/* MAC */
2519/****************************************************************/
2520
Gilles Peskine449bd832023-01-11 14:50:10 +01002521psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002522{
Steven Cooremane6804192021-03-19 18:28:56 +01002523 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002524 if (operation->id == 0) {
2525 return PSA_SUCCESS;
2526 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002527
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002529 operation->mac_size = 0;
2530 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002531 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002532
Gilles Peskine449bd832023-01-11 14:50:10 +01002533 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002534}
2535
Ronald Cron2dff3b22021-06-17 16:33:22 +02002536static psa_status_t psa_mac_finalize_alg_and_key_validation(
2537 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002538 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002540{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002541 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002542 psa_key_type_t key_type = psa_get_key_type(attributes);
2543 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002544
Gilles Peskine449bd832023-01-11 14:50:10 +01002545 if (!PSA_ALG_IS_MAC(alg)) {
2546 return PSA_ERROR_INVALID_ARGUMENT;
2547 }
Steven Cooremane6804192021-03-19 18:28:56 +01002548
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002549 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 status = psa_mac_key_can_do(alg, key_type);
2551 if (status != PSA_SUCCESS) {
2552 return status;
2553 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002554
Steven Cooremand1a68f12021-05-10 11:13:41 +02002555 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002557
Gilles Peskine449bd832023-01-11 14:50:10 +01002558 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002559 /* A very short MAC is too short for security since it can be
2560 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2561 * so we make this our minimum, even though 32 bits is still
2562 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002564 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002565
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2567 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002568 /* It's impossible to "truncate" to a larger length than the full length
2569 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002571 }
2572
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002574 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2575 * that is disabled in the compile-time configuration. The result can
2576 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2577 * configuration into account. In this case, force a return of
2578 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2579 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2580 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2581 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2582 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002583 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002584 }
2585
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002587}
2588
Gilles Peskine449bd832023-01-11 14:50:10 +01002589static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2590 mbedtls_svc_key_id_t key,
2591 psa_algorithm_t alg,
2592 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002593{
2594 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2595 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002596 psa_key_slot_t *slot = NULL;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002597
2598 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002599 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002600 status = PSA_ERROR_BAD_STATE;
2601 goto exit;
2602 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002603
2604 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002605 key,
2606 &slot,
2607 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2608 alg);
2609 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002610 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002611 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002612
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002613 status = psa_mac_finalize_alg_and_key_validation(alg, &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002614 &operation->mac_size);
2615 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002616 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002617 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002618
2619 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002620 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002621 if (is_sign) {
2622 status = psa_driver_wrapper_mac_sign_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002623 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002624 slot->key.data,
2625 slot->key.bytes,
2626 alg);
2627 } else {
2628 status = psa_driver_wrapper_mac_verify_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002629 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 slot->key.data,
2631 slot->key.bytes,
2632 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002633 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002634
Gilles Peskinefbfac682018-07-08 20:51:54 +02002635exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002636 if (status != PSA_SUCCESS) {
2637 psa_mac_abort(operation);
2638 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002639
Ryan Everettfb9857f2024-02-14 12:16:41 +00002640 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002641
Gilles Peskine449bd832023-01-11 14:50:10 +01002642 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002643}
2644
Gilles Peskine449bd832023-01-11 14:50:10 +01002645psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2646 mbedtls_svc_key_id_t key,
2647 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002648{
Gilles Peskine449bd832023-01-11 14:50:10 +01002649 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002650}
2651
Gilles Peskine449bd832023-01-11 14:50:10 +01002652psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2653 mbedtls_svc_key_id_t key,
2654 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002655{
Gilles Peskine449bd832023-01-11 14:50:10 +01002656 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002657}
2658
Gilles Peskine449bd832023-01-11 14:50:10 +01002659psa_status_t psa_mac_update(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002660 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002662{
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002663 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2664 LOCAL_INPUT_DECLARE(input_external, input);
2665
Gilles Peskine449bd832023-01-11 14:50:10 +01002666 if (operation->id == 0) {
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002667 status = PSA_ERROR_BAD_STATE;
2668 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002669 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002670
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002671 /* Don't require hash implementations to behave correctly on a
2672 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002673 if (input_length == 0) {
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002674 status = PSA_SUCCESS;
2675 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002676 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002677
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002678 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2679 status = psa_driver_wrapper_mac_update(operation, input, input_length);
2680
Gilles Peskine449bd832023-01-11 14:50:10 +01002681 if (status != PSA_SUCCESS) {
2682 psa_mac_abort(operation);
2683 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002684
David Horstmann4a48bec2024-03-13 15:42:31 +00002685#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002686exit:
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002687#endif
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002688 LOCAL_INPUT_FREE(input_external, input);
2689
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002691}
2692
Gilles Peskine449bd832023-01-11 14:50:10 +01002693psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002694 uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002695 size_t mac_size,
2696 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002697{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002698 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2699 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002700 LOCAL_OUTPUT_DECLARE(mac_external, mac);
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002701 LOCAL_OUTPUT_ALLOC(mac_external, mac_size, mac);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002702
Gilles Peskine449bd832023-01-11 14:50:10 +01002703 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002704 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002705 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002706 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002707
Gilles Peskine449bd832023-01-11 14:50:10 +01002708 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002709 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002710 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002711 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002712
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002713 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2714 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002715 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002716 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002717 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002718 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002719
Gilles Peskine449bd832023-01-11 14:50:10 +01002720 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002721 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002722 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002723 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002724
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002725
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 status = psa_driver_wrapper_mac_sign_finish(operation,
2727 mac, operation->mac_size,
2728 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002729
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002730exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002731 /* In case of success, set the potential excess room in the output buffer
2732 * to an invalid value, to avoid potentially leaking a longer MAC.
2733 * In case of error, set the output length and content to a safe default,
2734 * such that in case the caller misses an error check, the output would be
2735 * an unachievable MAC.
2736 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002737 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002738 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002739 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002740 }
mohammad16036df908f2018-04-02 08:34:15 -07002741
Thomas Daubney03f1ea32024-02-01 16:16:27 +00002742 if (mac != NULL) {
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002743 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
2744 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002745
Gilles Peskine449bd832023-01-11 14:50:10 +01002746 abort_status = psa_mac_abort(operation);
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002747 LOCAL_OUTPUT_FREE(mac_external, mac);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002748
Gilles Peskine449bd832023-01-11 14:50:10 +01002749 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002750}
2751
Gilles Peskine449bd832023-01-11 14:50:10 +01002752psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002753 const uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002754 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002755{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002756 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2757 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002758 LOCAL_INPUT_DECLARE(mac_external, mac);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002759
Gilles Peskine449bd832023-01-11 14:50:10 +01002760 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002761 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002762 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002763 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002764
Gilles Peskine449bd832023-01-11 14:50:10 +01002765 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002766 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002767 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002768 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002769
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002771 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002772 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002773 }
2774
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002775 LOCAL_INPUT_ALLOC(mac_external, mac_length, mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01002776 status = psa_driver_wrapper_mac_verify_finish(operation,
2777 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002778
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002779exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 abort_status = psa_mac_abort(operation);
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002781 LOCAL_INPUT_FREE(mac_external, mac);
mohammad16036df908f2018-04-02 08:34:15 -07002782
Gilles Peskine449bd832023-01-11 14:50:10 +01002783 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002784}
2785
Gilles Peskine449bd832023-01-11 14:50:10 +01002786static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2787 psa_algorithm_t alg,
2788 const uint8_t *input,
2789 size_t input_length,
2790 uint8_t *mac,
2791 size_t mac_size,
2792 size_t *mac_length,
2793 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002794{
2795 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002796 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2797 psa_key_slot_t *slot;
2798 uint8_t operation_mac_size = 0;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002799
Ronald Cron51131b52021-06-17 17:17:20 +02002800 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 key,
2802 &slot,
2803 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2804 alg);
2805 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002806 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002808
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002809 status = psa_mac_finalize_alg_and_key_validation(alg, &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002810 &operation_mac_size);
2811 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002812 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002814
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002816 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002817 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002818 }
2819
2820 status = psa_driver_wrapper_mac_compute(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002821 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01002822 slot->key.data, slot->key.bytes,
2823 alg,
2824 input, input_length,
2825 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002826
2827exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002828 /* In case of success, set the potential excess room in the output buffer
2829 * to an invalid value, to avoid potentially leaking a longer MAC.
2830 * In case of error, set the output length and content to a safe default,
2831 * such that in case the caller misses an error check, the output would be
2832 * an unachievable MAC.
2833 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002834 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002835 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002836 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002837 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002838
2839 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002840
Ryan Everetta103ec92024-01-31 13:59:57 +00002841 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002842
Gilles Peskine449bd832023-01-11 14:50:10 +01002843 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002844}
2845
Gilles Peskine449bd832023-01-11 14:50:10 +01002846psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002847 psa_algorithm_t alg,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002848 const uint8_t *input_external,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002849 size_t input_length,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002850 uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 size_t mac_size,
2852 size_t *mac_length)
2853{
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002854 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2855 LOCAL_INPUT_DECLARE(input_external, input);
2856 LOCAL_OUTPUT_DECLARE(mac_external, mac);
2857
2858 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2859 LOCAL_OUTPUT_ALLOC(mac_external, mac_size, mac);
2860 status = psa_mac_compute_internal(key, alg,
Thomas Daubney7480a742024-01-30 11:29:47 +00002861 input, input_length,
2862 mac, mac_size, mac_length, 1);
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002863
David Horstmann4a48bec2024-03-13 15:42:31 +00002864#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002865exit:
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002866#endif
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002867 LOCAL_INPUT_FREE(input_external, input);
2868 LOCAL_OUTPUT_FREE(mac_external, mac);
2869
2870 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002871}
2872
2873psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2874 psa_algorithm_t alg,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002875 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 size_t input_length,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002877 const uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002878 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002879{
2880 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002881 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2882 size_t actual_mac_length;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002883 LOCAL_INPUT_DECLARE(input_external, input);
2884 LOCAL_INPUT_DECLARE(mac_external, mac);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002885
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002886 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 status = psa_mac_compute_internal(key, alg,
2888 input, input_length,
2889 actual_mac, sizeof(actual_mac),
2890 &actual_mac_length, 0);
2891 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002892 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002893 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002894
Gilles Peskine449bd832023-01-11 14:50:10 +01002895 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002896 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002897 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002898 }
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002899
2900 LOCAL_INPUT_ALLOC(mac_external, mac_length, mac);
Dave Rodgman78701152023-08-29 14:20:18 +01002901 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002902 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002903 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002904 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002905
2906exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002907 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002908 LOCAL_INPUT_FREE(input_external, input);
2909 LOCAL_INPUT_FREE(mac_external, mac);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002910
Gilles Peskine449bd832023-01-11 14:50:10 +01002911 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002912}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002913
Gilles Peskinee59236f2018-01-27 23:32:46 +01002914/****************************************************************/
2915/* Asymmetric cryptography */
2916/****************************************************************/
2917
Gilles Peskine449bd832023-01-11 14:50:10 +01002918static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2919 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002920{
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 if (input_is_message) {
2922 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2923 return PSA_ERROR_INVALID_ARGUMENT;
2924 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002925
Gilles Peskine449bd832023-01-11 14:50:10 +01002926 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2927 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2928 return PSA_ERROR_INVALID_ARGUMENT;
2929 }
2930 }
2931 } else {
2932 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2933 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002934 }
2935 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002936
Gilles Peskine449bd832023-01-11 14:50:10 +01002937 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002938}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002939
Gilles Peskine449bd832023-01-11 14:50:10 +01002940static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2941 int input_is_message,
2942 psa_algorithm_t alg,
2943 const uint8_t *input,
2944 size_t input_length,
2945 uint8_t *signature,
2946 size_t signature_size,
2947 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002948{
2949 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2950 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2951 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002952
2953 *signature_length = 0;
2954
Gilles Peskine449bd832023-01-11 14:50:10 +01002955 status = psa_sign_verify_check_alg(input_is_message, alg);
2956 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002957 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002959
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002960 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002961 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002962 * buffer can in principle be empty since it doesn't actually have
2963 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002964 if (signature_size == 0) {
2965 return PSA_ERROR_BUFFER_TOO_SMALL;
2966 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002967
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002968 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002969 key, &slot,
2970 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2971 PSA_KEY_USAGE_SIGN_HASH,
2972 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002973
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002975 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002977
Gilles Peskine449bd832023-01-11 14:50:10 +01002978 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002979 status = PSA_ERROR_INVALID_ARGUMENT;
2980 goto exit;
2981 }
2982
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002984 status = psa_driver_wrapper_sign_message(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002985 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002986 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002987 signature, signature_size, signature_length);
2988 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002989
2990 status = psa_driver_wrapper_sign_hash(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01002991 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002992 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002993 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002994 }
2995
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002996
2997exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002998 psa_wipe_tag_output_buffer(signature, status, signature_size,
2999 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003000
Ryan Everetta103ec92024-01-31 13:59:57 +00003001 unlock_status = psa_unregister_read_under_mutex(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003002
Gilles Peskine449bd832023-01-11 14:50:10 +01003003 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003004}
3005
Gilles Peskine449bd832023-01-11 14:50:10 +01003006static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
3007 int input_is_message,
3008 psa_algorithm_t alg,
3009 const uint8_t *input,
3010 size_t input_length,
3011 const uint8_t *signature,
3012 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003013{
3014 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3015 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3016 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003017
Gilles Peskine449bd832023-01-11 14:50:10 +01003018 status = psa_sign_verify_check_alg(input_is_message, alg);
3019 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003020 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003022
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003023 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003024 key, &slot,
3025 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
3026 PSA_KEY_USAGE_VERIFY_HASH,
3027 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003028
Gilles Peskine449bd832023-01-11 14:50:10 +01003029 if (status != PSA_SUCCESS) {
3030 return status;
3031 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003032
Gilles Peskine449bd832023-01-11 14:50:10 +01003033 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003034 status = psa_driver_wrapper_verify_message(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003035 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003036 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003037 signature, signature_length);
3038 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003039 status = psa_driver_wrapper_verify_hash(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003040 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003041 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003043 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003044
Ryan Everetta103ec92024-01-31 13:59:57 +00003045 unlock_status = psa_unregister_read_under_mutex(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003046
Gilles Peskine449bd832023-01-11 14:50:10 +01003047 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003048
3049}
3050
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003051psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003052 const psa_key_attributes_t *attributes,
3053 const uint8_t *key_buffer,
3054 size_t key_buffer_size,
3055 psa_algorithm_t alg,
3056 const uint8_t *input,
3057 size_t input_length,
3058 uint8_t *signature,
3059 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01003060 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003061{
3062 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003063
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003065 size_t hash_length;
3066 uint8_t hash[PSA_HASH_MAX_SIZE];
3067
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003068 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003069 PSA_ALG_SIGN_GET_HASH(alg),
3070 input, input_length,
3071 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003072
Gilles Peskine449bd832023-01-11 14:50:10 +01003073 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003074 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003075 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003076
3077 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003078 attributes, key_buffer, key_buffer_size,
3079 alg, hash, hash_length,
3080 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003081 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003082
Gilles Peskine449bd832023-01-11 14:50:10 +01003083 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003084}
3085
Gilles Peskine449bd832023-01-11 14:50:10 +01003086psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3087 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003088 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003089 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003090 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003091 size_t signature_size,
3092 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003093{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003094 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3095 LOCAL_INPUT_DECLARE(input_external, input);
3096 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3097
3098 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3099 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3100 status = psa_sign_internal(key, 1, alg, input, input_length, signature,
3101 signature_size, signature_length);
3102
David Horstmann4a48bec2024-03-13 15:42:31 +00003103#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003104exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003105#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003106 LOCAL_INPUT_FREE(input_external, input);
3107 LOCAL_OUTPUT_FREE(signature_external, signature);
3108 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003109}
3110
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003111psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003112 const psa_key_attributes_t *attributes,
3113 const uint8_t *key_buffer,
3114 size_t key_buffer_size,
3115 psa_algorithm_t alg,
3116 const uint8_t *input,
3117 size_t input_length,
3118 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003119 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003120{
3121 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003122
Gilles Peskine449bd832023-01-11 14:50:10 +01003123 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003124 size_t hash_length;
3125 uint8_t hash[PSA_HASH_MAX_SIZE];
3126
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003127 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003128 PSA_ALG_SIGN_GET_HASH(alg),
3129 input, input_length,
3130 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003131
Gilles Peskine449bd832023-01-11 14:50:10 +01003132 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003133 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003134 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003135
3136 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003137 attributes, key_buffer, key_buffer_size,
3138 alg, hash, hash_length,
3139 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003140 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003141
Gilles Peskine449bd832023-01-11 14:50:10 +01003142 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003143}
3144
Gilles Peskine449bd832023-01-11 14:50:10 +01003145psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3146 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003147 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003148 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003149 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003150 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003151{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003152 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3153 LOCAL_INPUT_DECLARE(input_external, input);
3154 LOCAL_INPUT_DECLARE(signature_external, signature);
3155
3156 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3157 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3158 status = psa_verify_internal(key, 1, alg, input, input_length, signature,
3159 signature_length);
3160
David Horstmann4a48bec2024-03-13 15:42:31 +00003161#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003162exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003163#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003164 LOCAL_INPUT_FREE(input_external, input);
3165 LOCAL_INPUT_FREE(signature_external, signature);
3166
3167 return status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003168}
3169
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003170psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003171 const psa_key_attributes_t *attributes,
3172 const uint8_t *key_buffer, size_t key_buffer_size,
3173 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003174 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003175{
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003176 if (attributes->type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003177 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3178 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003179#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003180 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3181 return mbedtls_psa_rsa_sign_hash(
3182 attributes,
3183 key_buffer, key_buffer_size,
3184 alg, hash, hash_length,
3185 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003186#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3187 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003188 } else {
3189 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003190 }
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003191 } else if (PSA_KEY_TYPE_IS_ECC(attributes->type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003192 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003193#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003194 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3195 return mbedtls_psa_ecdsa_sign_hash(
3196 attributes,
3197 key_buffer, key_buffer_size,
3198 alg, hash, hash_length,
3199 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003200#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3201 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003202 } else {
3203 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003204 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003205 }
Ronald Cron4501c982021-03-19 20:09:32 +01003206
Gilles Peskine449bd832023-01-11 14:50:10 +01003207 (void) key_buffer;
3208 (void) key_buffer_size;
3209 (void) hash;
3210 (void) hash_length;
3211 (void) signature;
3212 (void) signature_size;
3213 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003214
Gilles Peskine449bd832023-01-11 14:50:10 +01003215 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003216}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003217
Gilles Peskine449bd832023-01-11 14:50:10 +01003218psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3219 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003220 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003221 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003222 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003223 size_t signature_size,
3224 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003225{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003226 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3227 LOCAL_INPUT_DECLARE(hash_external, hash);
3228 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3229
3230 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3231 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3232 status = psa_sign_internal(key, 0, alg, hash, hash_length, signature,
3233 signature_size, signature_length);
3234
David Horstmann4a48bec2024-03-13 15:42:31 +00003235#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003236exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003237#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003238 LOCAL_INPUT_FREE(hash_external, hash);
3239 LOCAL_OUTPUT_FREE(signature_external, signature);
3240
3241 return status;
itayzafrir5c753392018-05-08 11:18:38 +03003242}
3243
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003244psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003245 const psa_key_attributes_t *attributes,
3246 const uint8_t *key_buffer, size_t key_buffer_size,
3247 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003248 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003249{
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003250 if (PSA_KEY_TYPE_IS_RSA(attributes->type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003251 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3252 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003253#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003254 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3255 return mbedtls_psa_rsa_verify_hash(
3256 attributes,
3257 key_buffer, key_buffer_size,
3258 alg, hash, hash_length,
3259 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003260#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3261 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003262 } else {
3263 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003264 }
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003265 } else if (PSA_KEY_TYPE_IS_ECC(attributes->type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003266 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003267#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003268 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3269 return mbedtls_psa_ecdsa_verify_hash(
3270 attributes,
3271 key_buffer, key_buffer_size,
3272 alg, hash, hash_length,
3273 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003274#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3275 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003276 } else {
3277 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003278 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003279 }
Ronald Cron4501c982021-03-19 20:09:32 +01003280
Gilles Peskine449bd832023-01-11 14:50:10 +01003281 (void) key_buffer;
3282 (void) key_buffer_size;
3283 (void) hash;
3284 (void) hash_length;
3285 (void) signature;
3286 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003287
Gilles Peskine449bd832023-01-11 14:50:10 +01003288 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003289}
3290
Gilles Peskine449bd832023-01-11 14:50:10 +01003291psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3292 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003293 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003294 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003295 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003296 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003297{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003298 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3299 LOCAL_INPUT_DECLARE(hash_external, hash);
3300 LOCAL_INPUT_DECLARE(signature_external, signature);
3301
3302 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3303 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3304 status = psa_verify_internal(key, 0, alg, hash, hash_length, signature,
3305 signature_length);
3306
David Horstmann4a48bec2024-03-13 15:42:31 +00003307#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003308exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003309#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003310 LOCAL_INPUT_FREE(hash_external, hash);
3311 LOCAL_INPUT_FREE(signature_external, signature);
3312
3313 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01003314}
3315
Gilles Peskine449bd832023-01-11 14:50:10 +01003316psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3317 psa_algorithm_t alg,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003318 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003319 size_t input_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003320 const uint8_t *salt_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003321 size_t salt_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003322 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003323 size_t output_size,
3324 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003325{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003326 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003327 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003328 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003329
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003330 LOCAL_INPUT_DECLARE(input_external, input);
3331 LOCAL_INPUT_DECLARE(salt_external, salt);
3332 LOCAL_OUTPUT_DECLARE(output_external, output);
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003333
Darryl Green5cc689a2018-07-24 15:34:10 +01003334 (void) input;
3335 (void) input_length;
3336 (void) salt;
3337 (void) output;
3338 (void) output_size;
3339
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003340 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003341
Gilles Peskine449bd832023-01-11 14:50:10 +01003342 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3343 return PSA_ERROR_INVALID_ARGUMENT;
3344 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003345
Valerio Setti5bb454a2024-01-15 10:43:16 +01003346 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003347 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3348 if (status != PSA_SUCCESS) {
3349 return status;
3350 }
3351 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3352 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003353 status = PSA_ERROR_INVALID_ARGUMENT;
3354 goto exit;
3355 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003356
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003357 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3358 LOCAL_INPUT_ALLOC(salt_external, salt_length, salt);
3359 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmann93fa4e12024-03-12 15:02:28 +00003360
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003361 status = psa_driver_wrapper_asymmetric_encrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003362 &slot->attr, slot->key.data, slot->key.bytes,
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003363 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003364 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003365exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00003366 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003367
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003368 LOCAL_INPUT_FREE(input_external, input);
3369 LOCAL_INPUT_FREE(salt_external, salt);
3370 LOCAL_OUTPUT_FREE(output_external, output);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003371
Gilles Peskine449bd832023-01-11 14:50:10 +01003372 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003373}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003374
Gilles Peskine449bd832023-01-11 14:50:10 +01003375psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3376 psa_algorithm_t alg,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003377 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003378 size_t input_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003379 const uint8_t *salt_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003380 size_t salt_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003381 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003382 size_t output_size,
3383 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003384{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003385 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003386 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003387 psa_key_slot_t *slot;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003388
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003389 LOCAL_INPUT_DECLARE(input_external, input);
3390 LOCAL_INPUT_DECLARE(salt_external, salt);
3391 LOCAL_OUTPUT_DECLARE(output_external, output);
3392
Darryl Green5cc689a2018-07-24 15:34:10 +01003393 (void) input;
3394 (void) input_length;
3395 (void) salt;
3396 (void) output;
3397 (void) output_size;
3398
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003399 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003400
Gilles Peskine449bd832023-01-11 14:50:10 +01003401 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3402 return PSA_ERROR_INVALID_ARGUMENT;
3403 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003404
Valerio Setti5bb454a2024-01-15 10:43:16 +01003405 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003406 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3407 if (status != PSA_SUCCESS) {
3408 return status;
3409 }
3410 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003411 status = PSA_ERROR_INVALID_ARGUMENT;
3412 goto exit;
3413 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003414
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003415 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3416 LOCAL_INPUT_ALLOC(salt_external, salt_length, salt);
3417 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmann93fa4e12024-03-12 15:02:28 +00003418
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003419 status = psa_driver_wrapper_asymmetric_decrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003420 &slot->attr, slot->key.data, slot->key.bytes,
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003421 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003422 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003423
3424exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00003425 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003426
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003427 LOCAL_INPUT_FREE(input_external, input);
3428 LOCAL_INPUT_FREE(salt_external, salt);
3429 LOCAL_OUTPUT_FREE(output_external, output);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003430
Gilles Peskine449bd832023-01-11 14:50:10 +01003431 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003432}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003433
Paul Elliott9fe12f62022-11-30 19:16:02 +00003434/****************************************************************/
3435/* Asymmetric interruptible cryptography */
3436/****************************************************************/
3437
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003438static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3439
Paul Elliott9fe12f62022-11-30 19:16:02 +00003440void psa_interruptible_set_max_ops(uint32_t max_ops)
3441{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003442 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003443}
3444
3445uint32_t psa_interruptible_get_max_ops(void)
3446{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003447 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003448}
3449
Paul Elliott9fe12f62022-11-30 19:16:02 +00003450uint32_t psa_sign_hash_get_num_ops(
3451 const psa_sign_hash_interruptible_operation_t *operation)
3452{
Paul Elliott296ede92022-12-15 17:00:30 +00003453 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003454}
3455
3456uint32_t psa_verify_hash_get_num_ops(
3457 const psa_verify_hash_interruptible_operation_t *operation)
3458{
Paul Elliott296ede92022-12-15 17:00:30 +00003459 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003460}
3461
Paul Elliott59ad9452022-12-18 15:09:02 +00003462static psa_status_t psa_sign_hash_abort_internal(
3463 psa_sign_hash_interruptible_operation_t *operation)
3464{
3465 if (operation->id == 0) {
3466 /* The object has (apparently) been initialized but it is not (yet)
3467 * in use. It's ok to call abort on such an object, and there's
3468 * nothing to do. */
3469 return PSA_SUCCESS;
3470 }
3471
3472 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3473
3474 status = psa_driver_wrapper_sign_hash_abort(operation);
3475
3476 operation->id = 0;
3477
Paul Elliotte6145dc2023-02-07 12:51:21 +00003478 /* Do not clear either the error_occurred or num_ops elements here as they
3479 * only want to be cleared by the application calling abort, not by abort
3480 * being called at completion of an operation. */
3481
Paul Elliott59ad9452022-12-18 15:09:02 +00003482 return status;
3483}
3484
Paul Elliott9fe12f62022-11-30 19:16:02 +00003485psa_status_t psa_sign_hash_start(
3486 psa_sign_hash_interruptible_operation_t *operation,
3487 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
David Horstmann4a523a62024-03-11 13:32:16 +00003488 const uint8_t *hash_external, size_t hash_length)
Paul Elliott9fe12f62022-11-30 19:16:02 +00003489{
3490 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3491 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3492 psa_key_slot_t *slot;
3493
David Horstmann4a523a62024-03-11 13:32:16 +00003494 LOCAL_INPUT_DECLARE(hash_external, hash);
3495
Paul Elliottc9774412023-02-06 15:14:07 +00003496 /* Check that start has not been previously called, or operation has not
3497 * previously errored. */
3498 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003499 return PSA_ERROR_BAD_STATE;
3500 }
3501
Paul Elliott9fe12f62022-11-30 19:16:02 +00003502 status = psa_sign_verify_check_alg(0, alg);
3503 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003504 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003505 return status;
3506 }
3507
3508 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3509 PSA_KEY_USAGE_SIGN_HASH,
3510 alg);
3511
3512 if (status != PSA_SUCCESS) {
3513 goto exit;
3514 }
3515
3516 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3517 status = PSA_ERROR_INVALID_ARGUMENT;
3518 goto exit;
3519 }
3520
David Horstmann4a523a62024-03-11 13:32:16 +00003521 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3522
Paul Elliott296ede92022-12-15 17:00:30 +00003523 /* Ensure ops count gets reset, in case of operation re-use. */
3524 operation->num_ops = 0;
3525
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003526 status = psa_driver_wrapper_sign_hash_start(operation, &slot->attr,
Paul Elliott9fe12f62022-11-30 19:16:02 +00003527 slot->key.data,
3528 slot->key.bytes, alg,
3529 hash, hash_length);
3530exit:
3531
3532 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003533 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003534 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003535 }
3536
Ryan Everettdcc03d52024-02-14 15:44:13 +00003537 unlock_status = psa_unregister_read_under_mutex(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003538
Paul Elliottc9774412023-02-06 15:14:07 +00003539 if (unlock_status != PSA_SUCCESS) {
3540 operation->error_occurred = 1;
3541 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003542
David Horstmann4a523a62024-03-11 13:32:16 +00003543 LOCAL_INPUT_FREE(hash_external, hash);
3544
Paul Elliottc9774412023-02-06 15:14:07 +00003545 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003546}
3547
3548
3549psa_status_t psa_sign_hash_complete(
3550 psa_sign_hash_interruptible_operation_t *operation,
David Horstmann4a523a62024-03-11 13:32:16 +00003551 uint8_t *signature_external, size_t signature_size,
Paul Elliott9fe12f62022-11-30 19:16:02 +00003552 size_t *signature_length)
3553{
3554 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3555
David Horstmann4a523a62024-03-11 13:32:16 +00003556 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3557
Paul Elliott9fe12f62022-11-30 19:16:02 +00003558 *signature_length = 0;
3559
Paul Elliottc9774412023-02-06 15:14:07 +00003560 /* Check that start has been called first, and that operation has not
3561 * previously errored. */
3562 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003563 status = PSA_ERROR_BAD_STATE;
3564 goto exit;
3565 }
3566
Paul Elliott096abc42023-02-03 18:33:23 +00003567 /* Immediately reject a zero-length signature buffer. This guarantees that
3568 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003569 if (signature_size == 0) {
3570 status = PSA_ERROR_BUFFER_TOO_SMALL;
3571 goto exit;
3572 }
3573
David Horstmann4a523a62024-03-11 13:32:16 +00003574 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3575
Paul Elliott9fe12f62022-11-30 19:16:02 +00003576 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3577 signature_size,
3578 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003579
Paul Elliott296ede92022-12-15 17:00:30 +00003580 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003581 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003582
Paul Elliottebe225c2023-02-10 14:32:53 +00003583exit:
3584
David Horstmannc5064c82024-03-11 17:02:03 +00003585 if (signature != NULL) {
3586 psa_wipe_tag_output_buffer(signature, status, signature_size,
3587 *signature_length);
3588 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003589
Paul Elliott53bb3122023-02-10 14:22:22 +00003590 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003591 if (status != PSA_SUCCESS) {
3592 operation->error_occurred = 1;
3593 }
3594
Paul Elliott59ad9452022-12-18 15:09:02 +00003595 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003596 }
3597
David Horstmann4a523a62024-03-11 13:32:16 +00003598 LOCAL_OUTPUT_FREE(signature_external, signature);
3599
Paul Elliott9fe12f62022-11-30 19:16:02 +00003600 return status;
3601}
3602
3603psa_status_t psa_sign_hash_abort(
3604 psa_sign_hash_interruptible_operation_t *operation)
3605{
Paul Elliott59ad9452022-12-18 15:09:02 +00003606 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3607
3608 status = psa_sign_hash_abort_internal(operation);
3609
3610 /* We clear the number of ops done here, so that it is not cleared when
3611 * the operation fails or succeeds, only on manual abort. */
3612 operation->num_ops = 0;
3613
Paul Elliottc9774412023-02-06 15:14:07 +00003614 /* Likewise, failure state. */
3615 operation->error_occurred = 0;
3616
Paul Elliott59ad9452022-12-18 15:09:02 +00003617 return status;
3618}
3619
3620static psa_status_t psa_verify_hash_abort_internal(
3621 psa_verify_hash_interruptible_operation_t *operation)
3622{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003623 if (operation->id == 0) {
3624 /* The object has (apparently) been initialized but it is not (yet)
3625 * in use. It's ok to call abort on such an object, and there's
3626 * nothing to do. */
3627 return PSA_SUCCESS;
3628 }
3629
Paul Elliott59ad9452022-12-18 15:09:02 +00003630 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3631
3632 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003633
3634 operation->id = 0;
3635
Paul Elliotte6145dc2023-02-07 12:51:21 +00003636 /* Do not clear either the error_occurred or num_ops elements here as they
3637 * only want to be cleared by the application calling abort, not by abort
3638 * being called at completion of an operation. */
3639
Paul Elliott59ad9452022-12-18 15:09:02 +00003640 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003641}
3642
3643psa_status_t psa_verify_hash_start(
3644 psa_verify_hash_interruptible_operation_t *operation,
3645 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
David Horstmann0fea6a52024-03-11 13:41:05 +00003646 const uint8_t *hash_external, size_t hash_length,
3647 const uint8_t *signature_external, size_t signature_length)
Paul Elliott9fe12f62022-11-30 19:16:02 +00003648{
3649 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3650 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3651 psa_key_slot_t *slot;
3652
David Horstmann0fea6a52024-03-11 13:41:05 +00003653 LOCAL_INPUT_DECLARE(hash_external, hash);
3654 LOCAL_INPUT_DECLARE(signature_external, signature);
3655
Paul Elliottc9774412023-02-06 15:14:07 +00003656 /* Check that start has not been previously called, or operation has not
3657 * previously errored. */
3658 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003659 return PSA_ERROR_BAD_STATE;
3660 }
3661
3662 status = psa_sign_verify_check_alg(0, alg);
3663 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003664 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003665 return status;
3666 }
3667
3668 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3669 PSA_KEY_USAGE_VERIFY_HASH,
3670 alg);
3671
3672 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003673 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003674 return status;
3675 }
3676
David Horstmann0fea6a52024-03-11 13:41:05 +00003677 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3678 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3679
Paul Elliott296ede92022-12-15 17:00:30 +00003680 /* Ensure ops count gets reset, in case of operation re-use. */
3681 operation->num_ops = 0;
3682
Gilles Peskine7a5d9202024-02-28 01:18:23 +01003683 status = psa_driver_wrapper_verify_hash_start(operation, &slot->attr,
Paul Elliott9fe12f62022-11-30 19:16:02 +00003684 slot->key.data,
3685 slot->key.bytes,
3686 alg, hash, hash_length,
3687 signature, signature_length);
David Horstmann4a48bec2024-03-13 15:42:31 +00003688#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
David Horstmann0fea6a52024-03-11 13:41:05 +00003689exit:
3690#endif
Paul Elliott9fe12f62022-11-30 19:16:02 +00003691
3692 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003693 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003694 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003695 }
3696
Ryan Everett291267f2024-02-14 15:59:15 +00003697 unlock_status = psa_unregister_read_under_mutex(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003698
Paul Elliottc9774412023-02-06 15:14:07 +00003699 if (unlock_status != PSA_SUCCESS) {
3700 operation->error_occurred = 1;
3701 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003702
David Horstmann0fea6a52024-03-11 13:41:05 +00003703 LOCAL_INPUT_FREE(hash_external, hash);
3704 LOCAL_INPUT_FREE(signature_external, signature);
3705
Paul Elliottc9774412023-02-06 15:14:07 +00003706 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003707}
3708
3709psa_status_t psa_verify_hash_complete(
3710 psa_verify_hash_interruptible_operation_t *operation)
3711{
3712 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3713
Paul Elliottc9774412023-02-06 15:14:07 +00003714 /* Check that start has been called first, and that operation has not
3715 * previously errored. */
3716 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003717 status = PSA_ERROR_BAD_STATE;
3718 goto exit;
3719 }
3720
3721 status = psa_driver_wrapper_verify_hash_complete(operation);
3722
Paul Elliott296ede92022-12-15 17:00:30 +00003723 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003724 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003725 operation);
3726
Paul Elliottebe225c2023-02-10 14:32:53 +00003727exit:
3728
Paul Elliott9fe12f62022-11-30 19:16:02 +00003729 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003730 if (status != PSA_SUCCESS) {
3731 operation->error_occurred = 1;
3732 }
3733
Paul Elliott59ad9452022-12-18 15:09:02 +00003734 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003735 }
3736
3737 return status;
3738}
3739
3740psa_status_t psa_verify_hash_abort(
3741 psa_verify_hash_interruptible_operation_t *operation)
3742{
Paul Elliott59ad9452022-12-18 15:09:02 +00003743 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003744
Paul Elliott59ad9452022-12-18 15:09:02 +00003745 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003746
Paul Elliott59ad9452022-12-18 15:09:02 +00003747 /* We clear the number of ops done here, so that it is not cleared when
3748 * the operation fails or succeeds, only on manual abort. */
3749 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003750
Paul Elliottc9774412023-02-06 15:14:07 +00003751 /* Likewise, failure state. */
3752 operation->error_occurred = 0;
3753
Paul Elliott59ad9452022-12-18 15:09:02 +00003754 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003755}
3756
Paul Elliott588f8ed2022-12-02 18:10:26 +00003757/****************************************************************/
3758/* Asymmetric interruptible cryptography internal */
3759/* implementations */
3760/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003761
Paul Elliott588f8ed2022-12-02 18:10:26 +00003762void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3763{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003764
Paul Elliott588f8ed2022-12-02 18:10:26 +00003765#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3766 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3767 defined(MBEDTLS_ECP_RESTARTABLE)
3768
3769 /* Internal implementation uses zero to indicate infinite number max ops,
3770 * therefore avoid this value, and set to minimum possible. */
3771 if (max_ops == 0) {
3772 max_ops = 1;
3773 }
3774
Paul Elliott588f8ed2022-12-02 18:10:26 +00003775 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003776#else
3777 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003778#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3779 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3780 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3781}
3782
Paul Elliott588f8ed2022-12-02 18:10:26 +00003783uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003784 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003785{
3786#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3787 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3788 defined(MBEDTLS_ECP_RESTARTABLE)
3789
Paul Elliott93d9ca82023-02-15 18:14:21 +00003790 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003791#else
3792 (void) operation;
3793 return 0;
3794#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3795 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3796 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3797}
3798
3799uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003800 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003801{
3802 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3803 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3804 defined(MBEDTLS_ECP_RESTARTABLE)
3805
Paul Elliott93d9ca82023-02-15 18:14:21 +00003806 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003807#else
3808 (void) operation;
3809 return 0;
3810#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3811 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3812 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3813}
3814
3815psa_status_t mbedtls_psa_sign_hash_start(
3816 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3817 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3818 size_t key_buffer_size, psa_algorithm_t alg,
3819 const uint8_t *hash, size_t hash_length)
3820{
3821 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003822 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003823
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003824 if (!PSA_KEY_TYPE_IS_ECC(attributes->type)) {
Paul Elliott068fe072023-01-16 13:59:15 +00003825 return PSA_ERROR_NOT_SUPPORTED;
3826 }
3827
3828 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003829 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003830 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003831
3832#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003833 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3834 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003835
Paul Elliotta1c94092023-02-15 16:38:04 +00003836 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3837
Paul Elliott93d9ca82023-02-15 18:14:21 +00003838 /* Ensure num_ops is zero'ed in case of context re-use. */
3839 operation->num_ops = 0;
3840
Gilles Peskine2f107ae2024-02-28 01:26:46 +01003841 status = mbedtls_psa_ecp_load_representation(attributes->type,
3842 attributes->bits,
Paul Elliott068fe072023-01-16 13:59:15 +00003843 key_buffer,
3844 key_buffer_size,
3845 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003846
Paul Elliott068fe072023-01-16 13:59:15 +00003847 if (status != PSA_SUCCESS) {
3848 return status;
3849 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003850
Paul Elliott1bc59df2023-02-05 13:41:57 +00003851 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003852 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003853
Paul Elliott068fe072023-01-16 13:59:15 +00003854 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003855 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003856 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003857
Paul Elliott0290a762023-02-09 14:30:24 +00003858 /* We only need to store the same length of hash as the private key size
3859 * here, it would be truncated by the internal implementation anyway. */
3860 required_hash_length = (hash_length < operation->coordinate_bytes ?
3861 hash_length : operation->coordinate_bytes);
3862
Paul Elliottba70ad42023-02-15 18:23:53 +00003863 if (required_hash_length > sizeof(operation->hash)) {
3864 /* Shouldn't happen, but better safe than sorry. */
3865 return PSA_ERROR_CORRUPTION_DETECTED;
3866 }
3867
Paul Elliott0290a762023-02-09 14:30:24 +00003868 memcpy(operation->hash, hash, required_hash_length);
3869 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003870
3871 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003872
3873#else
Paul Elliott068fe072023-01-16 13:59:15 +00003874 (void) operation;
3875 (void) key_buffer;
3876 (void) key_buffer_size;
3877 (void) alg;
3878 (void) hash;
3879 (void) hash_length;
3880 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003881 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003882
Paul Elliott068fe072023-01-16 13:59:15 +00003883 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003884#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3885 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3886 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003887}
3888
3889psa_status_t mbedtls_psa_sign_hash_complete(
3890 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3891 uint8_t *signature, size_t signature_size,
3892 size_t *signature_length)
3893{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003894#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3895 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3896 defined(MBEDTLS_ECP_RESTARTABLE)
3897
Paul Elliotta1c94092023-02-15 16:38:04 +00003898 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003899 mbedtls_mpi r;
3900 mbedtls_mpi s;
3901
Paul Elliott46845252023-02-03 14:59:11 +00003902 mbedtls_mpi_init(&r);
3903 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003904
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003905 /* Ensure max_ops is set to the current value (or default). */
3906 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3907
Paul Elliotta1c94092023-02-15 16:38:04 +00003908 if (signature_size < 2 * operation->coordinate_bytes) {
3909 status = PSA_ERROR_BUFFER_TOO_SMALL;
3910 goto exit;
3911 }
3912
Paul Elliott588f8ed2022-12-02 18:10:26 +00003913 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003914
Paul Elliott588f8ed2022-12-02 18:10:26 +00003915#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3916 status = mbedtls_to_psa_error(
3917 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003918 &r,
3919 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003920 &operation->ctx->d,
3921 operation->hash,
3922 operation->hash_length,
3923 operation->md_alg,
3924 mbedtls_psa_get_random,
3925 MBEDTLS_PSA_RANDOM_STATE,
3926 &operation->restart_ctx));
3927#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003928 status = PSA_ERROR_NOT_SUPPORTED;
3929 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003930#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3931 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003932 status = mbedtls_to_psa_error(
3933 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003934 &r,
3935 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003936 &operation->ctx->d,
3937 operation->hash,
3938 operation->hash_length,
3939 mbedtls_psa_get_random,
3940 MBEDTLS_PSA_RANDOM_STATE,
3941 mbedtls_psa_get_random,
3942 MBEDTLS_PSA_RANDOM_STATE,
3943 &operation->restart_ctx));
3944 }
3945
Paul Elliottf8e5b562023-02-19 18:43:45 +00003946 /* Hide the fact that the restart context only holds a delta of number of
3947 * ops done during the last operation, not an absolute value. */
3948 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3949
Paul Elliott724bd252023-02-08 12:35:08 +00003950 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003951 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003952 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003953 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003954 operation->coordinate_bytes)
3955 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003956
3957 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003958 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003959 }
3960
3961 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003962 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003963 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003964 operation->coordinate_bytes,
3965 operation->coordinate_bytes)
3966 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003967
3968 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003969 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003970 }
3971
Paul Elliott1bc59df2023-02-05 13:41:57 +00003972 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003973
Paul Elliott724bd252023-02-08 12:35:08 +00003974 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003975 }
Paul Elliott724bd252023-02-08 12:35:08 +00003976
3977exit:
3978
3979 mbedtls_mpi_free(&r);
3980 mbedtls_mpi_free(&s);
3981 return status;
3982
Paul Elliott588f8ed2022-12-02 18:10:26 +00003983 #else
3984
3985 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003986 (void) signature;
3987 (void) signature_size;
3988 (void) signature_length;
3989
3990 return PSA_ERROR_NOT_SUPPORTED;
3991
3992#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3993 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3994 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3995}
3996
3997psa_status_t mbedtls_psa_sign_hash_abort(
3998 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3999{
4000
4001#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4002 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4003 defined(MBEDTLS_ECP_RESTARTABLE)
4004
4005 if (operation->ctx) {
4006 mbedtls_ecdsa_free(operation->ctx);
4007 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004008 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004009 }
4010
4011 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4012
Paul Elliott93d9ca82023-02-15 18:14:21 +00004013 operation->num_ops = 0;
4014
Paul Elliott588f8ed2022-12-02 18:10:26 +00004015 return PSA_SUCCESS;
4016
4017#else
4018
4019 (void) operation;
4020
4021 return PSA_ERROR_NOT_SUPPORTED;
4022
4023#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4024 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4025 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4026}
4027
4028psa_status_t mbedtls_psa_verify_hash_start(
4029 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
4030 const psa_key_attributes_t *attributes,
4031 const uint8_t *key_buffer, size_t key_buffer_size,
4032 psa_algorithm_t alg,
4033 const uint8_t *hash, size_t hash_length,
4034 const uint8_t *signature, size_t signature_length)
4035{
4036 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00004037 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00004038 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004039
Gilles Peskine2f107ae2024-02-28 01:26:46 +01004040 if (!PSA_KEY_TYPE_IS_ECC(attributes->type)) {
Paul Elliott068fe072023-01-16 13:59:15 +00004041 return PSA_ERROR_NOT_SUPPORTED;
4042 }
4043
4044 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00004045 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00004046 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004047
4048#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00004049 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4050 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00004051
Paul Elliotta1c94092023-02-15 16:38:04 +00004052 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
4053 mbedtls_mpi_init(&operation->r);
4054 mbedtls_mpi_init(&operation->s);
4055
Paul Elliott93d9ca82023-02-15 18:14:21 +00004056 /* Ensure num_ops is zero'ed in case of context re-use. */
4057 operation->num_ops = 0;
4058
Gilles Peskine2f107ae2024-02-28 01:26:46 +01004059 status = mbedtls_psa_ecp_load_representation(attributes->type,
4060 attributes->bits,
Paul Elliott068fe072023-01-16 13:59:15 +00004061 key_buffer,
4062 key_buffer_size,
4063 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004064
Paul Elliott068fe072023-01-16 13:59:15 +00004065 if (status != PSA_SUCCESS) {
4066 return status;
4067 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004068
Paul Elliottc569fc22023-02-10 13:02:54 +00004069 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004070
Paul Elliott1bc59df2023-02-05 13:41:57 +00004071 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004072 return PSA_ERROR_INVALID_SIGNATURE;
4073 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004074
Paul Elliott068fe072023-01-16 13:59:15 +00004075 status = mbedtls_to_psa_error(
4076 mbedtls_mpi_read_binary(&operation->r,
4077 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004078 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004079
Paul Elliott068fe072023-01-16 13:59:15 +00004080 if (status != PSA_SUCCESS) {
4081 return status;
4082 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004083
Paul Elliott068fe072023-01-16 13:59:15 +00004084 status = mbedtls_to_psa_error(
4085 mbedtls_mpi_read_binary(&operation->s,
4086 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004087 coordinate_bytes,
4088 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004089
Paul Elliott068fe072023-01-16 13:59:15 +00004090 if (status != PSA_SUCCESS) {
4091 return status;
4092 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004093
Paul Elliott2c9843f2023-02-15 17:32:42 +00004094 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004095
Paul Elliott2c9843f2023-02-15 17:32:42 +00004096 if (status != PSA_SUCCESS) {
4097 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004098 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004099
Paul Elliott0290a762023-02-09 14:30:24 +00004100 /* We only need to store the same length of hash as the private key size
4101 * here, it would be truncated by the internal implementation anyway. */
4102 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4103 coordinate_bytes);
4104
Paul Elliottba70ad42023-02-15 18:23:53 +00004105 if (required_hash_length > sizeof(operation->hash)) {
4106 /* Shouldn't happen, but better safe than sorry. */
4107 return PSA_ERROR_CORRUPTION_DETECTED;
4108 }
4109
Paul Elliott0290a762023-02-09 14:30:24 +00004110 memcpy(operation->hash, hash, required_hash_length);
4111 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004112
4113 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004114#else
Paul Elliott068fe072023-01-16 13:59:15 +00004115 (void) operation;
4116 (void) key_buffer;
4117 (void) key_buffer_size;
4118 (void) alg;
4119 (void) hash;
4120 (void) hash_length;
4121 (void) signature;
4122 (void) signature_length;
4123 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004124 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004125 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004126
Paul Elliott068fe072023-01-16 13:59:15 +00004127 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004128#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4129 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4130 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004131}
4132
4133psa_status_t mbedtls_psa_verify_hash_complete(
4134 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4135{
4136
4137#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4138 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4139 defined(MBEDTLS_ECP_RESTARTABLE)
4140
Paul Elliottf8e5b562023-02-19 18:43:45 +00004141 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4142
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004143 /* Ensure max_ops is set to the current value (or default). */
4144 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4145
Paul Elliottf8e5b562023-02-19 18:43:45 +00004146 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004147 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4148 operation->hash,
4149 operation->hash_length,
4150 &operation->ctx->Q,
4151 &operation->r,
4152 &operation->s,
4153 &operation->restart_ctx));
4154
Paul Elliottf8e5b562023-02-19 18:43:45 +00004155 /* Hide the fact that the restart context only holds a delta of number of
4156 * ops done during the last operation, not an absolute value. */
4157 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4158
4159 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004160#else
4161 (void) operation;
4162
4163 return PSA_ERROR_NOT_SUPPORTED;
4164
4165#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4166 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4167 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4168}
4169
4170psa_status_t mbedtls_psa_verify_hash_abort(
4171 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4172{
4173
4174#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4175 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4176 defined(MBEDTLS_ECP_RESTARTABLE)
4177
4178 if (operation->ctx) {
4179 mbedtls_ecdsa_free(operation->ctx);
4180 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004181 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004182 }
4183
4184 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4185
Paul Elliott93d9ca82023-02-15 18:14:21 +00004186 operation->num_ops = 0;
4187
Paul Elliott588f8ed2022-12-02 18:10:26 +00004188 mbedtls_mpi_free(&operation->r);
4189 mbedtls_mpi_free(&operation->s);
4190
4191 return PSA_SUCCESS;
4192
4193#else
4194 (void) operation;
4195
4196 return PSA_ERROR_NOT_SUPPORTED;
4197
4198#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4199 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4200 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4201}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004202
David Horstmann6e99bb22024-02-06 15:27:49 +00004203static psa_status_t psa_generate_random_internal(uint8_t *output,
4204 size_t output_size)
4205{
4206 GUARD_MODULE_INITIALIZED;
4207
David Horstmann6e99bb22024-02-06 15:27:49 +00004208#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4209
David Horstmanndb909142024-03-12 16:07:08 +00004210 psa_status_t status;
David Horstmann6e99bb22024-02-06 15:27:49 +00004211 size_t output_length = 0;
4212 status = mbedtls_psa_external_get_random(&global_data.rng,
4213 output, output_size,
4214 &output_length);
4215 if (status != PSA_SUCCESS) {
David Horstmanndb909142024-03-12 16:07:08 +00004216 return status;
David Horstmann6e99bb22024-02-06 15:27:49 +00004217 }
4218 /* Breaking up a request into smaller chunks is currently not supported
4219 * for the external RNG interface. */
4220 if (output_length != output_size) {
David Horstmanndb909142024-03-12 16:07:08 +00004221 return PSA_ERROR_INSUFFICIENT_ENTROPY;
David Horstmann6e99bb22024-02-06 15:27:49 +00004222 }
David Horstmanndb909142024-03-12 16:07:08 +00004223 return PSA_SUCCESS;
David Horstmann6e99bb22024-02-06 15:27:49 +00004224
4225#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4226
4227 while (output_size > 0) {
David Horstmann93fa4e12024-03-12 15:02:28 +00004228 int ret = MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED;
David Horstmann6e99bb22024-02-06 15:27:49 +00004229 size_t request_size =
4230 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4231 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4232 output_size);
David Horstmann93fa4e12024-03-12 15:02:28 +00004233#if defined(MBEDTLS_CTR_DRBG_C)
4234 ret = mbedtls_ctr_drbg_random(&global_data.rng.drbg, output, request_size);
4235#elif defined(MBEDTLS_HMAC_DRBG_C)
4236 ret = mbedtls_hmac_drbg_random(&global_data.rng.drbg, output, request_size);
4237#endif /* !MBEDTLS_CTR_DRBG_C && !MBEDTLS_HMAC_DRBG_C */
David Horstmann6e99bb22024-02-06 15:27:49 +00004238 if (ret != 0) {
David Horstmann93fa4e12024-03-12 15:02:28 +00004239 return mbedtls_to_psa_error(ret);
David Horstmann6e99bb22024-02-06 15:27:49 +00004240 }
4241 output_size -= request_size;
4242 output += request_size;
4243 }
David Horstmann93fa4e12024-03-12 15:02:28 +00004244 return PSA_SUCCESS;
David Horstmann6e99bb22024-02-06 15:27:49 +00004245#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
David Horstmann6e99bb22024-02-06 15:27:49 +00004246}
4247
4248
mohammad1603503973b2018-03-12 15:59:30 +02004249/****************************************************************/
4250/* Symmetric cryptography */
4251/****************************************************************/
4252
Gilles Peskine449bd832023-01-11 14:50:10 +01004253static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4254 mbedtls_svc_key_id_t key,
4255 psa_algorithm_t alg,
4256 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004257{
4258 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4259 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004260 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004261 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4262 PSA_KEY_USAGE_ENCRYPT :
4263 PSA_KEY_USAGE_DECRYPT);
Ronald Cronab99ac22020-10-01 16:38:28 +02004264
4265 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004266 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004267 status = PSA_ERROR_BAD_STATE;
4268 goto exit;
4269 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004270
Gilles Peskine449bd832023-01-11 14:50:10 +01004271 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004272 status = PSA_ERROR_INVALID_ARGUMENT;
4273 goto exit;
4274 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004275
Gilles Peskine449bd832023-01-11 14:50:10 +01004276 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4277 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004278 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004279 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004280
Ronald Cron49fafa92021-03-10 08:34:23 +01004281 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004282 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004283 * so we only set it (in the driver wrapper) after resources have been
4284 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004285 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004286 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004287 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004288 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004289 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004290 }
4291 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004292
4293 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 if (cipher_operation == MBEDTLS_ENCRYPT) {
4295 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004296 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01004297 slot->key.data,
4298 slot->key.bytes,
4299 alg);
4300 } else {
4301 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004302 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01004303 slot->key.data,
4304 slot->key.bytes,
4305 alg);
4306 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004307
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004308exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004309 if (status != PSA_SUCCESS) {
4310 psa_cipher_abort(operation);
4311 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004312
Ryan Everettc0053cc2024-02-14 16:27:13 +00004313 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004314
Gilles Peskine449bd832023-01-11 14:50:10 +01004315 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004316}
4317
Gilles Peskine449bd832023-01-11 14:50:10 +01004318psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4319 mbedtls_svc_key_id_t key,
4320 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004321{
Gilles Peskine449bd832023-01-11 14:50:10 +01004322 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004323}
4324
Gilles Peskine449bd832023-01-11 14:50:10 +01004325psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4326 mbedtls_svc_key_id_t key,
4327 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004328{
Gilles Peskine449bd832023-01-11 14:50:10 +01004329 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004330}
4331
Gilles Peskine449bd832023-01-11 14:50:10 +01004332psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
Gabor Mezei358eb212024-02-07 18:10:13 +01004333 uint8_t *iv_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004334 size_t iv_size,
4335 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004336{
Ronald Cron6d051732020-10-01 14:10:20 +02004337 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Sergeybef1f632023-03-06 15:25:06 -07004338 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004339
Gabor Mezei358eb212024-02-07 18:10:13 +01004340 LOCAL_OUTPUT_DECLARE(iv_external, iv);
4341
Gilles Peskine449bd832023-01-11 14:50:10 +01004342 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004343 status = PSA_ERROR_BAD_STATE;
4344 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004345 }
4346
Gilles Peskine449bd832023-01-11 14:50:10 +01004347 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004348 status = PSA_ERROR_BAD_STATE;
4349 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004350 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004351
Ronald Cron2fb90522021-07-05 12:31:44 +02004352 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004353 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004354 status = PSA_ERROR_BUFFER_TOO_SMALL;
4355 goto exit;
4356 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004357
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004359 status = PSA_ERROR_GENERIC_ERROR;
4360 goto exit;
4361 }
4362
Gabor Mezei358eb212024-02-07 18:10:13 +01004363 LOCAL_OUTPUT_ALLOC(iv_external, default_iv_length, iv);
4364
Gabor Mezei1b5b58d2024-03-04 17:15:08 +01004365 status = psa_generate_random_internal(iv, default_iv_length);
Gilles Peskine449bd832023-01-11 14:50:10 +01004366 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004367 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004368 }
Ronald Cron5618a392021-03-26 09:52:26 +01004369
Gilles Peskine449bd832023-01-11 14:50:10 +01004370 status = psa_driver_wrapper_cipher_set_iv(operation,
Gabor Mezei358eb212024-02-07 18:10:13 +01004371 iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004372
4373exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004374 if (status == PSA_SUCCESS) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004375 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004376 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004378 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004379 psa_cipher_abort(operation);
Gabor Mezei358eb212024-02-07 18:10:13 +01004380 if (iv != NULL) {
4381 mbedtls_platform_zeroize(iv, default_iv_length);
4382 }
Ronald Cron2fb90522021-07-05 12:31:44 +02004383 }
Ronald Cron6d051732020-10-01 14:10:20 +02004384
Gabor Mezei358eb212024-02-07 18:10:13 +01004385 LOCAL_OUTPUT_FREE(iv_external, iv);
Gilles Peskine449bd832023-01-11 14:50:10 +01004386 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004387}
4388
Gilles Peskine449bd832023-01-11 14:50:10 +01004389psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004390 const uint8_t *iv_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004391 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004392{
Ronald Cron6d051732020-10-01 14:10:20 +02004393 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004394
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004395 LOCAL_INPUT_DECLARE(iv_external, iv);
4396
Gilles Peskine449bd832023-01-11 14:50:10 +01004397 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004398 status = PSA_ERROR_BAD_STATE;
4399 goto exit;
4400 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004401
Gilles Peskine449bd832023-01-11 14:50:10 +01004402 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004403 status = PSA_ERROR_BAD_STATE;
4404 goto exit;
4405 }
Ronald Crona0d68172021-03-26 10:15:08 +01004406
Gilles Peskine449bd832023-01-11 14:50:10 +01004407 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004408 status = PSA_ERROR_INVALID_ARGUMENT;
4409 goto exit;
4410 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004411
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004412 LOCAL_INPUT_ALLOC(iv_external, iv_length, iv);
4413
Gilles Peskine449bd832023-01-11 14:50:10 +01004414 status = psa_driver_wrapper_cipher_set_iv(operation,
4415 iv,
4416 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004417
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004418exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004419 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004420 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004421 } else {
4422 psa_cipher_abort(operation);
4423 }
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004424
4425 LOCAL_INPUT_FREE(iv_external, iv);
4426
Gilles Peskine449bd832023-01-11 14:50:10 +01004427 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004428}
4429
Gilles Peskine449bd832023-01-11 14:50:10 +01004430psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
Gabor Mezei212eb082024-01-24 16:56:00 +01004431 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004432 size_t input_length,
Gabor Mezei212eb082024-01-24 16:56:00 +01004433 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004434 size_t output_size,
4435 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004436{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004437 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004438
Gabor Mezei212eb082024-01-24 16:56:00 +01004439 LOCAL_INPUT_DECLARE(input_external, input);
4440 LOCAL_OUTPUT_DECLARE(output_external, output);
4441
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004443 status = PSA_ERROR_BAD_STATE;
4444 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004445 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004446
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004448 status = PSA_ERROR_BAD_STATE;
4449 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004450 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004451
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004452 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gabor Mezei0b041162024-02-29 10:08:16 +00004453 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004454
Gilles Peskine449bd832023-01-11 14:50:10 +01004455 status = psa_driver_wrapper_cipher_update(operation,
4456 input,
4457 input_length,
4458 output,
4459 output_size,
4460 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004461
4462exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004463 if (status != PSA_SUCCESS) {
4464 psa_cipher_abort(operation);
4465 }
Ronald Cron6d051732020-10-01 14:10:20 +02004466
Gabor Mezei212eb082024-01-24 16:56:00 +01004467 LOCAL_INPUT_FREE(input_external, input);
4468 LOCAL_OUTPUT_FREE(output_external, output);
4469
Gilles Peskine449bd832023-01-11 14:50:10 +01004470 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004471}
4472
Gilles Peskine449bd832023-01-11 14:50:10 +01004473psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
Gabor Mezei212eb082024-01-24 16:56:00 +01004474 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004475 size_t output_size,
4476 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004477{
David Saadab4ecc272019-02-14 13:48:10 +02004478 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004479
Gabor Mezei212eb082024-01-24 16:56:00 +01004480 LOCAL_OUTPUT_DECLARE(output_external, output);
4481
Gilles Peskine449bd832023-01-11 14:50:10 +01004482 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004483 status = PSA_ERROR_BAD_STATE;
4484 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004485 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004486
Gilles Peskine449bd832023-01-11 14:50:10 +01004487 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004488 status = PSA_ERROR_BAD_STATE;
4489 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004490 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004491
Gabor Mezei0b041162024-02-29 10:08:16 +00004492 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004493
Gilles Peskine449bd832023-01-11 14:50:10 +01004494 status = psa_driver_wrapper_cipher_finish(operation,
4495 output,
4496 output_size,
4497 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004498
4499exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004500 if (status == PSA_SUCCESS) {
Gabor Mezei212eb082024-01-24 16:56:00 +01004501 status = psa_cipher_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004503 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004504 (void) psa_cipher_abort(operation);
Steven Cooremanef8575e2020-09-11 11:44:50 +02004505 }
Gabor Mezei212eb082024-01-24 16:56:00 +01004506
4507 LOCAL_OUTPUT_FREE(output_external, output);
4508
4509 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004510}
4511
Gilles Peskine449bd832023-01-11 14:50:10 +01004512psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004513{
Gilles Peskine449bd832023-01-11 14:50:10 +01004514 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004515 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004516 * in use. It's ok to call abort on such an object, and there's
4517 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004518 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004519 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004520
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004522
Ronald Cron49fafa92021-03-10 08:34:23 +01004523 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004524 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004525 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004526
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004528}
4529
Gilles Peskine449bd832023-01-11 14:50:10 +01004530psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4531 psa_algorithm_t alg,
David Horstmann36df4b22023-12-13 15:55:25 +00004532 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004533 size_t input_length,
David Horstmann36df4b22023-12-13 15:55:25 +00004534 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004535 size_t output_size,
4536 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004537{
4538 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004539 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004540 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004541 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4542 size_t default_iv_length = 0;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004543
David Horstmann62a56d92023-12-14 18:12:47 +00004544 LOCAL_INPUT_DECLARE(input_external, input);
4545 LOCAL_OUTPUT_DECLARE(output_external, output);
4546
Gilles Peskine449bd832023-01-11 14:50:10 +01004547 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004548 status = PSA_ERROR_INVALID_ARGUMENT;
4549 goto exit;
4550 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004551
Gilles Peskine449bd832023-01-11 14:50:10 +01004552 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4553 PSA_KEY_USAGE_ENCRYPT,
4554 alg);
4555 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004556 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004558
Gilles Peskine449bd832023-01-11 14:50:10 +01004559 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4560 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004561 status = PSA_ERROR_GENERIC_ERROR;
4562 goto exit;
4563 }
4564
Gilles Peskine449bd832023-01-11 14:50:10 +01004565 if (default_iv_length > 0) {
4566 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004567 status = PSA_ERROR_BUFFER_TOO_SMALL;
4568 goto exit;
4569 }
4570
David Horstmann6e99bb22024-02-06 15:27:49 +00004571 status = psa_generate_random_internal(local_iv, default_iv_length);
Gilles Peskine449bd832023-01-11 14:50:10 +01004572 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004573 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004574 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004575 }
4576
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004577 LOCAL_INPUT_ALLOC(input_external, input_length, input);
4578 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
4579
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004580 status = psa_driver_wrapper_cipher_encrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004581 &slot->attr, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004582 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004583 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004585
4586exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004587 unlock_status = psa_unregister_read_under_mutex(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004588 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004589 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004590 }
Ronald Cron23919522021-07-08 19:00:07 +02004591
Gilles Peskine449bd832023-01-11 14:50:10 +01004592 if (status == PSA_SUCCESS) {
4593 if (default_iv_length > 0) {
4594 memcpy(output, local_iv, default_iv_length);
4595 }
4596 *output_length += default_iv_length;
4597 } else {
4598 *output_length = 0;
4599 }
4600
David Horstmann62a56d92023-12-14 18:12:47 +00004601 LOCAL_INPUT_FREE(input_external, input);
4602 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004603
Gilles Peskine449bd832023-01-11 14:50:10 +01004604 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004605}
4606
Gilles Peskine449bd832023-01-11 14:50:10 +01004607psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4608 psa_algorithm_t alg,
Gabor Mezei212eb082024-01-24 16:56:00 +01004609 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004610 size_t input_length,
Gabor Mezei212eb082024-01-24 16:56:00 +01004611 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004612 size_t output_size,
4613 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004614{
4615 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004616 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004617 psa_key_slot_t *slot = NULL;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004618
Gabor Mezei212eb082024-01-24 16:56:00 +01004619 LOCAL_INPUT_DECLARE(input_external, input);
4620 LOCAL_OUTPUT_DECLARE(output_external, output);
4621
Gilles Peskine449bd832023-01-11 14:50:10 +01004622 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004623 status = PSA_ERROR_INVALID_ARGUMENT;
4624 goto exit;
4625 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004626
Gilles Peskine449bd832023-01-11 14:50:10 +01004627 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4628 PSA_KEY_USAGE_DECRYPT,
4629 alg);
4630 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004631 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004632 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004633
Gilles Peskineb47c3b32024-06-26 13:16:33 +02004634 if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004635 status = PSA_ERROR_INVALID_ARGUMENT;
4636 goto exit;
4637 }
4638
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004639 LOCAL_INPUT_ALLOC(input_external, input_length, input);
4640 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
4641
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004642 status = psa_driver_wrapper_cipher_decrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004643 &slot->attr, slot->key.data, slot->key.bytes,
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004644 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004645 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004646
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004647exit:
Ryan Everetta103ec92024-01-31 13:59:57 +00004648 unlock_status = psa_unregister_read_under_mutex(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004650 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004651 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004652
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004654 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 }
Ronald Cron23919522021-07-08 19:00:07 +02004656
Gabor Mezei212eb082024-01-24 16:56:00 +01004657 LOCAL_INPUT_FREE(input_external, input);
4658 LOCAL_OUTPUT_FREE(output_external, output);
4659
Gilles Peskine449bd832023-01-11 14:50:10 +01004660 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004661}
4662
4663
mohammad16035955c982018-04-26 00:53:03 +03004664/****************************************************************/
4665/* AEAD */
4666/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004667
Paul Elliottbaff51c2021-09-28 17:44:45 +01004668/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004669static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004670{
Gilles Peskine449bd832023-01-11 14:50:10 +01004671 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004672}
4673
4674/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004675static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4676 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004677{
Gilles Peskine449bd832023-01-11 14:50:10 +01004678 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004679
Gilles Peskine449bd832023-01-11 14:50:10 +01004680 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004681#if defined(PSA_WANT_ALG_GCM)
4682 case PSA_ALG_GCM:
4683 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004684 * arbitrarily large nonces. Please note that we do not generally
4685 * recommend the usage of nonces of greater length than
4686 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4687 * size, which can then lead to collisions if you encrypt a very
4688 * large number of messages.*/
4689 if (nonce_length != 0) {
4690 return PSA_SUCCESS;
4691 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004692 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004693#endif /* PSA_WANT_ALG_GCM */
4694#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004695 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 if (nonce_length >= 7 && nonce_length <= 13) {
4697 return PSA_SUCCESS;
4698 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004699 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004700#endif /* PSA_WANT_ALG_CCM */
4701#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004702 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004703 if (nonce_length == 12) {
4704 return PSA_SUCCESS;
4705 } else if (nonce_length == 8) {
4706 return PSA_ERROR_NOT_SUPPORTED;
4707 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004708 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004709#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004710 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004711 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004713 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004714
Gilles Peskine449bd832023-01-11 14:50:10 +01004715 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004716}
4717
Gilles Peskine449bd832023-01-11 14:50:10 +01004718static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004719{
Gilles Peskine449bd832023-01-11 14:50:10 +01004720 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4721 return PSA_ERROR_INVALID_ARGUMENT;
4722 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004723
Gilles Peskine449bd832023-01-11 14:50:10 +01004724 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004725}
4726
Gilles Peskine449bd832023-01-11 14:50:10 +01004727psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4728 psa_algorithm_t alg,
David Horstmann9d09a022023-11-28 19:25:00 +00004729 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004730 size_t nonce_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004731 const uint8_t *additional_data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004732 size_t additional_data_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004733 const uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004734 size_t plaintext_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004735 uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004736 size_t ciphertext_size,
4737 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004738{
Ronald Cron215633c2021-03-16 17:15:37 +01004739 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4740 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004741
David Horstmann9d09a022023-11-28 19:25:00 +00004742 LOCAL_INPUT_DECLARE(nonce_external, nonce);
4743 LOCAL_INPUT_DECLARE(additional_data_external, additional_data);
4744 LOCAL_INPUT_DECLARE(plaintext_external, plaintext);
4745 LOCAL_OUTPUT_DECLARE(ciphertext_external, ciphertext);
4746
mohammad1603f08a5502018-06-03 15:05:47 +03004747 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004748
Gilles Peskine449bd832023-01-11 14:50:10 +01004749 status = psa_aead_check_algorithm(alg);
4750 if (status != PSA_SUCCESS) {
4751 return status;
4752 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004753
Ronald Cron9a986162021-03-26 12:40:07 +01004754 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4756 if (status != PSA_SUCCESS) {
4757 return status;
4758 }
mohammad16035955c982018-04-26 00:53:03 +03004759
David Horstmann9d09a022023-11-28 19:25:00 +00004760 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
4761 LOCAL_INPUT_ALLOC(additional_data_external, additional_data_length, additional_data);
4762 LOCAL_INPUT_ALLOC(plaintext_external, plaintext_length, plaintext);
4763 LOCAL_OUTPUT_ALLOC(ciphertext_external, ciphertext_size, ciphertext);
4764
Gilles Peskine449bd832023-01-11 14:50:10 +01004765 status = psa_aead_check_nonce_length(alg, nonce_length);
4766 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004767 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004768 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004769
Ronald Cronde822812021-03-17 16:08:20 +01004770 status = psa_driver_wrapper_aead_encrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004771 &slot->attr, slot->key.data, slot->key.bytes,
Ronald Cron215633c2021-03-16 17:15:37 +01004772 alg,
4773 nonce, nonce_length,
4774 additional_data, additional_data_length,
4775 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004776 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004777
Gilles Peskine449bd832023-01-11 14:50:10 +01004778 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4779 memset(ciphertext, 0, ciphertext_size);
4780 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004781
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004782exit:
David Horstmann9d09a022023-11-28 19:25:00 +00004783 LOCAL_INPUT_FREE(nonce_external, nonce);
4784 LOCAL_INPUT_FREE(additional_data_external, additional_data);
4785 LOCAL_INPUT_FREE(plaintext_external, plaintext);
4786 LOCAL_OUTPUT_FREE(ciphertext_external, ciphertext);
4787
Ryan Everetta103ec92024-01-31 13:59:57 +00004788 psa_unregister_read_under_mutex(slot);
mohammad16035955c982018-04-26 00:53:03 +03004789
Gilles Peskine449bd832023-01-11 14:50:10 +01004790 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004791}
4792
Gilles Peskine449bd832023-01-11 14:50:10 +01004793psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4794 psa_algorithm_t alg,
David Horstmann7f2e0402023-11-28 19:43:53 +00004795 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004796 size_t nonce_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004797 const uint8_t *additional_data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004798 size_t additional_data_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004799 const uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004800 size_t ciphertext_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004801 uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004802 size_t plaintext_size,
4803 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004804{
Ronald Cron215633c2021-03-16 17:15:37 +01004805 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4806 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004807
David Horstmann7f2e0402023-11-28 19:43:53 +00004808 LOCAL_INPUT_DECLARE(nonce_external, nonce);
4809 LOCAL_INPUT_DECLARE(additional_data_external, additional_data);
4810 LOCAL_INPUT_DECLARE(ciphertext_external, ciphertext);
4811 LOCAL_OUTPUT_DECLARE(plaintext_external, plaintext);
4812
Gilles Peskineee652a32018-06-01 19:23:52 +02004813 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004814
Gilles Peskine449bd832023-01-11 14:50:10 +01004815 status = psa_aead_check_algorithm(alg);
4816 if (status != PSA_SUCCESS) {
4817 return status;
4818 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004819
Ronald Cron9a986162021-03-26 12:40:07 +01004820 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004821 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4822 if (status != PSA_SUCCESS) {
4823 return status;
4824 }
mohammad16035955c982018-04-26 00:53:03 +03004825
David Horstmann7f2e0402023-11-28 19:43:53 +00004826 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
4827 LOCAL_INPUT_ALLOC(additional_data_external, additional_data_length,
4828 additional_data);
4829 LOCAL_INPUT_ALLOC(ciphertext_external, ciphertext_length, ciphertext);
4830 LOCAL_OUTPUT_ALLOC(plaintext_external, plaintext_size, plaintext);
4831
Gilles Peskine449bd832023-01-11 14:50:10 +01004832 status = psa_aead_check_nonce_length(alg, nonce_length);
4833 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004834 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004835 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004836
Ronald Cronde822812021-03-17 16:08:20 +01004837 status = psa_driver_wrapper_aead_decrypt(
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004838 &slot->attr, slot->key.data, slot->key.bytes,
Ronald Cron215633c2021-03-16 17:15:37 +01004839 alg,
4840 nonce, nonce_length,
4841 additional_data, additional_data_length,
4842 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004843 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004844
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 if (status != PSA_SUCCESS && plaintext_size != 0) {
4846 memset(plaintext, 0, plaintext_size);
4847 }
mohammad160360a64d02018-06-03 17:20:42 +03004848
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004849exit:
David Horstmann7f2e0402023-11-28 19:43:53 +00004850 LOCAL_INPUT_FREE(nonce_external, nonce);
4851 LOCAL_INPUT_FREE(additional_data_external, additional_data);
4852 LOCAL_INPUT_FREE(ciphertext_external, ciphertext);
4853 LOCAL_OUTPUT_FREE(plaintext_external, plaintext);
4854
Ryan Everetta103ec92024-01-31 13:59:57 +00004855 psa_unregister_read_under_mutex(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004856
Gilles Peskine449bd832023-01-11 14:50:10 +01004857 return status;
mohammad16035955c982018-04-26 00:53:03 +03004858}
4859
Gilles Peskine449bd832023-01-11 14:50:10 +01004860static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4861{
4862 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004863
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004865#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004867 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004868 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4869 return PSA_ERROR_INVALID_ARGUMENT;
4870 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004871 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004872#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004873
Przemek Stekiel86679c72022-10-06 17:06:56 +02004874#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004875 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004876 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004877 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4878 return PSA_ERROR_INVALID_ARGUMENT;
4879 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004880 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004881#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004882
Przemek Stekiel86679c72022-10-06 17:06:56 +02004883#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004884 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004885 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004886 if (tag_len != 16) {
4887 return PSA_ERROR_INVALID_ARGUMENT;
4888 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004889 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004890#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004891
4892 default:
4893 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004894 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004895 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004896 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004897}
4898
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004899/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004900static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4901 int is_encrypt,
4902 mbedtls_svc_key_id_t key,
4903 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004904{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004905 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4906 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4907 psa_key_slot_t *slot = NULL;
4908 psa_key_usage_t key_usage = 0;
4909
Gilles Peskine449bd832023-01-11 14:50:10 +01004910 status = psa_aead_check_algorithm(alg);
4911 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004912 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004914
Gilles Peskine449bd832023-01-11 14:50:10 +01004915 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004916 status = PSA_ERROR_BAD_STATE;
4917 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004918 }
4919
Gilles Peskine449bd832023-01-11 14:50:10 +01004920 if (operation->nonce_set || operation->lengths_set ||
4921 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004922 status = PSA_ERROR_BAD_STATE;
4923 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004924 }
4925
Gilles Peskine449bd832023-01-11 14:50:10 +01004926 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004927 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004928 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004929 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004930 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004931
Gilles Peskine449bd832023-01-11 14:50:10 +01004932 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4933 alg);
4934 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004935 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004936 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004937
Gilles Peskine449bd832023-01-11 14:50:10 +01004938 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004939 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004940 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004941
Gilles Peskine449bd832023-01-11 14:50:10 +01004942 if (is_encrypt) {
4943 status = psa_driver_wrapper_aead_encrypt_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004944 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01004945 slot->key.data,
4946 slot->key.bytes,
4947 alg);
4948 } else {
4949 status = psa_driver_wrapper_aead_decrypt_setup(operation,
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004950 &slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01004951 slot->key.data,
4952 slot->key.bytes,
4953 alg);
4954 }
4955 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004956 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004957 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004958
Gilles Peskine7a5d9202024-02-28 01:18:23 +01004959 operation->key_type = psa_get_key_type(&slot->attr);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004960
4961exit:
Ryan Everett9af70e52024-02-14 18:38:56 +00004962 unlock_status = psa_unregister_read_under_mutex(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004963
Gilles Peskine449bd832023-01-11 14:50:10 +01004964 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004965 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004966 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004967 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004968 } else {
4969 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004970 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004971
Gilles Peskine449bd832023-01-11 14:50:10 +01004972 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004973}
4974
Paul Elliott302ff6b2021-04-20 18:10:30 +01004975/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004976psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4977 mbedtls_svc_key_id_t key,
4978 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004979{
Gilles Peskine449bd832023-01-11 14:50:10 +01004980 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004981}
4982
4983/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004984psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4985 mbedtls_svc_key_id_t key,
4986 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004987{
Gilles Peskine449bd832023-01-11 14:50:10 +01004988 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004989}
4990
David Horstmannfed23772023-12-19 17:49:20 +00004991static psa_status_t psa_aead_set_nonce_internal(psa_aead_operation_t *operation,
4992 const uint8_t *nonce,
4993 size_t nonce_length)
4994{
4995 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4996
4997 if (operation->id == 0) {
4998 status = PSA_ERROR_BAD_STATE;
4999 goto exit;
5000 }
5001
5002 if (operation->nonce_set) {
5003 status = PSA_ERROR_BAD_STATE;
5004 goto exit;
5005 }
5006
5007 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
5008 if (status != PSA_SUCCESS) {
5009 status = PSA_ERROR_INVALID_ARGUMENT;
5010 goto exit;
5011 }
5012
5013 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
5014 nonce_length);
5015
5016exit:
5017 if (status == PSA_SUCCESS) {
5018 operation->nonce_set = 1;
5019 } else {
5020 psa_aead_abort(operation);
5021 }
5022
5023 return status;
5024}
5025
Paul Elliott302ff6b2021-04-20 18:10:30 +01005026/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01005027psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
David Horstmannd3cad8b2023-12-11 14:46:04 +00005028 uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005029 size_t nonce_size,
5030 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005031{
5032 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01005033 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07005034 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005035
David Horstmannd3cad8b2023-12-11 14:46:04 +00005036 LOCAL_OUTPUT_DECLARE(nonce_external, nonce);
5037 LOCAL_OUTPUT_ALLOC(nonce_external, nonce_size, nonce);
5038
Paul Elliott8eb9daf2021-06-04 16:42:21 +01005039 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005040
Gilles Peskine449bd832023-01-11 14:50:10 +01005041 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005042 status = PSA_ERROR_BAD_STATE;
5043 goto exit;
5044 }
5045
Gilles Peskine449bd832023-01-11 14:50:10 +01005046 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005047 status = PSA_ERROR_BAD_STATE;
5048 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005049 }
5050
Paul Elliotte193ea82021-10-01 13:00:16 +01005051 /* For CCM, this size may not be correct according to the PSA
5052 * specification. The PSA Crypto 1.0.1 specification states:
5053 *
5054 * CCM encodes the plaintext length pLen in L octets, with L the smallest
5055 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
5056 *
5057 * However this restriction that L has to be the smallest integer is not
5058 * applied in practice, and it is not implementable here since the
5059 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005060 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
5061 operation->alg);
5062 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005063 status = PSA_ERROR_BUFFER_TOO_SMALL;
5064 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005065 }
5066
David Horstmann6e99bb22024-02-06 15:27:49 +00005067 status = psa_generate_random_internal(local_nonce, required_nonce_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01005068 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005069 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005070 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01005071
David Horstmannfed23772023-12-19 17:49:20 +00005072 status = psa_aead_set_nonce_internal(operation, local_nonce,
5073 required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005074
Paul Elliott39dc6b82021-05-11 19:16:09 +01005075exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005076 if (status == PSA_SUCCESS) {
5077 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005078 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01005079 } else {
5080 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01005081 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005082
David Horstmannd3cad8b2023-12-11 14:46:04 +00005083 LOCAL_OUTPUT_FREE(nonce_external, nonce);
5084
Gilles Peskine449bd832023-01-11 14:50:10 +01005085 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005086}
5087
5088/* Set the nonce for a multipart authenticated encryption or decryption
5089 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005090psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
David Horstmann8f0ef512023-12-11 15:17:11 +00005091 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005092 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005093{
David Horstmannfed23772023-12-19 17:49:20 +00005094 psa_status_t status;
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005095
David Horstmann8f0ef512023-12-11 15:17:11 +00005096 LOCAL_INPUT_DECLARE(nonce_external, nonce);
5097 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
Paul Elliottcee785c2021-05-20 14:29:20 +01005098
David Horstmannfed23772023-12-19 17:49:20 +00005099 status = psa_aead_set_nonce_internal(operation, nonce, nonce_length);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005100
David Horstmann18dc0322023-12-20 16:16:43 +00005101/* Exit label is only needed for buffer copying, prevent unused warnings. */
David Horstmann4a48bec2024-03-13 15:42:31 +00005102#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Paul Elliott39dc6b82021-05-11 19:16:09 +01005103exit:
David Horstmann18dc0322023-12-20 16:16:43 +00005104#endif
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005105
David Horstmann8f0ef512023-12-11 15:17:11 +00005106 LOCAL_INPUT_FREE(nonce_external, nonce);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005107
Gilles Peskine449bd832023-01-11 14:50:10 +01005108 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005109}
5110
5111/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005112psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
5113 size_t ad_length,
5114 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005115{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005116 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5117
Gilles Peskine449bd832023-01-11 14:50:10 +01005118 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005119 status = PSA_ERROR_BAD_STATE;
5120 goto exit;
5121 }
5122
Gilles Peskine449bd832023-01-11 14:50:10 +01005123 if (operation->lengths_set || operation->ad_started ||
5124 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005125 status = PSA_ERROR_BAD_STATE;
5126 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005127 }
5128
Gilles Peskine449bd832023-01-11 14:50:10 +01005129 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005130#if defined(PSA_WANT_ALG_GCM)
5131 case PSA_ALG_GCM:
5132 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01005133 * bits. Without the guard this code will generate warnings on 32bit
5134 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01005135#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01005136 if (((uint64_t) ad_length) >> 61 != 0 ||
5137 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005138 status = PSA_ERROR_INVALID_ARGUMENT;
5139 goto exit;
5140 }
Paul Elliott325d3742021-09-27 17:56:28 +01005141#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005142 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005143#endif /* PSA_WANT_ALG_GCM */
5144#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005145 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01005146 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005147 status = PSA_ERROR_INVALID_ARGUMENT;
5148 goto exit;
5149 }
5150 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005151#endif /* PSA_WANT_ALG_CCM */
5152#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005153 case PSA_ALG_CHACHA20_POLY1305:
5154 /* No length restrictions for ChaChaPoly. */
5155 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005156#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005157 default:
5158 break;
5159 }
Paul Elliott325d3742021-09-27 17:56:28 +01005160
Gilles Peskine449bd832023-01-11 14:50:10 +01005161 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
5162 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005163
Paul Elliott39dc6b82021-05-11 19:16:09 +01005164exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005165 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005166 operation->ad_remaining = ad_length;
5167 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01005168 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005169 } else {
5170 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01005171 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005172
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005174}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005175
5176/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005177psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
David Horstmann25dac6e2023-12-11 15:23:13 +00005178 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005179 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005180{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005181 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5182
David Horstmann25dac6e2023-12-11 15:23:13 +00005183 LOCAL_INPUT_DECLARE(input_external, input);
5184 LOCAL_INPUT_ALLOC(input_external, input_length, input);
5185
Gilles Peskine449bd832023-01-11 14:50:10 +01005186 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005187 status = PSA_ERROR_BAD_STATE;
5188 goto exit;
5189 }
5190
Gilles Peskine449bd832023-01-11 14:50:10 +01005191 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005192 status = PSA_ERROR_BAD_STATE;
5193 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005194 }
5195
Paul Elliott304766f2024-04-26 18:30:11 +01005196 /* No input to add (zero length), nothing to do. */
5197 if (input_length == 0) {
5198 status = PSA_SUCCESS;
5199 goto exit;
5200 }
5201
Gilles Peskine449bd832023-01-11 14:50:10 +01005202 if (operation->lengths_set) {
5203 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005204 status = PSA_ERROR_INVALID_ARGUMENT;
5205 goto exit;
5206 }
5207
5208 operation->ad_remaining -= input_length;
5209 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005210#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005211 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005212 status = PSA_ERROR_BAD_STATE;
5213 goto exit;
5214 }
5215#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005216
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 status = psa_driver_wrapper_aead_update_ad(operation, input,
5218 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005219
Paul Elliott39dc6b82021-05-11 19:16:09 +01005220exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005221 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005222 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005223 } else {
5224 psa_aead_abort(operation);
5225 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005226
David Horstmann25dac6e2023-12-11 15:23:13 +00005227 LOCAL_INPUT_FREE(input_external, input);
5228
Gilles Peskine449bd832023-01-11 14:50:10 +01005229 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005230}
5231
5232/* Encrypt or decrypt a message fragment in an active multipart AEAD
5233 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005234psa_status_t psa_aead_update(psa_aead_operation_t *operation,
David Horstmann2914fac2023-12-11 15:28:37 +00005235 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005236 size_t input_length,
David Horstmann2914fac2023-12-11 15:28:37 +00005237 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005238 size_t output_size,
5239 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005240{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005241 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005242
David Horstmann2914fac2023-12-11 15:28:37 +00005243
5244 LOCAL_INPUT_DECLARE(input_external, input);
5245 LOCAL_OUTPUT_DECLARE(output_external, output);
5246
5247 LOCAL_INPUT_ALLOC(input_external, input_length, input);
5248 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
5249
Paul Elliott302ff6b2021-04-20 18:10:30 +01005250 *output_length = 0;
5251
Gilles Peskine449bd832023-01-11 14:50:10 +01005252 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005253 status = PSA_ERROR_BAD_STATE;
5254 goto exit;
5255 }
5256
Gilles Peskine449bd832023-01-11 14:50:10 +01005257 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005258 status = PSA_ERROR_BAD_STATE;
5259 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005260 }
5261
Gilles Peskine449bd832023-01-11 14:50:10 +01005262 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005263 /* Additional data length was supplied, but not all the additional
5264 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005265 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005266 status = PSA_ERROR_INVALID_ARGUMENT;
5267 goto exit;
5268 }
5269
5270 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005271 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005272 status = PSA_ERROR_INVALID_ARGUMENT;
5273 goto exit;
5274 }
5275
5276 operation->body_remaining -= input_length;
5277 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005278#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005279 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005280 status = PSA_ERROR_BAD_STATE;
5281 goto exit;
5282 }
5283#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005284
Gilles Peskine449bd832023-01-11 14:50:10 +01005285 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5286 output, output_size,
5287 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005288
Paul Elliott39dc6b82021-05-11 19:16:09 +01005289exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005290 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005291 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005292 } else {
5293 psa_aead_abort(operation);
5294 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005295
David Horstmann2914fac2023-12-11 15:28:37 +00005296 LOCAL_INPUT_FREE(input_external, input);
5297 LOCAL_OUTPUT_FREE(output_external, output);
5298
Gilles Peskine449bd832023-01-11 14:50:10 +01005299 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005300}
5301
Gilles Peskine449bd832023-01-11 14:50:10 +01005302static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005303{
Gilles Peskine449bd832023-01-11 14:50:10 +01005304 if (operation->id == 0 || !operation->nonce_set) {
5305 return PSA_ERROR_BAD_STATE;
5306 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005307
Gilles Peskine449bd832023-01-11 14:50:10 +01005308 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5309 operation->body_remaining != 0)) {
5310 return PSA_ERROR_INVALID_ARGUMENT;
5311 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005312
Gilles Peskine449bd832023-01-11 14:50:10 +01005313 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005314}
5315
Paul Elliott302ff6b2021-04-20 18:10:30 +01005316/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005317psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
David Horstmann6db0e732023-12-11 15:35:59 +00005318 uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005319 size_t ciphertext_size,
5320 size_t *ciphertext_length,
David Horstmann6db0e732023-12-11 15:35:59 +00005321 uint8_t *tag_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005322 size_t tag_size,
5323 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005324{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005325 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5326
David Horstmann6db0e732023-12-11 15:35:59 +00005327 LOCAL_OUTPUT_DECLARE(ciphertext_external, ciphertext);
5328 LOCAL_OUTPUT_DECLARE(tag_external, tag);
5329
5330 LOCAL_OUTPUT_ALLOC(ciphertext_external, ciphertext_size, ciphertext);
5331 LOCAL_OUTPUT_ALLOC(tag_external, tag_size, tag);
5332
Paul Elliott302ff6b2021-04-20 18:10:30 +01005333 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005334 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005335
Gilles Peskine449bd832023-01-11 14:50:10 +01005336 status = psa_aead_final_checks(operation);
5337 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005338 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005339 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005340
Gilles Peskine449bd832023-01-11 14:50:10 +01005341 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005342 status = PSA_ERROR_BAD_STATE;
5343 goto exit;
5344 }
5345
Gilles Peskine449bd832023-01-11 14:50:10 +01005346 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5347 ciphertext_size,
5348 ciphertext_length,
5349 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005350
Paul Elliott39dc6b82021-05-11 19:16:09 +01005351exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005352
5353
Paul Elliottf47b0952021-05-21 18:02:33 +01005354 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005355 * the zero tag size, make sure the tag is set to something implausible.
5356 * Even if the operation succeeds, make sure we clear the rest of the
5357 * buffer to prevent potential leakage of anything previously placed in
5358 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005359 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005360
Gilles Peskine449bd832023-01-11 14:50:10 +01005361 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005362
David Horstmann6db0e732023-12-11 15:35:59 +00005363 LOCAL_OUTPUT_FREE(ciphertext_external, ciphertext);
5364 LOCAL_OUTPUT_FREE(tag_external, tag);
5365
Gilles Peskine449bd832023-01-11 14:50:10 +01005366 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005367}
5368
5369/* Finish authenticating and decrypting a message in a multipart AEAD
5370 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005371psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
David Horstmanne000a0a2023-12-11 16:37:04 +00005372 uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005373 size_t plaintext_size,
5374 size_t *plaintext_length,
David Horstmanne000a0a2023-12-11 16:37:04 +00005375 const uint8_t *tag_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005377{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005378 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5379
David Horstmanne000a0a2023-12-11 16:37:04 +00005380 LOCAL_OUTPUT_DECLARE(plaintext_external, plaintext);
5381 LOCAL_INPUT_DECLARE(tag_external, tag);
5382
5383 LOCAL_OUTPUT_ALLOC(plaintext_external, plaintext_size, plaintext);
5384 LOCAL_INPUT_ALLOC(tag_external, tag_length, tag);
5385
Paul Elliott302ff6b2021-04-20 18:10:30 +01005386 *plaintext_length = 0;
5387
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 status = psa_aead_final_checks(operation);
5389 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005390 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005391 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005392
Gilles Peskine449bd832023-01-11 14:50:10 +01005393 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005394 status = PSA_ERROR_BAD_STATE;
5395 goto exit;
5396 }
5397
Gilles Peskine449bd832023-01-11 14:50:10 +01005398 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5399 plaintext_size,
5400 plaintext_length,
5401 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005402
5403exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005405
David Horstmanne000a0a2023-12-11 16:37:04 +00005406 LOCAL_OUTPUT_FREE(plaintext_external, plaintext);
5407 LOCAL_INPUT_FREE(tag_external, tag);
5408
Gilles Peskine449bd832023-01-11 14:50:10 +01005409 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005410}
5411
5412/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005413psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005414{
5415 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5416
Gilles Peskine449bd832023-01-11 14:50:10 +01005417 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005418 /* The object has (apparently) been initialized but it is not (yet)
5419 * in use. It's ok to call abort on such an object, and there's
5420 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005421 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005422 }
5423
Gilles Peskine449bd832023-01-11 14:50:10 +01005424 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005425
Gilles Peskine449bd832023-01-11 14:50:10 +01005426 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005427
Gilles Peskine449bd832023-01-11 14:50:10 +01005428 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005429}
5430
Gilles Peskinee59236f2018-01-27 23:32:46 +01005431/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005432/* Generators */
5433/****************************************************************/
5434
Przemek Stekiel69c46792022-06-10 12:59:51 +02005435#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005436 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005437 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305438 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305439 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005440#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005441#endif /* At least one builtin KDF */
5442
Przemek Stekiel69c46792022-06-10 12:59:51 +02005443#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005444 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5445 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5446static psa_status_t psa_key_derivation_start_hmac(
5447 psa_mac_operation_t *operation,
5448 psa_algorithm_t hash_alg,
5449 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005450 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005451{
5452 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5453 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005454 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5455 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5456 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005457
Steven Cooreman72f736a2021-05-07 14:14:37 +02005458 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005459 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005460
Gilles Peskine449bd832023-01-11 14:50:10 +01005461 status = psa_driver_wrapper_mac_sign_setup(operation,
5462 &attributes,
5463 hmac_key, hmac_key_length,
5464 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005465
Gilles Peskine449bd832023-01-11 14:50:10 +01005466 psa_reset_key_attributes(&attributes);
5467 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005468}
5469#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005470
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005471#define HKDF_STATE_INIT 0 /* no input yet */
5472#define HKDF_STATE_STARTED 1 /* got salt */
5473#define HKDF_STATE_KEYED 2 /* got key */
5474#define HKDF_STATE_OUTPUT 3 /* output started */
5475
Gilles Peskinecbe66502019-05-16 16:59:18 +02005476static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005477 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005478{
Gilles Peskine449bd832023-01-11 14:50:10 +01005479 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5480 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5481 } else {
5482 return operation->alg;
5483 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005484}
5485
Gilles Peskine449bd832023-01-11 14:50:10 +01005486psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005487{
5488 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005489 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5490 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005491 /* The object has (apparently) been initialized but it is not
5492 * in use. It's ok to call abort on such an object, and there's
5493 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005494 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005495#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005496 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5497 mbedtls_free(operation->ctx.hkdf.info);
5498 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5499 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005500#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005501#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5502 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005503 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5504 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5505 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5506 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005507 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005509 }
5510
Gilles Peskine449bd832023-01-11 14:50:10 +01005511 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005512 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005514 }
5515
Gilles Peskine449bd832023-01-11 14:50:10 +01005516 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005517 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005518 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005519 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005520#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005521 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005522 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005523 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005524 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005525#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005526 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005527
5528 /* We leave the fields Ai and output_block to be erased safely by the
5529 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005530 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005531#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5532 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005533#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005534 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5535 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5536 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5537 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005538#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305539#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305540 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305541 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005542 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305543 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305544 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305545
5546 status = PSA_SUCCESS;
5547 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305548#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005549 {
5550 status = PSA_ERROR_BAD_STATE;
5551 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005552 mbedtls_platform_zeroize(operation, sizeof(*operation));
5553 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005554}
5555
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005556psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005557 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005558{
Gilles Peskine449bd832023-01-11 14:50:10 +01005559 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005560 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005561 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005562 }
5563
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005564 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005565 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005566}
5567
Gilles Peskine449bd832023-01-11 14:50:10 +01005568psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5569 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005570{
Gilles Peskine449bd832023-01-11 14:50:10 +01005571 if (operation->alg == 0) {
5572 return PSA_ERROR_BAD_STATE;
5573 }
5574 if (capacity > operation->capacity) {
5575 return PSA_ERROR_INVALID_ARGUMENT;
5576 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005577 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005578 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005579}
5580
Przemek Stekiel69c46792022-06-10 12:59:51 +02005581#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005582/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005583static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5584 psa_algorithm_t kdf_alg,
5585 uint8_t *output,
5586 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005587{
Gilles Peskine449bd832023-01-11 14:50:10 +01005588 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5589 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005590 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005591 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005592#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005593 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005594#else
5595 const uint8_t last_block = 0xff;
5596#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005597
Gilles Peskine449bd832023-01-11 14:50:10 +01005598 if (hkdf->state < HKDF_STATE_KEYED ||
5599 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005600#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005601 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005602#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005603 )) {
5604 return PSA_ERROR_BAD_STATE;
5605 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005606 hkdf->state = HKDF_STATE_OUTPUT;
5607
Gilles Peskine449bd832023-01-11 14:50:10 +01005608 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005609 /* Copy what remains of the current block */
5610 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005611 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005612 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005613 }
5614 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005615 output += n;
5616 output_length -= n;
5617 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005619 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005620 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005621 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005622 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005623 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005624 * object was corrupted or if this function is called directly
5625 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005626 if (hkdf->block_number == last_block) {
5627 return PSA_ERROR_BAD_STATE;
5628 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005629
5630 /* We need a new block */
5631 ++hkdf->block_number;
5632 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005633
Gilles Peskine449bd832023-01-11 14:50:10 +01005634 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5635 hash_alg,
5636 hkdf->prk,
5637 hash_length);
5638 if (status != PSA_SUCCESS) {
5639 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005640 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005641
5642 if (hkdf->block_number != 1) {
5643 status = psa_mac_update(&hkdf->hmac,
5644 hkdf->output_block,
5645 hash_length);
5646 if (status != PSA_SUCCESS) {
5647 return status;
5648 }
5649 }
5650 status = psa_mac_update(&hkdf->hmac,
5651 hkdf->info,
5652 hkdf->info_length);
5653 if (status != PSA_SUCCESS) {
5654 return status;
5655 }
5656 status = psa_mac_update(&hkdf->hmac,
5657 &hkdf->block_number, 1);
5658 if (status != PSA_SUCCESS) {
5659 return status;
5660 }
5661 status = psa_mac_sign_finish(&hkdf->hmac,
5662 hkdf->output_block,
5663 sizeof(hkdf->output_block),
5664 &hmac_output_length);
5665 if (status != PSA_SUCCESS) {
5666 return status;
5667 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005668 }
5669
Gilles Peskine449bd832023-01-11 14:50:10 +01005670 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005671}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005672#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005673
John Durkop07cc04a2020-11-16 22:08:34 -08005674#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5675 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005676static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5677 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005678 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005679{
Gilles Peskine449bd832023-01-11 14:50:10 +01005680 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5681 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005682 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5683 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005684 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005685
Janos Follath7742fee2019-06-17 12:58:10 +01005686 /* We can't be wanting more output after block 0xff, otherwise
5687 * the capacity check in psa_key_derivation_output_bytes() would have
5688 * prevented this call. It could happen only if the operation
5689 * object was corrupted or if this function is called directly
5690 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005691 if (tls12_prf->block_number == 0xff) {
5692 return PSA_ERROR_CORRUPTION_DETECTED;
5693 }
Janos Follath7742fee2019-06-17 12:58:10 +01005694
5695 /* We need a new block */
5696 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005697 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005698
5699 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5700 *
5701 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5702 *
5703 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5704 * HMAC_hash(secret, A(2) + seed) +
5705 * HMAC_hash(secret, A(3) + seed) + ...
5706 *
5707 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005708 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005709 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005710 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005711 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005712 * is currently extracted as `output_block` and where i is
5713 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005714 */
5715
Gilles Peskine449bd832023-01-11 14:50:10 +01005716 status = psa_key_derivation_start_hmac(&hmac,
5717 hash_alg,
5718 tls12_prf->secret,
5719 tls12_prf->secret_length);
5720 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005721 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005722 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005723
5724 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005725 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005726 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5727 * the variable seed and in this instance means it in the context of the
5728 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005729 status = psa_mac_update(&hmac,
5730 tls12_prf->label,
5731 tls12_prf->label_length);
5732 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005733 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005734 }
5735 status = psa_mac_update(&hmac,
5736 tls12_prf->seed,
5737 tls12_prf->seed_length);
5738 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005739 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005740 }
5741 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005742 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005743 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5744 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005745 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005746 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005747 }
5748
Gilles Peskine449bd832023-01-11 14:50:10 +01005749 status = psa_mac_sign_finish(&hmac,
5750 tls12_prf->Ai, hash_length,
5751 &hmac_output_length);
5752 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005753 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005754 }
5755 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005756 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005757 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005758
5759 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005760 status = psa_key_derivation_start_hmac(&hmac,
5761 hash_alg,
5762 tls12_prf->secret,
5763 tls12_prf->secret_length);
5764 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005765 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005766 }
5767 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5768 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005769 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005770 }
5771 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5772 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005773 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005774 }
5775 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5776 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005777 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005778 }
5779 status = psa_mac_sign_finish(&hmac,
5780 tls12_prf->output_block, hash_length,
5781 &hmac_output_length);
5782 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005783 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005784 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005785
Janos Follath7742fee2019-06-17 12:58:10 +01005786
5787cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005788 cleanup_status = psa_mac_abort(&hmac);
5789 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005790 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005791 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005792
Gilles Peskine449bd832023-01-11 14:50:10 +01005793 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005794}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005795
Janos Follath844eb0e2019-06-19 12:10:49 +01005796static psa_status_t psa_key_derivation_tls12_prf_read(
5797 psa_tls12_prf_key_derivation_t *tls12_prf,
5798 psa_algorithm_t alg,
5799 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005800 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005801{
Gilles Peskine449bd832023-01-11 14:50:10 +01005802 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5803 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005804 psa_status_t status;
5805 uint8_t offset, length;
5806
Gilles Peskine449bd832023-01-11 14:50:10 +01005807 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005808 case PSA_TLS12_PRF_STATE_LABEL_SET:
5809 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5810 break;
5811 case PSA_TLS12_PRF_STATE_OUTPUT:
5812 break;
5813 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005814 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005815 }
5816
Gilles Peskine449bd832023-01-11 14:50:10 +01005817 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005818 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005819 if (tls12_prf->left_in_block == 0) {
5820 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5821 alg);
5822 if (status != PSA_SUCCESS) {
5823 return status;
5824 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005825
5826 continue;
5827 }
5828
Gilles Peskine449bd832023-01-11 14:50:10 +01005829 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005830 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005831 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005832 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005833 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005834
5835 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005836 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005837 output += length;
5838 output_length -= length;
5839 tls12_prf->left_in_block -= length;
5840 }
5841
Gilles Peskine449bd832023-01-11 14:50:10 +01005842 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005843}
John Durkop07cc04a2020-11-16 22:08:34 -08005844#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5845 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005846
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005847#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5848static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5849 psa_tls12_ecjpake_to_pms_t *ecjpake,
5850 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005851 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005852{
5853 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005854 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005855
Gilles Peskine449bd832023-01-11 14:50:10 +01005856 if (output_length != 32) {
5857 return PSA_ERROR_INVALID_ARGUMENT;
5858 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005859
Gilles Peskine449bd832023-01-11 14:50:10 +01005860 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5861 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5862 &output_size);
5863 if (status != PSA_SUCCESS) {
5864 return status;
5865 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005866
Gilles Peskine449bd832023-01-11 14:50:10 +01005867 if (output_size != output_length) {
5868 return PSA_ERROR_GENERIC_ERROR;
5869 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005870
Gilles Peskine449bd832023-01-11 14:50:10 +01005871 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005872}
5873#endif
5874
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305875#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305876static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5877 psa_pbkdf2_key_derivation_t *pbkdf2,
5878 psa_algorithm_t prf_alg,
5879 uint8_t prf_output_length,
5880 psa_key_attributes_t *attributes)
5881{
5882 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305883 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305884 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305885 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305886 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305887 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305888 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305889
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305890 mac_operation.is_sign = 1;
5891 mac_operation.mac_size = prf_output_length;
5892 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305893
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305894 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5895 attributes,
5896 pbkdf2->password,
5897 pbkdf2->password_length,
5898 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305899 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305900 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305901 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305902 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5903 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305904 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305905 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305906 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305907 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305908 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305909 }
5910 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5911 &mac_output_length);
5912 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305913 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305914 }
5915
5916 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305917 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305918 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305919 }
5920
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305921 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305922
5923 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305924 /* We are passing prf_output_length as mac_size because the driver
5925 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305926 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305927 status = psa_driver_wrapper_mac_compute(attributes,
5928 pbkdf2->password,
5929 pbkdf2->password_length,
5930 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305931 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305932 &mac_output_length);
5933 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305934 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305935 }
5936
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305937 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305938 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305939
5940cleanup:
5941 /* Zeroise buffers to clear sensitive data from memory. */
5942 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5943 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305944}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305945
5946static psa_status_t psa_key_derivation_pbkdf2_read(
5947 psa_pbkdf2_key_derivation_t *pbkdf2,
5948 psa_algorithm_t kdf_alg,
5949 uint8_t *output,
5950 size_t output_length)
5951{
5952 psa_status_t status;
5953 psa_algorithm_t prf_alg;
5954 uint8_t prf_output_length;
5955 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5956 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5957 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5958
5959 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5960 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5961 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5962 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305963 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5964 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305965 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305966 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305967 } else {
5968 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305969 }
5970
5971 switch (pbkdf2->state) {
5972 case PSA_PBKDF2_STATE_PASSWORD_SET:
5973 /* Initially we need a new block so bytes_used is equal to block size*/
5974 pbkdf2->bytes_used = prf_output_length;
5975 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5976 break;
5977 case PSA_PBKDF2_STATE_OUTPUT:
5978 break;
5979 default:
5980 return PSA_ERROR_BAD_STATE;
5981 }
5982
5983 while (output_length != 0) {
5984 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5985 if (n > output_length) {
5986 n = (uint8_t) output_length;
5987 }
5988 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5989 output += n;
5990 output_length -= n;
5991 pbkdf2->bytes_used += n;
5992
5993 if (output_length == 0) {
5994 break;
5995 }
5996
5997 /* We need a new block */
5998 pbkdf2->bytes_used = 0;
5999 pbkdf2->block_number++;
6000
6001 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
6002 prf_output_length,
6003 &attributes);
6004 if (status != PSA_SUCCESS) {
6005 return status;
6006 }
6007 }
6008
6009 return PSA_SUCCESS;
6010}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306011#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306012
Janos Follath6c6c8fc2019-06-17 12:38:20 +01006013psa_status_t psa_key_derivation_output_bytes(
6014 psa_key_derivation_operation_t *operation,
Ryan Everettf943e222024-01-19 14:46:39 +00006015 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01006016 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006017{
6018 psa_status_t status;
Ryan Everettf943e222024-01-19 14:46:39 +00006019 LOCAL_OUTPUT_DECLARE(output_external, output);
6020
Gilles Peskine449bd832023-01-11 14:50:10 +01006021 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02006022
Gilles Peskine449bd832023-01-11 14:50:10 +01006023 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006024 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006025 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006026 }
6027
Gilles Peskine449bd832023-01-11 14:50:10 +01006028 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006029 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006030 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02006031 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
6032 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006033 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02006034 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006035 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006036 }
Ryan Everettf943e222024-01-19 14:46:39 +00006037
6038 LOCAL_OUTPUT_ALLOC(output_external, output_length, output);
Ryan Everettda9227d2024-01-25 11:37:22 +00006039 if (output_length > operation->capacity) {
6040 operation->capacity = 0;
6041 /* Go through the error path to wipe all confidential data now
6042 * that the operation object is useless. */
6043 status = PSA_ERROR_INSUFFICIENT_DATA;
6044 goto exit;
6045 }
6046
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006047 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006048
Przemek Stekiel69c46792022-06-10 12:59:51 +02006049#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006050 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6051 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
6052 output, output_length);
6053 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006054#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006055#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6056 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006057 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6058 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6059 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
6060 kdf_alg, output,
6061 output_length);
6062 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006063#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
6064 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006065#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006066 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006067 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01006068 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
6069 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006070#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306071#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306072 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05306073 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
6074 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05306075 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306076#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006077
Gilles Peskineeab56e42018-07-12 17:12:33 +02006078 {
Steven Cooreman74afe472021-02-10 17:19:22 +01006079 (void) kdf_alg;
Ryan Everettf943e222024-01-19 14:46:39 +00006080 status = PSA_ERROR_BAD_STATE;
6081 LOCAL_OUTPUT_FREE(output_external, output);
6082
6083 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006084 }
6085
6086exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006087 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006088 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006089 * This allows us to differentiate between exhausted operations and
6090 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
6091 * operations. */
6092 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006094 operation->alg = alg;
Ryan Everettee5920a2024-02-09 15:09:28 +00006095 if (output != NULL) {
6096 memset(output, '!', output_length);
6097 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006098 }
Ryan Everettda9227d2024-01-25 11:37:22 +00006099
6100 LOCAL_OUTPUT_FREE(output_external, output);
Gilles Peskine449bd832023-01-11 14:50:10 +01006101 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006102}
6103
David Brown7807bf72021-02-09 16:28:23 -07006104#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006105static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02006106{
Gilles Peskine449bd832023-01-11 14:50:10 +01006107 if (data_size >= 8) {
6108 mbedtls_des_key_set_parity(data);
6109 }
6110 if (data_size >= 16) {
6111 mbedtls_des_key_set_parity(data + 8);
6112 }
6113 if (data_size >= 24) {
6114 mbedtls_des_key_set_parity(data + 16);
6115 }
Gilles Peskine08542d82018-07-19 17:05:42 +02006116}
David Brown7807bf72021-02-09 16:28:23 -07006117#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02006118
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006119/*
Gilles Peskine449bd832023-01-11 14:50:10 +01006120 * ECC keys on a Weierstrass elliptic curve require the generation
6121 * of a private key which is an integer
6122 * in the range [1, N - 1], where N is the boundary of the private key domain:
6123 * N is the prime p for Diffie-Hellman, or the order of the
6124 * curve’s base point for ECC.
6125 *
6126 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
6127 * This function generates the private key using the following process:
6128 *
6129 * 1. Draw a byte string of length ceiling(m/8) bytes.
6130 * 2. If m is not a multiple of 8, set the most significant
6131 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
6132 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
6133 * 4. If k > N - 2, discard the result and return to step 1.
6134 * 5. Output k + 1 as the private key.
6135 *
6136 * This method allows compliance to NIST standards, specifically the methods titled
6137 * Key-Pair Generation by Testing Candidates in the following publications:
6138 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
6139 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
6140 * Diffie-Hellman keys.
6141 *
6142 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
6143 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
6144 *
6145 * Note: Function allocates memory for *data buffer, so given *data should be
6146 * always NULL.
6147 */
Valerio Setti86587ab2023-06-27 13:09:30 +02006148#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
6149#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006150static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006151 psa_key_slot_t *slot,
6152 size_t bits,
6153 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006154 uint8_t **data
6155 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006156{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006157 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006158 mbedtls_mpi k;
6159 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006160 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006161 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006162 size_t m;
6163 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006164
Gilles Peskine449bd832023-01-11 14:50:10 +01006165 mbedtls_mpi_init(&k);
6166 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006167
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006168 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01006169 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006170 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01006171 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006172
Gilles Peskine449bd832023-01-11 14:50:10 +01006173 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006174 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01006175 goto cleanup;
6176 }
6177
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006178 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01006179 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006180
Gilles Peskine449bd832023-01-11 14:50:10 +01006181 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006182
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006183 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006184 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006185 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006186
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006187 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006188
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006189 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006191
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006192 /* Note: This function is always called with *data == NULL and it
6193 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006194 *data = mbedtls_calloc(1, m_bytes);
6195 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006196 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006197 goto cleanup;
6198 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006199
Gilles Peskine449bd832023-01-11 14:50:10 +01006200 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006201 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006202 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006203 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01006204 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006205
6206 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006207 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006208 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006209 * (8 * ceiling(m/8) - m) bits of the first byte in
6210 * the string to zero.
6211 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006212 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006213 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006214 }
6215
6216 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01006217 * big-endian byte string.
6218 */
6219 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006220
6221 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 * Result of comparison is returned. When it indicates error
6223 * then this function is called again.
6224 */
6225 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006226 }
6227
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006228 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006229 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6230 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006231cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006232 if (ret != 0) {
6233 status = mbedtls_to_psa_error(ret);
6234 }
6235 if (status != PSA_SUCCESS) {
6236 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006237 *data = NULL;
6238 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006239 mbedtls_mpi_free(&k);
6240 mbedtls_mpi_free(&diff_N_2);
6241 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006242}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006243
6244/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6245 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6246 *
6247 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6248 * draw a 32-byte string and process it as specified in
6249 * Elliptic Curves for Security [RFC7748] §5.
6250 *
6251 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6252 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6253 *
6254 * Note: Function allocates memory for *data buffer, so given *data should be
6255 * always NULL.
6256 */
6257
6258static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6259 size_t bits,
6260 psa_key_derivation_operation_t *operation,
6261 uint8_t **data
6262 )
6263{
6264 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006265 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006266
Gilles Peskine449bd832023-01-11 14:50:10 +01006267 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006268 case 255:
6269 output_length = 32;
6270 break;
6271 case 448:
6272 output_length = 56;
6273 break;
6274 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006275 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006276 break;
6277 }
6278
Gilles Peskine449bd832023-01-11 14:50:10 +01006279 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006280
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 if (*data == NULL) {
6282 return PSA_ERROR_INSUFFICIENT_MEMORY;
6283 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006284
Gilles Peskine449bd832023-01-11 14:50:10 +01006285 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006286
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006288 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006289 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006290
Gilles Peskine449bd832023-01-11 14:50:10 +01006291 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006292 case 255:
6293 (*data)[0] &= 248;
6294 (*data)[31] &= 127;
6295 (*data)[31] |= 64;
6296 break;
6297 case 448:
6298 (*data)[0] &= 252;
6299 (*data)[55] |= 128;
6300 break;
6301 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006302 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006303 break;
6304 }
6305
6306 return status;
6307}
Valerio Setti86587ab2023-06-27 13:09:30 +02006308#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6309static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6310 psa_key_slot_t *slot, size_t bits,
6311 psa_key_derivation_operation_t *operation, uint8_t **data)
6312{
6313 (void) slot;
6314 (void) bits;
6315 (void) operation;
6316 (void) data;
6317 return PSA_ERROR_NOT_SUPPORTED;
6318}
6319
6320static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6321 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6322{
6323 (void) bits;
6324 (void) operation;
6325 (void) data;
6326 return PSA_ERROR_NOT_SUPPORTED;
6327}
6328#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6329#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006330
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006331static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006332 psa_key_slot_t *slot,
6333 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006334 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006335{
6336 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006337 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306338 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006339 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006340
Gilles Peskine449bd832023-01-11 14:50:10 +01006341 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6342 return PSA_ERROR_INVALID_ARGUMENT;
6343 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006344
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006345#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006346 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006347 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6348 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6349 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006350 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006351 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6352 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006353 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006354 }
6355 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006356 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006357 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6358 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006359 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006360 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006361 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006362 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006363#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006364 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006365 if (key_type_is_raw_bytes(slot->attr.type)) {
6366 if (bits % 8 != 0) {
6367 return PSA_ERROR_INVALID_ARGUMENT;
6368 }
6369 data = mbedtls_calloc(1, bytes);
6370 if (data == NULL) {
6371 return PSA_ERROR_INSUFFICIENT_MEMORY;
6372 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006373
Gilles Peskine449bd832023-01-11 14:50:10 +01006374 status = psa_key_derivation_output_bytes(operation, data, bytes);
6375 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006376 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006377 }
David Brown12ca5032021-02-11 11:02:00 -07006378#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006379 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6380 psa_des_set_key_parity(data, bytes);
6381 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006382#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006383 } else {
6384 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006385 }
Ronald Crondd04d422020-11-28 15:14:42 +01006386
Ronald Cronbf33c932020-11-28 18:06:53 +01006387 slot->attr.bits = (psa_key_bits_t) bits;
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006388
Gilles Peskine2f107ae2024-02-28 01:26:46 +01006389 if (psa_key_lifetime_is_external(slot->attr.lifetime)) {
Gilles Peskine7a5d9202024-02-28 01:18:23 +01006390 status = psa_driver_wrapper_get_key_buffer_size(&slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01006391 &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 Peskine449bd832023-01-11 14:50:10 +01006396 status = psa_allocate_buffer_to_slot(slot, storage_size);
6397 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306398 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006399 }
Archanad8a83dc2021-06-14 10:04:16 +05306400
Gilles Peskine7a5d9202024-02-28 01:18:23 +01006401 status = psa_driver_wrapper_import_key(&slot->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01006402 data, bytes,
6403 slot->key.data,
6404 slot->key.bytes,
6405 &slot->key.bytes, &bits);
6406 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006407 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006408 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006409
6410exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006411 mbedtls_free(data);
6412 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006413}
6414
Gilles Peskinef36d7852024-06-06 21:11:44 +02006415static const psa_custom_key_parameters_t default_custom_production =
Gilles Peskine4a85ff32024-07-18 18:52:59 +02006416 PSA_CUSTOM_KEY_PARAMETERS_INIT;
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006417
Gilles Peskine52504f82024-06-20 17:19:58 +02006418int psa_custom_key_parameters_are_default(
Gilles Peskinef36d7852024-06-06 21:11:44 +02006419 const psa_custom_key_parameters_t *custom,
6420 size_t custom_data_length)
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006421{
Gilles Peskinef36d7852024-06-06 21:11:44 +02006422 if (custom->flags != 0) {
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006423 return 0;
6424 }
Gilles Peskinef36d7852024-06-06 21:11:44 +02006425 if (custom_data_length != 0) {
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006426 return 0;
6427 }
6428 return 1;
6429}
6430
Gilles Peskinef36d7852024-06-06 21:11:44 +02006431psa_status_t psa_key_derivation_output_key_custom(
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006432 const psa_key_attributes_t *attributes,
6433 psa_key_derivation_operation_t *operation,
Gilles Peskinef36d7852024-06-06 21:11:44 +02006434 const psa_custom_key_parameters_t *custom,
6435 const uint8_t *custom_data,
6436 size_t custom_data_length,
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006437 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006438{
6439 psa_status_t status;
6440 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006441 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006442
Ronald Cron81709fc2020-11-14 12:10:32 +01006443 *key = MBEDTLS_SVC_KEY_ID_INIT;
6444
Gilles Peskine0f84d622019-09-12 19:03:13 +02006445 /* Reject any attempt to create a zero-length key so that we don't
6446 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006447 if (psa_get_key_bits(attributes) == 0) {
6448 return PSA_ERROR_INVALID_ARGUMENT;
6449 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006450
Gilles Peskinef36d7852024-06-06 21:11:44 +02006451 (void) custom_data; /* We only accept 0-length data */
Gilles Peskine52504f82024-06-20 17:19:58 +02006452 if (!psa_custom_key_parameters_are_default(custom, custom_data_length)) {
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006453 return PSA_ERROR_INVALID_ARGUMENT;
6454 }
6455
Gilles Peskine449bd832023-01-11 14:50:10 +01006456 if (operation->alg == PSA_ALG_NONE) {
6457 return PSA_ERROR_BAD_STATE;
6458 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006459
Gilles Peskine449bd832023-01-11 14:50:10 +01006460 if (!operation->can_output_key) {
6461 return PSA_ERROR_NOT_PERMITTED;
6462 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006463
Gilles Peskine449bd832023-01-11 14:50:10 +01006464 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6465 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006466#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006467 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006468 /* Deriving a key in a secure element is not implemented yet. */
6469 status = PSA_ERROR_NOT_SUPPORTED;
6470 }
6471#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006472 if (status == PSA_SUCCESS) {
6473 status = psa_generate_derived_key_internal(slot,
Gilles Peskine2f107ae2024-02-28 01:26:46 +01006474 attributes->bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006475 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006476 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006477 if (status == PSA_SUCCESS) {
6478 status = psa_finish_key_creation(slot, driver, key);
6479 }
6480 if (status != PSA_SUCCESS) {
6481 psa_fail_key_creation(slot, driver);
6482 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006483
Gilles Peskine449bd832023-01-11 14:50:10 +01006484 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006485}
6486
Gilles Peskinef36d7852024-06-06 21:11:44 +02006487psa_status_t psa_key_derivation_output_key_ext(
6488 const psa_key_attributes_t *attributes,
6489 psa_key_derivation_operation_t *operation,
6490 const psa_key_production_parameters_t *params,
6491 size_t params_data_length,
6492 mbedtls_svc_key_id_t *key)
6493{
6494 return psa_key_derivation_output_key_custom(
6495 attributes, operation,
6496 (const psa_custom_key_parameters_t *) params,
6497 params->data, params_data_length,
6498 key);
6499}
6500
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006501psa_status_t psa_key_derivation_output_key(
6502 const psa_key_attributes_t *attributes,
6503 psa_key_derivation_operation_t *operation,
6504 mbedtls_svc_key_id_t *key)
6505{
Gilles Peskinef36d7852024-06-06 21:11:44 +02006506 return psa_key_derivation_output_key_custom(attributes, operation,
6507 &default_custom_production,
6508 NULL, 0,
6509 key);
Gilles Peskinef0765fa2024-02-12 16:46:16 +01006510}
Gilles Peskineeab56e42018-07-12 17:12:33 +02006511
6512
6513/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006514/* Key derivation */
6515/****************************************************************/
6516
Steven Cooreman932ffb72021-02-15 12:14:32 +01006517#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006518static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006519{
6520#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006521 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6522 return 1;
6523 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006524#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006525#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006526 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6527 return 1;
6528 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006529#endif
6530#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006531 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6532 return 1;
6533 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006534#endif
6535#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006536 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6537 return 1;
6538 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006539#endif
6540#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006541 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6542 return 1;
6543 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006544#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006545#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006546 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6547 return 1;
6548 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006549#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306550#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6551 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6552 return 1;
6553 }
6554#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306555#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6556 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6557 return 1;
6558 }
6559#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006560 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006561}
6562
Gilles Peskine449bd832023-01-11 14:50:10 +01006563static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006564{
6565 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006566 psa_status_t status = psa_hash_setup(&operation, alg);
6567 psa_hash_abort(&operation);
6568 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006569}
6570
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306571static psa_status_t psa_key_derivation_set_maximum_capacity(
6572 psa_key_derivation_operation_t *operation,
6573 psa_algorithm_t kdf_alg)
6574{
6575#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6576 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6577 operation->capacity = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6578 return PSA_SUCCESS;
6579 }
6580#endif
6581#if defined(PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128)
6582 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6583#if (SIZE_MAX > UINT32_MAX)
Kusumit Ghoderao7d4db632023-12-07 16:17:46 +05306584 operation->capacity = UINT32_MAX * (size_t) PSA_MAC_LENGTH(
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306585 PSA_KEY_TYPE_AES,
6586 128U,
6587 PSA_ALG_CMAC);
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306588#else
6589 operation->capacity = SIZE_MAX;
6590#endif
6591 return PSA_SUCCESS;
6592 }
6593#endif /* PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128 */
6594
6595 /* After this point, if kdf_alg is not valid then value of hash_alg may be
6596 * invalid or meaningless but it does not affect this function */
6597 psa_algorithm_t hash_alg = PSA_ALG_GET_HASH(kdf_alg);
6598 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306599 if (hash_size == 0) {
6600 return PSA_ERROR_NOT_SUPPORTED;
6601 }
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306602
6603 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6604 * we might fail later, which is somewhat unfriendly and potentially
6605 * risk-prone. */
6606 psa_status_t status = psa_hash_try_support(hash_alg);
6607 if (status != PSA_SUCCESS) {
6608 return status;
6609 }
6610
6611#if defined(PSA_WANT_ALG_HKDF)
6612 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6613 operation->capacity = 255 * hash_size;
6614 } else
6615#endif
6616#if defined(PSA_WANT_ALG_HKDF_EXTRACT)
6617 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6618 operation->capacity = hash_size;
6619 } else
6620#endif
6621#if defined(PSA_WANT_ALG_HKDF_EXPAND)
6622 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6623 operation->capacity = 255 * hash_size;
6624 } else
6625#endif
6626#if defined(PSA_WANT_ALG_TLS12_PRF)
6627 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) &&
6628 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6629 operation->capacity = SIZE_MAX;
6630 } else
6631#endif
6632#if defined(PSA_WANT_ALG_TLS12_PSK_TO_MS)
6633 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg) &&
6634 (hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6635 /* Master Secret is always 48 bytes
6636 * https://datatracker.ietf.org/doc/html/rfc5246.html#section-8.1 */
6637 operation->capacity = 48U;
6638 } else
6639#endif
6640#if defined(PSA_WANT_ALG_PBKDF2_HMAC)
6641 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6642#if (SIZE_MAX > UINT32_MAX)
6643 operation->capacity = UINT32_MAX * hash_size;
6644#else
6645 operation->capacity = SIZE_MAX;
6646#endif
6647 } else
6648#endif /* PSA_WANT_ALG_PBKDF2_HMAC */
6649 {
Kusumit Ghoderaod3f70d32023-12-06 16:20:04 +05306650 (void) hash_size;
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306651 status = PSA_ERROR_NOT_SUPPORTED;
6652 }
6653 return status;
6654}
6655
Gilles Peskine969c5d62019-01-16 15:53:06 +01006656static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006657 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006658 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006659{
Janos Follath5fe19732019-06-20 15:09:30 +01006660 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6661 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006662 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006663
Gilles Peskine969c5d62019-01-16 15:53:06 +01006664 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006665 if (!is_kdf_alg_supported(kdf_alg)) {
6666 return PSA_ERROR_NOT_SUPPORTED;
6667 }
John Durkop07cc04a2020-11-16 22:08:34 -08006668
Kusumit Ghoderao86e83dd2023-12-01 16:38:26 +05306669 psa_status_t status = psa_key_derivation_set_maximum_capacity(operation,
6670 kdf_alg);
Kusumit Ghoderao5f3a9382023-09-13 16:28:12 +05306671 return status;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006672}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006673
Gilles Peskine449bd832023-01-11 14:50:10 +01006674static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006675{
6676#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006677 if (alg == PSA_ALG_ECDH) {
6678 return PSA_SUCCESS;
6679 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006680#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006681#if defined(PSA_WANT_ALG_FFDH)
6682 if (alg == PSA_ALG_FFDH) {
6683 return PSA_SUCCESS;
6684 }
6685#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006686 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006687 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006688}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006689
6690static int psa_key_derivation_allows_free_form_secret_input(
6691 psa_algorithm_t kdf_alg)
6692{
6693#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6694 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6695 return 0;
6696 }
6697#endif
6698 (void) kdf_alg;
6699 return 1;
6700}
John Durkop07cc04a2020-11-16 22:08:34 -08006701#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006702
Gilles Peskine449bd832023-01-11 14:50:10 +01006703psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6704 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006705{
6706 psa_status_t status;
6707
Gilles Peskine449bd832023-01-11 14:50:10 +01006708 if (operation->alg != 0) {
6709 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006710 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006711
Gilles Peskine449bd832023-01-11 14:50:10 +01006712 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6713 return PSA_ERROR_INVALID_ARGUMENT;
6714 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6715#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6716 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6717 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6718 status = psa_key_agreement_try_support(ka_alg);
6719 if (status != PSA_SUCCESS) {
6720 return status;
6721 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006722 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6723 return PSA_ERROR_INVALID_ARGUMENT;
6724 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006725 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6726#else
6727 return PSA_ERROR_NOT_SUPPORTED;
6728#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6729 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6730#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6731 status = psa_key_derivation_setup_kdf(operation, alg);
6732#else
6733 return PSA_ERROR_NOT_SUPPORTED;
6734#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6735 } else {
6736 return PSA_ERROR_INVALID_ARGUMENT;
6737 }
6738
6739 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006740 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006741 }
6742 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006743}
6744
Przemek Stekiel69c46792022-06-10 12:59:51 +02006745#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006746static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6747 psa_algorithm_t kdf_alg,
6748 psa_key_derivation_step_t step,
6749 const uint8_t *data,
6750 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006751{
Gilles Peskine449bd832023-01-11 14:50:10 +01006752 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006753 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006754 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006755 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006756#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006757 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6758 return PSA_ERROR_INVALID_ARGUMENT;
6759 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006760#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006761 if (hkdf->state != HKDF_STATE_INIT) {
6762 return PSA_ERROR_BAD_STATE;
6763 } else {
6764 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6765 hash_alg,
6766 data, data_length);
6767 if (status != PSA_SUCCESS) {
6768 return status;
6769 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006770 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006771 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006772 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006773 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006774#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006775 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006776 /* We shouldn't be in different state as HKDF_EXPAND only allows
6777 * two inputs: SECRET (this case) and INFO which does not modify
6778 * the state. It could happen only if the hkdf
6779 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006780 if (hkdf->state != HKDF_STATE_INIT) {
6781 return PSA_ERROR_BAD_STATE;
6782 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006783
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006784 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006785 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6786 return PSA_ERROR_INVALID_ARGUMENT;
6787 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006788
Gilles Peskine449bd832023-01-11 14:50:10 +01006789 memcpy(hkdf->prk, data, data_length);
6790 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006791#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006792 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006793 /* HKDF: If no salt was provided, use an empty salt.
6794 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006795 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006796#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006797 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6798 return PSA_ERROR_BAD_STATE;
6799 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006800#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006801 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6802 hash_alg,
6803 NULL, 0);
6804 if (status != PSA_SUCCESS) {
6805 return status;
6806 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006807 hkdf->state = HKDF_STATE_STARTED;
6808 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006809 if (hkdf->state != HKDF_STATE_STARTED) {
6810 return PSA_ERROR_BAD_STATE;
6811 }
6812 status = psa_mac_update(&hkdf->hmac,
6813 data, data_length);
6814 if (status != PSA_SUCCESS) {
6815 return status;
6816 }
6817 status = psa_mac_sign_finish(&hkdf->hmac,
6818 hkdf->prk,
6819 sizeof(hkdf->prk),
6820 &data_length);
6821 if (status != PSA_SUCCESS) {
6822 return status;
6823 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006824 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006825
Gilles Peskine2b522db2019-04-12 15:11:49 +02006826 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006827 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006828#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006829 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006830 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006831 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006832 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006833 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006834#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006835 {
6836 /* Block 0 is empty, and the next block will be
6837 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006838 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006839 }
6840
Gilles Peskine449bd832023-01-11 14:50:10 +01006841 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006842 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006843#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006844 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6845 return PSA_ERROR_INVALID_ARGUMENT;
6846 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006847#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006848#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006849 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6850 hkdf->state == HKDF_STATE_INIT) {
6851 return PSA_ERROR_BAD_STATE;
6852 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006853#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006854 if (hkdf->state == HKDF_STATE_OUTPUT) {
6855 return PSA_ERROR_BAD_STATE;
6856 }
6857 if (hkdf->info_set) {
6858 return PSA_ERROR_BAD_STATE;
6859 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006860 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006861 if (data_length != 0) {
6862 hkdf->info = mbedtls_calloc(1, data_length);
6863 if (hkdf->info == NULL) {
6864 return PSA_ERROR_INSUFFICIENT_MEMORY;
6865 }
6866 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006867 }
6868 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006869 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006870 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006871 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006872 }
6873}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006874#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006875
John Durkop07cc04a2020-11-16 22:08:34 -08006876#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6877 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006878static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6879 const uint8_t *data,
6880 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006881{
Gilles Peskine449bd832023-01-11 14:50:10 +01006882 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6883 return PSA_ERROR_BAD_STATE;
6884 }
Janos Follathf08e2652019-06-13 09:05:41 +01006885
Gilles Peskine449bd832023-01-11 14:50:10 +01006886 if (data_length != 0) {
6887 prf->seed = mbedtls_calloc(1, data_length);
6888 if (prf->seed == NULL) {
6889 return PSA_ERROR_INSUFFICIENT_MEMORY;
6890 }
Janos Follathf08e2652019-06-13 09:05:41 +01006891
Gilles Peskine449bd832023-01-11 14:50:10 +01006892 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006893 prf->seed_length = data_length;
6894 }
Janos Follathf08e2652019-06-13 09:05:41 +01006895
Gilles Peskine43f958b2020-12-13 14:55:14 +01006896 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006897
Gilles Peskine449bd832023-01-11 14:50:10 +01006898 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006899}
6900
Gilles Peskine449bd832023-01-11 14:50:10 +01006901static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6902 const uint8_t *data,
6903 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006904{
Gilles Peskine449bd832023-01-11 14:50:10 +01006905 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6906 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6907 return PSA_ERROR_BAD_STATE;
6908 }
Janos Follath81550542019-06-13 14:26:34 +01006909
Gilles Peskine449bd832023-01-11 14:50:10 +01006910 if (data_length != 0) {
6911 prf->secret = mbedtls_calloc(1, data_length);
6912 if (prf->secret == NULL) {
6913 return PSA_ERROR_INSUFFICIENT_MEMORY;
6914 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006915
Gilles Peskine449bd832023-01-11 14:50:10 +01006916 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006917 prf->secret_length = data_length;
6918 }
Janos Follath81550542019-06-13 14:26:34 +01006919
Gilles Peskine43f958b2020-12-13 14:55:14 +01006920 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006921
Gilles Peskine449bd832023-01-11 14:50:10 +01006922 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006923}
6924
Gilles Peskine449bd832023-01-11 14:50:10 +01006925static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6926 const uint8_t *data,
6927 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006928{
Gilles Peskine449bd832023-01-11 14:50:10 +01006929 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6930 return PSA_ERROR_BAD_STATE;
6931 }
Janos Follath63028dd2019-06-13 09:15:47 +01006932
Gilles Peskine449bd832023-01-11 14:50:10 +01006933 if (data_length != 0) {
6934 prf->label = mbedtls_calloc(1, data_length);
6935 if (prf->label == NULL) {
6936 return PSA_ERROR_INSUFFICIENT_MEMORY;
6937 }
Janos Follath63028dd2019-06-13 09:15:47 +01006938
Gilles Peskine449bd832023-01-11 14:50:10 +01006939 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006940 prf->label_length = data_length;
6941 }
Janos Follath63028dd2019-06-13 09:15:47 +01006942
Gilles Peskine43f958b2020-12-13 14:55:14 +01006943 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006944
Gilles Peskine449bd832023-01-11 14:50:10 +01006945 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006946}
6947
Gilles Peskine449bd832023-01-11 14:50:10 +01006948static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6949 psa_key_derivation_step_t step,
6950 const uint8_t *data,
6951 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006952{
Gilles Peskine449bd832023-01-11 14:50:10 +01006953 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006954 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006955 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006956 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006957 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006958 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006959 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006960 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006961 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006962 }
6963}
John Durkop07cc04a2020-11-16 22:08:34 -08006964#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6965 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6966
6967#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6968static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6969 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006970 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006971 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006972{
6973 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006974 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6975 4 + data_length + prf->other_secret_length :
6976 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006977
Gilles Peskine449bd832023-01-11 14:50:10 +01006978 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6979 return PSA_ERROR_INVALID_ARGUMENT;
6980 }
John Durkop07cc04a2020-11-16 22:08:34 -08006981
Gilles Peskine449bd832023-01-11 14:50:10 +01006982 uint8_t *pms = mbedtls_calloc(1, pms_len);
6983 if (pms == NULL) {
6984 return PSA_ERROR_INSUFFICIENT_MEMORY;
6985 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006986 uint8_t *cur = pms;
6987
6988 /* pure-PSK:
6989 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006990 *
6991 * The premaster secret is formed as follows: if the PSK is N octets
6992 * long, concatenate a uint16 with the value N, N zero octets, a second
6993 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006994 *
6995 * mixed-PSK:
6996 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6997 * follows: concatenate a uint16 with the length of the other secret,
6998 * the other secret itself, uint16 with the length of PSK, and the
6999 * PSK itself.
7000 * For details please check:
7001 * - RFC 4279, Section 4 for the definition of RSA-PSK,
7002 * - RFC 4279, Section 3 for the definition of DHE-PSK,
7003 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08007004 */
7005
Gilles Peskine449bd832023-01-11 14:50:10 +01007006 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
7007 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
7008 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
7009 if (prf->other_secret_length != 0) {
7010 memcpy(cur, prf->other_secret, prf->other_secret_length);
7011 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02007012 cur += prf->other_secret_length;
7013 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007014 } else {
7015 *cur++ = MBEDTLS_BYTE_1(data_length);
7016 *cur++ = MBEDTLS_BYTE_0(data_length);
7017 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02007018 cur += data_length;
7019 }
7020
Gilles Peskine449bd832023-01-11 14:50:10 +01007021 *cur++ = MBEDTLS_BYTE_1(data_length);
7022 *cur++ = MBEDTLS_BYTE_0(data_length);
7023 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08007024 cur += data_length;
7025
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007026 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08007027
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01007028 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01007029 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08007030}
Janos Follath6660f0e2019-06-17 08:44:03 +01007031
Przemek Stekiele47201b2022-04-19 13:53:28 +02007032static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
7033 psa_tls12_prf_key_derivation_t *prf,
7034 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007035 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02007036{
Gilles Peskine449bd832023-01-11 14:50:10 +01007037 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
7038 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02007039 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007040
7041 if (data_length != 0) {
7042 prf->other_secret = mbedtls_calloc(1, data_length);
7043 if (prf->other_secret == NULL) {
7044 return PSA_ERROR_INSUFFICIENT_MEMORY;
7045 }
7046
7047 memcpy(prf->other_secret, data, data_length);
7048 prf->other_secret_length = data_length;
7049 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02007050 prf->other_secret_length = 0;
7051 }
7052
7053 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
7054
Gilles Peskine449bd832023-01-11 14:50:10 +01007055 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02007056}
7057
Janos Follath6660f0e2019-06-17 08:44:03 +01007058static psa_status_t psa_tls12_prf_psk_to_ms_input(
7059 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01007060 psa_key_derivation_step_t step,
7061 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007062 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01007063{
Gilles Peskine449bd832023-01-11 14:50:10 +01007064 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02007065 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007066 return psa_tls12_prf_psk_to_ms_set_key(prf,
7067 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02007068 break;
7069 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007070 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
7071 data,
7072 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02007073 break;
7074 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007075 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02007076 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01007077
Przemek Stekiele47201b2022-04-19 13:53:28 +02007078 }
Janos Follath6660f0e2019-06-17 08:44:03 +01007079}
John Durkop07cc04a2020-11-16 22:08:34 -08007080#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007081
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007082#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
7083static psa_status_t psa_tls12_ecjpake_to_pms_input(
7084 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04007085 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007086 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007087 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007088{
Gilles Peskine449bd832023-01-11 14:50:10 +01007089 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
7090 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
7091 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04007092 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007093
7094 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01007095 if (data[0] != 0x04) {
7096 return PSA_ERROR_INVALID_ARGUMENT;
7097 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007098
7099 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007100 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007101
Gilles Peskine449bd832023-01-11 14:50:10 +01007102 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007103}
7104#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307105
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307106#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307107static psa_status_t psa_pbkdf2_set_input_cost(
7108 psa_pbkdf2_key_derivation_t *pbkdf2,
7109 psa_key_derivation_step_t step,
7110 uint64_t data)
7111{
7112 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
7113 return PSA_ERROR_INVALID_ARGUMENT;
7114 }
7115
7116 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
7117 return PSA_ERROR_BAD_STATE;
7118 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307119
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05307120 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307121 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307122 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307123
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307124 if (data == 0) {
7125 return PSA_ERROR_INVALID_ARGUMENT;
7126 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05307127
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307128 pbkdf2->input_cost = data;
7129 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
7130
7131 return PSA_SUCCESS;
7132}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307133
7134static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
7135 const uint8_t *data,
7136 size_t data_length)
7137{
Gilles Peskineead17662023-08-20 22:02:51 +02007138 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
7139 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
7140 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
7141 /* Appending to existing salt. No state change. */
7142 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307143 return PSA_ERROR_BAD_STATE;
7144 }
7145
Gilles Peskineca57d782023-07-20 19:08:06 +02007146 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02007147 /* Appending an empty string, nothing to do. */
7148 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307149 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05307150
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307151 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
7152 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05307153 return PSA_ERROR_INSUFFICIENT_MEMORY;
7154 }
7155
Gilles Peskineead17662023-08-20 22:02:51 +02007156 if (pbkdf2->salt_length != 0) {
7157 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
7158 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307159 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05307160 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307161 mbedtls_free(pbkdf2->salt);
7162 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307163 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307164 return PSA_SUCCESS;
7165}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307166
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307167#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307168static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307169 const uint8_t *input,
7170 size_t input_len,
7171 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05307172 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307173{
7174 psa_status_t status = PSA_SUCCESS;
7175 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
Ryan Everett5d2e82f2024-02-07 17:24:59 +00007176 return psa_hash_compute(hash_alg, input, input_len, output,
7177 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
7178 } else if (input_len > 0) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307179 memcpy(output, input, input_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307180 }
Ryan Everett5d2e82f2024-02-07 17:24:59 +00007181 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307182 return status;
7183}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307184#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307185
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307186#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307187static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
7188 size_t input_len,
7189 uint8_t *output,
7190 size_t *output_len)
7191{
7192 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307193 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307194 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05307195 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307196 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
7197 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
7198 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307199 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05307200 * mac_size as the driver function sets mac_output_length = mac_size
7201 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307202 status = psa_driver_wrapper_mac_compute(&attributes,
7203 zeros, sizeof(zeros),
7204 PSA_ALG_CMAC, input, input_len,
7205 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307206 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
7207 128U,
7208 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307209 output_len);
7210 } else {
7211 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307212 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307213 }
7214 return status;
7215}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307216#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307217
7218static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307219 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307220 const uint8_t *data,
7221 size_t data_length)
7222{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307223 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307224 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
7225 return PSA_ERROR_BAD_STATE;
7226 }
7227
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307228#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307229 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
7230 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
7231 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
7232 pbkdf2->password,
7233 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307234 } else
7235#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
7236#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
7237 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307238 status = psa_pbkdf2_cmac_set_password(data, data_length,
7239 pbkdf2->password,
7240 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307241 } else
7242#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
7243 {
7244 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307245 }
7246
7247 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
7248
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307249 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307250}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307251
7252static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307253 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307254 psa_key_derivation_step_t step,
7255 const uint8_t *data,
7256 size_t data_length)
7257{
7258 switch (step) {
7259 case PSA_KEY_DERIVATION_INPUT_SALT:
7260 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
7261 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307262 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307263 default:
7264 return PSA_ERROR_INVALID_ARGUMENT;
7265 }
7266}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307267#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307268
Gilles Peskineb8965192019-09-24 16:21:10 +02007269/** Check whether the given key type is acceptable for the given
7270 * input step of a key derivation.
7271 *
7272 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
7273 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
7274 * Both secret and non-secret inputs can alternatively have the type
7275 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
7276 * that the input was passed as a buffer rather than via a key object.
7277 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02007278static int psa_key_derivation_check_input_type(
7279 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007280 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02007281{
Gilles Peskine449bd832023-01-11 14:50:10 +01007282 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007283 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007284 if (key_type == PSA_KEY_TYPE_DERIVE) {
7285 return PSA_SUCCESS;
7286 }
7287 if (key_type == PSA_KEY_TYPE_NONE) {
7288 return PSA_SUCCESS;
7289 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007290 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02007291 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007292 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 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02007298 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007299 case PSA_KEY_DERIVATION_INPUT_LABEL:
7300 case PSA_KEY_DERIVATION_INPUT_SALT:
7301 case PSA_KEY_DERIVATION_INPUT_INFO:
7302 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01007303 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
7304 return PSA_SUCCESS;
7305 }
7306 if (key_type == PSA_KEY_TYPE_NONE) {
7307 return PSA_SUCCESS;
7308 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007309 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307310 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
7311 if (key_type == PSA_KEY_TYPE_PASSWORD) {
7312 return PSA_SUCCESS;
7313 }
7314 if (key_type == PSA_KEY_TYPE_DERIVE) {
7315 return PSA_SUCCESS;
7316 }
7317 if (key_type == PSA_KEY_TYPE_NONE) {
7318 return PSA_SUCCESS;
7319 }
7320 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007321 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007322 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007323}
7324
Janos Follathb80a94e2019-06-12 15:54:46 +01007325static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007326 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007327 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007328 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007329 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007330 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007331{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007332 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007333 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007334
Gilles Peskine449bd832023-01-11 14:50:10 +01007335 status = psa_key_derivation_check_input_type(step, key_type);
7336 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007337 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007338 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007339
Przemek Stekiel69c46792022-06-10 12:59:51 +02007340#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007341 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7342 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7343 step, data, data_length);
7344 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007345#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007346#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007347 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7348 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7349 step, data, data_length);
7350 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007351#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7352#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007353 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7354 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7355 step, data, data_length);
7356 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007357#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007358#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007359 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007360 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007361 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7362 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007363#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307364#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307365 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307366 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7367 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307368 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307369#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007370 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007371 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007372 (void) data;
7373 (void) data_length;
7374 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007375 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007376 }
7377
Gilles Peskine224b0d62019-09-23 18:13:17 +02007378exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007379 if (status != PSA_SUCCESS) {
7380 psa_key_derivation_abort(operation);
7381 }
7382 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007383}
7384
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307385static psa_status_t psa_key_derivation_input_integer_internal(
7386 psa_key_derivation_operation_t *operation,
7387 psa_key_derivation_step_t step,
7388 uint64_t value)
7389{
7390 psa_status_t status;
7391 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7392
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307393#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307394 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307395 status = psa_pbkdf2_set_input_cost(
7396 &operation->ctx.pbkdf2, step, value);
7397 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307398#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307399 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307400 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307401 (void) value;
7402 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307403 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307404 }
7405
7406 if (status != PSA_SUCCESS) {
7407 psa_key_derivation_abort(operation);
7408 }
7409 return status;
7410}
7411
Janos Follath51f4a0f2019-06-14 11:35:55 +01007412psa_status_t psa_key_derivation_input_bytes(
7413 psa_key_derivation_operation_t *operation,
7414 psa_key_derivation_step_t step,
Ryan Everettd1e398c2024-01-19 14:46:00 +00007415 const uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007416 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007417{
Ryan Everettd1e398c2024-01-19 14:46:00 +00007418 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7419 LOCAL_INPUT_DECLARE(data_external, data);
7420
7421 LOCAL_INPUT_ALLOC(data_external, data_length, data);
7422
7423 status = psa_key_derivation_input_internal(operation, step,
7424 PSA_KEY_TYPE_NONE,
7425 data, data_length);
David Horstmann4a48bec2024-03-13 15:42:31 +00007426#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Ryan Everettd1e398c2024-01-19 14:46:00 +00007427exit:
Ryan Everettb41c3c92024-01-25 11:56:35 +00007428#endif
Ryan Everettd1e398c2024-01-19 14:46:00 +00007429 LOCAL_INPUT_FREE(data_external, data);
7430 return status;
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007431}
7432
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307433psa_status_t psa_key_derivation_input_integer(
7434 psa_key_derivation_operation_t *operation,
7435 psa_key_derivation_step_t step,
7436 uint64_t value)
7437{
7438 return psa_key_derivation_input_integer_internal(operation, step, value);
7439}
7440
Janos Follath51f4a0f2019-06-14 11:35:55 +01007441psa_status_t psa_key_derivation_input_key(
7442 psa_key_derivation_operation_t *operation,
7443 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007445{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007446 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007447 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007448 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007449
Ronald Cron5c522922020-11-14 16:35:34 +01007450 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007451 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7452 if (status != PSA_SUCCESS) {
7453 psa_key_derivation_abort(operation);
7454 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007455 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007456
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307457 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7458 * permission to output to a key object. */
7459 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7460 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007461 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007462 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007463
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 status = psa_key_derivation_input_internal(operation,
7465 step, slot->attr.type,
7466 slot->key.data,
7467 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007468
Ryan Everett5ac6fa72024-02-14 17:11:36 +00007469 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007470
Gilles Peskine449bd832023-01-11 14:50:10 +01007471 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007472}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007473
7474
7475
7476/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007477/* Key agreement */
7478/****************************************************************/
7479
Gilles Peskine449bd832023-01-11 14:50:10 +01007480psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7481 const uint8_t *key_buffer,
7482 size_t key_buffer_size,
7483 psa_algorithm_t alg,
7484 const uint8_t *peer_key,
7485 size_t peer_key_length,
7486 uint8_t *shared_secret,
7487 size_t shared_secret_size,
7488 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007489{
Gilles Peskine449bd832023-01-11 14:50:10 +01007490 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007491#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007492 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007493 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7494 key_buffer_size, alg,
7495 peer_key, peer_key_length,
7496 shared_secret,
7497 shared_secret_size,
7498 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007499#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007500
7501#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7502 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007503 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007504 peer_key,
7505 peer_key_length,
7506 key_buffer,
7507 key_buffer_size,
7508 shared_secret,
7509 shared_secret_size,
7510 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007511#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7512
Gilles Peskine01d718c2018-09-18 12:01:02 +02007513 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007514 (void) attributes;
7515 (void) key_buffer;
7516 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007517 (void) peer_key;
7518 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007519 (void) shared_secret;
7520 (void) shared_secret_size;
7521 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007522 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007523 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007524}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007525
Aditya Deshpande17845b82022-10-13 17:21:01 +01007526/** Internal function for raw key agreement
7527 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007528 * to the driver's implementation if a driver is present.
7529 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007530 * (psa_key_agreement_raw_builtin).
7531 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007532static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7533 psa_key_slot_t *private_key,
7534 const uint8_t *peer_key,
7535 size_t peer_key_length,
7536 uint8_t *shared_secret,
7537 size_t shared_secret_size,
7538 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007539{
Gilles Peskine449bd832023-01-11 14:50:10 +01007540 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7541 return PSA_ERROR_NOT_SUPPORTED;
7542 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007543
Gilles Peskine7a5d9202024-02-28 01:18:23 +01007544 return psa_driver_wrapper_key_agreement(&private_key->attr,
Gilles Peskine449bd832023-01-11 14:50:10 +01007545 private_key->key.data,
7546 private_key->key.bytes, alg,
7547 peer_key, peer_key_length,
7548 shared_secret,
7549 shared_secret_size,
7550 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007551}
7552
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007553/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007554 * to potentially free embedded data structures and wipe confidential data.
7555 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007556static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7557 psa_key_derivation_step_t step,
7558 psa_key_slot_t *private_key,
7559 const uint8_t *peer_key,
7560 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007561{
7562 psa_status_t status;
Moritz Fischer967f8cd2024-03-02 00:55:06 +00007563 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE] = { 0 };
Gilles Peskine01d718c2018-09-18 12:01:02 +02007564 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007565 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007566
7567 /* Step 1: run the secret agreement algorithm to generate the shared
7568 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007569 status = psa_key_agreement_raw_internal(ka_alg,
7570 private_key,
7571 peer_key, peer_key_length,
7572 shared_secret,
7573 sizeof(shared_secret),
7574 &shared_secret_length);
7575 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007576 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007577 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007578
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007579 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007580 * the shared secret. A shared secret is permitted wherever a key
7581 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007582 status = psa_key_derivation_input_internal(operation, step,
7583 PSA_KEY_TYPE_DERIVE,
7584 shared_secret,
7585 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007586exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007587 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7588 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007589}
7590
Gilles Peskine449bd832023-01-11 14:50:10 +01007591psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7592 psa_key_derivation_step_t step,
7593 mbedtls_svc_key_id_t private_key,
Thomas Daubney9739ac02024-02-15 13:15:47 +00007594 const uint8_t *peer_key_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007595 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007596{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007597 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007598 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007599 psa_key_slot_t *slot;
Thomas Daubney9739ac02024-02-15 13:15:47 +00007600 LOCAL_INPUT_DECLARE(peer_key_external, peer_key);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007601
Gilles Peskine449bd832023-01-11 14:50:10 +01007602 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7603 return PSA_ERROR_INVALID_ARGUMENT;
7604 }
Ronald Cron5c522922020-11-14 16:35:34 +01007605 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007606 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7607 if (status != PSA_SUCCESS) {
7608 return status;
7609 }
Thomas Daubney9739ac02024-02-15 13:15:47 +00007610
Thomas Daubney692fb3c2024-03-12 16:20:41 +00007611 LOCAL_INPUT_ALLOC(peer_key_external, peer_key_length, peer_key);
Gilles Peskine449bd832023-01-11 14:50:10 +01007612 status = psa_key_agreement_internal(operation, step,
7613 slot,
7614 peer_key, peer_key_length);
Thomas Daubney9739ac02024-02-15 13:15:47 +00007615
David Horstmann4a48bec2024-03-13 15:42:31 +00007616#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
Thomas Daubney9739ac02024-02-15 13:15:47 +00007617exit:
Thomas Daubney50f58fc2024-02-15 14:24:03 +00007618#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007619 if (status != PSA_SUCCESS) {
7620 psa_key_derivation_abort(operation);
7621 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007622 /* If a private key has been added as SECRET, we allow the derived
7623 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007624 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007625 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007626 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007627 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007628
Ryan Everett5ac6fa72024-02-14 17:11:36 +00007629 unlock_status = psa_unregister_read_under_mutex(slot);
Thomas Daubney9739ac02024-02-15 13:15:47 +00007630 LOCAL_INPUT_FREE(peer_key_external, peer_key);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007631
Gilles Peskine449bd832023-01-11 14:50:10 +01007632 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007633}
7634
Gilles Peskine449bd832023-01-11 14:50:10 +01007635psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7636 mbedtls_svc_key_id_t private_key,
Thomas Daubney81899ab2024-02-15 12:57:26 +00007637 const uint8_t *peer_key_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007638 size_t peer_key_length,
Thomas Daubney81899ab2024-02-15 12:57:26 +00007639 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007640 size_t output_size,
7641 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007642{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007643 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007644 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007645 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007646 size_t expected_length;
Thomas Daubney81899ab2024-02-15 12:57:26 +00007647 LOCAL_INPUT_DECLARE(peer_key_external, peer_key);
7648 LOCAL_OUTPUT_DECLARE(output_external, output);
Thomas Daubney89d8c2a2024-02-21 11:16:16 +00007649 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007650
Gilles Peskine449bd832023-01-11 14:50:10 +01007651 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007652 status = PSA_ERROR_INVALID_ARGUMENT;
7653 goto exit;
7654 }
Ronald Cron5c522922020-11-14 16:35:34 +01007655 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007656 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7657 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007658 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007659 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007660
Gilles Peskine3e561302022-04-14 00:17:15 +02007661 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7662 * for the output size. The PSA specification only guarantees that this
7663 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7664 * but it might be nice to allow smaller buffers if the output fits.
7665 * At the time of writing this comment, with only ECDH implemented,
7666 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7667 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7668 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007669 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007670 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7671 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007672 status = PSA_ERROR_BUFFER_TOO_SMALL;
7673 goto exit;
7674 }
7675
Thomas Daubney81899ab2024-02-15 12:57:26 +00007676 LOCAL_INPUT_ALLOC(peer_key_external, peer_key_length, peer_key);
Gilles Peskine449bd832023-01-11 14:50:10 +01007677 status = psa_key_agreement_raw_internal(alg, slot,
7678 peer_key, peer_key_length,
7679 output, output_size,
7680 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007681
7682exit:
Thomas Daubney5390aca2024-02-22 11:06:04 +00007683 /* Check for successful allocation of output,
7684 * with an unsuccessful status. */
Thomas Daubney0576a6a2024-02-21 15:15:00 +00007685 if (output != NULL && status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007686 /* If an error happens and is not handled properly, the output
7687 * may be used as a key to protect sensitive data. Arrange for such
7688 * a key to be random, which is likely to result in decryption or
7689 * verification errors. This is better than filling the buffer with
7690 * some constant data such as zeros, which would result in the data
7691 * being protected with a reproducible, easily knowable key.
7692 */
David Horstmann6e99bb22024-02-06 15:27:49 +00007693 psa_generate_random_internal(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007694 *output_length = output_size;
7695 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007696
Thomas Daubney5390aca2024-02-22 11:06:04 +00007697 if (output == NULL) {
Thomas Daubney89d8c2a2024-02-21 11:16:16 +00007698 /* output allocation failed. */
7699 *output_length = 0;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007700 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007701
Ryan Everetta103ec92024-01-31 13:59:57 +00007702 unlock_status = psa_unregister_read_under_mutex(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007703
Thomas Daubney81899ab2024-02-15 12:57:26 +00007704 LOCAL_INPUT_FREE(peer_key_external, peer_key);
7705 LOCAL_OUTPUT_FREE(output_external, output);
Gilles Peskine449bd832023-01-11 14:50:10 +01007706 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007707}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007708
7709
7710/****************************************************************/
7711/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007712/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007713
Gilles Peskine672a7712023-04-28 21:00:28 +02007714#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7715#include "entropy_poll.h"
7716#endif
7717
Gilles Peskine30524eb2020-11-13 17:02:26 +01007718/** Initialize the PSA random generator.
Paul Elliottd35dce62024-03-15 13:57:16 +00007719 *
7720 * Note: the mbedtls_threading_psa_rngdata_mutex should be held when calling
7721 * this function if mutexes are enabled.
Gilles Peskine30524eb2020-11-13 17:02:26 +01007722 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007723static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007724{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007725#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007726 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007727#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7728
Gilles Peskine30524eb2020-11-13 17:02:26 +01007729 /* Set default configuration if
7730 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007731 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007732 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007733 }
7734 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007735 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007736 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007737
Gilles Peskine449bd832023-01-11 14:50:10 +01007738 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007739#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7740 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7741 /* The PSA entropy injection feature depends on using NV seed as an entropy
7742 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007743 mbedtls_entropy_add_source(&rng->entropy,
7744 mbedtls_nv_seed_poll, NULL,
7745 MBEDTLS_ENTROPY_BLOCK_SIZE,
7746 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007747#endif
7748
Valerio Setti061d4e42024-02-26 12:52:44 +01007749 mbedtls_psa_drbg_init(&rng->drbg);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007750#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007751}
7752
7753/** Deinitialize the PSA random generator.
Paul Elliottd35dce62024-03-15 13:57:16 +00007754 *
7755 * Note: the mbedtls_threading_psa_rngdata_mutex should be held when calling
7756 * this function if mutexes are enabled.
Gilles Peskine30524eb2020-11-13 17:02:26 +01007757 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007758static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007759{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007760#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007761 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007762#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti061d4e42024-02-26 12:52:44 +01007763 mbedtls_psa_drbg_free(&rng->drbg);
Gilles Peskine449bd832023-01-11 14:50:10 +01007764 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007765#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007766}
7767
7768/** Seed the PSA random generator.
7769 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007770static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007771{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007772#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7773 /* Do nothing: the external RNG seeds itself. */
7774 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007775 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007776#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007777 const unsigned char drbg_seed[] = "PSA";
Valerio Setti061d4e42024-02-26 12:52:44 +01007778 int ret = mbedtls_psa_drbg_seed(&rng->drbg, &rng->entropy,
Gilles Peskine449bd832023-01-11 14:50:10 +01007779 drbg_seed, sizeof(drbg_seed) - 1);
7780 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007781#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007782}
7783
David Horstmann6e99bb22024-02-06 15:27:49 +00007784psa_status_t psa_generate_random(uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007785 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007786{
David Horstmann6e99bb22024-02-06 15:27:49 +00007787 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007788
David Horstmann6e99bb22024-02-06 15:27:49 +00007789 LOCAL_OUTPUT_DECLARE(output_external, output);
7790 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007791
David Horstmann6e99bb22024-02-06 15:27:49 +00007792 status = psa_generate_random_internal(output, output_size);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007793
David Horstmann4a48bec2024-03-13 15:42:31 +00007794#if !defined(MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS)
David Horstmann6e99bb22024-02-06 15:27:49 +00007795exit:
David Horstmanne097bbd2024-02-28 14:17:10 +00007796#endif
David Horstmann6e99bb22024-02-06 15:27:49 +00007797 LOCAL_OUTPUT_FREE(output_external, output);
7798 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007799}
7800
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007801#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007802psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7803 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007804{
Paul Elliott600472b2024-02-23 17:26:58 +00007805 if (psa_get_initialized()) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007806 return PSA_ERROR_NOT_PERMITTED;
7807 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007808
Gilles Peskine449bd832023-01-11 14:50:10 +01007809 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7810 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7811 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7812 return PSA_ERROR_INVALID_ARGUMENT;
7813 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007814
Gilles Peskine449bd832023-01-11 14:50:10 +01007815 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007816}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007817#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007818
Ronald Cron3772afe2021-02-08 16:10:05 +01007819/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007820 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007821 * \param type The key type
7822 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007823 *
7824 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007825 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007826 * \retval #PSA_ERROR_INVALID_ARGUMENT
7827 * The size in bits of the key is not valid.
7828 * \retval #PSA_ERROR_NOT_SUPPORTED
7829 * The type and/or the size in bits of the key or the combination of
7830 * the two is not supported.
7831 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007832static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007833 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007834{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007835 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007836
Gilles Peskine449bd832023-01-11 14:50:10 +01007837 if (key_type_is_raw_bytes(type)) {
7838 status = psa_validate_unstructured_key_bit_size(type, bits);
7839 if (status != PSA_SUCCESS) {
7840 return status;
7841 }
7842 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007843#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007844 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7845 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7846 return PSA_ERROR_NOT_SUPPORTED;
7847 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007848 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007849 return PSA_ERROR_NOT_SUPPORTED;
7850 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007851
Ronald Cron01b2aba2020-10-05 09:42:02 +02007852 /* Accept only byte-aligned keys, for the same reasons as
7853 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007854 if (bits % 8 != 0) {
7855 return PSA_ERROR_NOT_SUPPORTED;
7856 }
7857 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007858#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007859
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007860#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007861 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007862 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007863 return PSA_SUCCESS;
7864 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007865#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007866
Valerio Settia55f0422023-07-10 15:34:41 +02007867#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007868 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007869 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007870 return PSA_ERROR_NOT_SUPPORTED;
7871 }
7872 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007873#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007874 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007875 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007876 }
7877
Gilles Peskine449bd832023-01-11 14:50:10 +01007878 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007879}
7880
Ronald Cron55ed0592020-10-05 10:30:40 +02007881psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007882 const psa_key_attributes_t *attributes,
Gilles Peskinef36d7852024-06-06 21:11:44 +02007883 const psa_custom_key_parameters_t *custom,
7884 const uint8_t *custom_data,
7885 size_t custom_data_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01007886 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007887{
7888 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f107ae2024-02-28 01:26:46 +01007889 psa_key_type_t type = attributes->type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007890
Gilles Peskine7a18f962024-02-12 16:48:11 +01007891 /* Only used for RSA */
Gilles Peskinef36d7852024-06-06 21:11:44 +02007892 (void) custom;
7893 (void) custom_data;
7894 (void) custom_data_length;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007895
Gilles Peskine449bd832023-01-11 14:50:10 +01007896 if (key_type_is_raw_bytes(type)) {
David Horstmann93fa4e12024-03-12 15:02:28 +00007897 status = psa_generate_random_internal(key_buffer, key_buffer_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01007898 if (status != PSA_SUCCESS) {
7899 return status;
7900 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007901
David Brown12ca5032021-02-11 11:02:00 -07007902#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007903 if (type == PSA_KEY_TYPE_DES) {
7904 psa_des_set_key_parity(key_buffer, key_buffer_size);
7905 }
David Brown8107e312021-02-12 08:08:46 -07007906#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007907 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007908
Valerio Setti76df8c12023-07-11 14:11:28 +02007909#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007910 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7911 return mbedtls_psa_rsa_generate_key(attributes,
Gilles Peskinef36d7852024-06-06 21:11:44 +02007912 custom_data, custom_data_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01007913 key_buffer,
7914 key_buffer_size,
7915 key_buffer_length);
7916 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007917#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007918
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007919#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007920 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7921 return mbedtls_psa_ecp_generate_key(attributes,
7922 key_buffer,
7923 key_buffer_size,
7924 key_buffer_length);
7925 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007926#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007927
Valerio Settia55f0422023-07-10 15:34:41 +02007928#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007929 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7930 return mbedtls_psa_ffdh_generate_key(attributes,
7931 key_buffer,
7932 key_buffer_size,
7933 key_buffer_length);
7934 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007935#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007936 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007937 (void) key_buffer_length;
7938 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007939 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007940
Gilles Peskine449bd832023-01-11 14:50:10 +01007941 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007942}
Darryl Green0c6575a2018-11-07 16:05:30 +00007943
Gilles Peskinef36d7852024-06-06 21:11:44 +02007944psa_status_t psa_generate_key_custom(const psa_key_attributes_t *attributes,
7945 const psa_custom_key_parameters_t *custom,
7946 const uint8_t *custom_data,
7947 size_t custom_data_length,
7948 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007949{
7950 psa_status_t status;
7951 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007952 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007953 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007954
Ronald Cron81709fc2020-11-14 12:10:32 +01007955 *key = MBEDTLS_SVC_KEY_ID_INIT;
7956
Gilles Peskine0f84d622019-09-12 19:03:13 +02007957 /* Reject any attempt to create a zero-length key so that we don't
7958 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007959 if (psa_get_key_bits(attributes) == 0) {
7960 return PSA_ERROR_INVALID_ARGUMENT;
7961 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007962
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007963 /* Reject any attempt to create a public key. */
Gilles Peskine2f107ae2024-02-28 01:26:46 +01007964 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01007965 return PSA_ERROR_INVALID_ARGUMENT;
7966 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007967
Gilles Peskine7a18f962024-02-12 16:48:11 +01007968#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine2f107ae2024-02-28 01:26:46 +01007969 if (attributes->type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
Gilles Peskinef36d7852024-06-06 21:11:44 +02007970 if (custom->flags != 0) {
Gilles Peskine7a18f962024-02-12 16:48:11 +01007971 return PSA_ERROR_INVALID_ARGUMENT;
7972 }
7973 } else
7974#endif
Gilles Peskine52504f82024-06-20 17:19:58 +02007975 if (!psa_custom_key_parameters_are_default(custom, custom_data_length)) {
Ronald Cron81709fc2020-11-14 12:10:32 +01007976 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine11792082019-08-06 18:36:36 +02007977 }
7978
Gilles Peskine449bd832023-01-11 14:50:10 +01007979 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7980 &slot, &driver);
7981 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007982 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007983 }
Gilles Peskine11792082019-08-06 18:36:36 +02007984
Ronald Cron977c2472020-10-13 08:32:21 +02007985 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307986 * storage ( thus not in the case of generating a key in a secure element
7987 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7988 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007989 if (slot->key.data == NULL) {
Gilles Peskine2f107ae2024-02-28 01:26:46 +01007990 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->lifetime) ==
Gilles Peskine449bd832023-01-11 14:50:10 +01007991 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007992 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine2f107ae2024-02-28 01:26:46 +01007993 attributes->type, attributes->bits);
Gilles Peskine449bd832023-01-11 14:50:10 +01007994 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007995 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007996 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007997
7998 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine2f107ae2024-02-28 01:26:46 +01007999 attributes->type,
8000 attributes->bits);
Gilles Peskine449bd832023-01-11 14:50:10 +01008001 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02008002 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01008003 attributes, &key_buffer_size);
8004 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01008005 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008006 }
Ronald Cron977c2472020-10-13 08:32:21 +02008007 }
Ronald Cron977c2472020-10-13 08:32:21 +02008008
Gilles Peskine449bd832023-01-11 14:50:10 +01008009 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
8010 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02008011 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008012 }
Ronald Cron977c2472020-10-13 08:32:21 +02008013 }
8014
Gilles Peskine449bd832023-01-11 14:50:10 +01008015 status = psa_driver_wrapper_generate_key(attributes,
Gilles Peskinef36d7852024-06-06 21:11:44 +02008016 custom,
8017 custom_data, custom_data_length,
Gilles Peskine7a18f962024-02-12 16:48:11 +01008018 slot->key.data, slot->key.bytes,
8019 &slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01008020 if (status != PSA_SUCCESS) {
8021 psa_remove_key_data_from_memory(slot);
8022 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02008023
Gilles Peskine11792082019-08-06 18:36:36 +02008024exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008025 if (status == PSA_SUCCESS) {
8026 status = psa_finish_key_creation(slot, driver, key);
8027 }
8028 if (status != PSA_SUCCESS) {
8029 psa_fail_key_creation(slot, driver);
8030 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02008031
Gilles Peskine449bd832023-01-11 14:50:10 +01008032 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008033}
8034
Gilles Peskinef36d7852024-06-06 21:11:44 +02008035psa_status_t psa_generate_key_ext(const psa_key_attributes_t *attributes,
8036 const psa_key_production_parameters_t *params,
8037 size_t params_data_length,
8038 mbedtls_svc_key_id_t *key)
8039{
8040 return psa_generate_key_custom(
8041 attributes,
8042 (const psa_custom_key_parameters_t *) params,
8043 params->data, params_data_length,
8044 key);
8045}
8046
Gilles Peskinef0765fa2024-02-12 16:46:16 +01008047psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
8048 mbedtls_svc_key_id_t *key)
8049{
Gilles Peskinef36d7852024-06-06 21:11:44 +02008050 return psa_generate_key_custom(attributes,
8051 &default_custom_production,
8052 NULL, 0,
8053 key);
Gilles Peskinef0765fa2024-02-12 16:46:16 +01008054}
8055
Gilles Peskinee59236f2018-01-27 23:32:46 +01008056/****************************************************************/
8057/* Module setup */
8058/****************************************************************/
8059
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01008060#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01008061psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01008062 void (* entropy_init)(mbedtls_entropy_context *ctx),
8063 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01008064{
Paul Elliott8e151532024-02-23 17:35:29 +00008065 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
8066
8067#if defined(MBEDTLS_THREADING_C)
8068 mbedtls_mutex_lock(&mbedtls_threading_psa_rngdata_mutex);
8069#endif /* defined(MBEDTLS_THREADING_C) */
8070
Gilles Peskine449bd832023-01-11 14:50:10 +01008071 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
Paul Elliott8e151532024-02-23 17:35:29 +00008072 status = PSA_ERROR_BAD_STATE;
8073 } else {
8074 global_data.rng.entropy_init = entropy_init;
8075 global_data.rng.entropy_free = entropy_free;
8076 status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01008077 }
Paul Elliott8e151532024-02-23 17:35:29 +00008078
8079#if defined(MBEDTLS_THREADING_C)
8080 mbedtls_mutex_unlock(&mbedtls_threading_psa_rngdata_mutex);
8081#endif /* defined(MBEDTLS_THREADING_C) */
8082
8083 return status;
Gilles Peskine5e769522018-11-20 21:59:56 +01008084}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01008085#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01008086
Gilles Peskine449bd832023-01-11 14:50:10 +01008087void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01008088{
Paul Elliott47cee8e2024-03-08 21:38:02 +00008089
Paul Elliott600472b2024-02-23 17:26:58 +00008090#if defined(MBEDTLS_THREADING_C)
8091 mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex);
8092#endif /* defined(MBEDTLS_THREADING_C) */
8093
Paul Elliott47cee8e2024-03-08 21:38:02 +00008094 /* Nothing to do to free transaction. */
8095 if (global_data.initialized & PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED) {
8096 global_data.initialized &= ~PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED;
Valerio Setti83e0de82023-11-24 12:13:05 +01008097 }
Paul Elliott600472b2024-02-23 17:26:58 +00008098
Paul Elliott47cee8e2024-03-08 21:38:02 +00008099 if (global_data.initialized & PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS_INITIALIZED) {
8100 psa_wipe_all_key_slots();
8101 global_data.initialized &= ~PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS_INITIALIZED;
8102 }
Ronald Cron9ba76912021-04-10 16:57:30 +02008103
Paul Elliott600472b2024-02-23 17:26:58 +00008104#if defined(MBEDTLS_THREADING_C)
8105 mbedtls_mutex_unlock(&mbedtls_threading_psa_globaldata_mutex);
8106#endif /* defined(MBEDTLS_THREADING_C) */
8107
Paul Elliott47cee8e2024-03-08 21:38:02 +00008108#if defined(MBEDTLS_THREADING_C)
8109 mbedtls_mutex_lock(&mbedtls_threading_psa_rngdata_mutex);
8110#endif /* defined(MBEDTLS_THREADING_C) */
8111
Gilles Peskinec6b69072018-11-20 21:42:52 +01008112 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01008113 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01008114 }
Paul Elliott47cee8e2024-03-08 21:38:02 +00008115 global_data.rng_state = RNG_NOT_INITIALIZED;
8116 mbedtls_platform_zeroize(&global_data.rng, sizeof(global_data.rng));
8117
8118#if defined(MBEDTLS_THREADING_C)
8119 mbedtls_mutex_unlock(&mbedtls_threading_psa_rngdata_mutex);
8120#endif /* defined(MBEDTLS_THREADING_C) */
8121
8122#if defined(MBEDTLS_THREADING_C)
8123 mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex);
8124#endif /* defined(MBEDTLS_THREADING_C) */
Ronald Cron9ba76912021-04-10 16:57:30 +02008125
8126 /* Terminate drivers */
Paul Elliott47cee8e2024-03-08 21:38:02 +00008127 if (global_data.initialized & PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS_INITIALIZED) {
8128 psa_driver_wrapper_free();
8129 global_data.initialized &= ~PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS_INITIALIZED;
8130 }
8131
8132#if defined(MBEDTLS_THREADING_C)
8133 mbedtls_mutex_unlock(&mbedtls_threading_psa_globaldata_mutex);
8134#endif /* defined(MBEDTLS_THREADING_C) */
8135
Gilles Peskinee59236f2018-01-27 23:32:46 +01008136}
8137
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008138#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
8139/** Recover a transaction that was interrupted by a power failure.
8140 *
8141 * This function is called during initialization, before psa_crypto_init()
8142 * returns. If this function returns a failure status, the initialization
8143 * fails.
8144 */
8145static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01008146 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008147{
Gilles Peskine449bd832023-01-11 14:50:10 +01008148 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008149 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
8150 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008151 /* TODO - fall through to the failure case until this
8152 * is implemented.
8153 * https://github.com/ARMmbed/mbed-crypto/issues/218
8154 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008155 default:
8156 /* We found an unsupported transaction in the storage.
8157 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008158 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008159 }
8160}
8161#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
8162
Paul Elliott47cee8e2024-03-08 21:38:02 +00008163static psa_status_t mbedtls_psa_crypto_init_subsystem(mbedtls_psa_crypto_subsystem subsystem)
8164{
8165 psa_status_t status = PSA_SUCCESS;
8166 uint8_t driver_wrappers_initialized = 0;
8167
8168 switch (subsystem) {
8169 case PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS:
8170
8171#if defined(MBEDTLS_THREADING_C)
8172 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex));
8173#endif /* defined(MBEDTLS_THREADING_C) */
8174
8175 if (!(global_data.initialized & PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS_INITIALIZED)) {
8176 /* Init drivers */
8177 status = psa_driver_wrapper_init();
8178
8179 /* Drivers need shutdown regardless of startup errors. */
8180 global_data.initialized |= PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS_INITIALIZED;
8181
8182
8183 }
8184#if defined(MBEDTLS_THREADING_C)
8185 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_unlock(
8186 &mbedtls_threading_psa_globaldata_mutex));
8187#endif /* defined(MBEDTLS_THREADING_C) */
8188
8189 break;
8190
8191 case PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS:
8192
8193#if defined(MBEDTLS_THREADING_C)
8194 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex));
8195#endif /* defined(MBEDTLS_THREADING_C) */
8196
8197 if (!(global_data.initialized & PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS_INITIALIZED)) {
8198 status = psa_initialize_key_slots();
8199
8200 /* Need to wipe keys even if initialization fails. */
8201 global_data.initialized |= PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS_INITIALIZED;
8202
8203 }
8204#if defined(MBEDTLS_THREADING_C)
8205 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_unlock(
8206 &mbedtls_threading_psa_globaldata_mutex));
8207#endif /* defined(MBEDTLS_THREADING_C) */
8208
8209 break;
8210
8211 case PSA_CRYPTO_SUBSYSTEM_RNG:
8212
8213#if defined(MBEDTLS_THREADING_C)
8214 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex));
8215#endif /* defined(MBEDTLS_THREADING_C) */
8216
8217 driver_wrappers_initialized =
8218 (global_data.initialized & PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS_INITIALIZED);
8219
8220#if defined(MBEDTLS_THREADING_C)
8221 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_unlock(
8222 &mbedtls_threading_psa_globaldata_mutex));
8223#endif /* defined(MBEDTLS_THREADING_C) */
8224
8225 /* Need to use separate mutex here, as initialisation can require
8226 * testing of init flags, which requires locking the global data
8227 * mutex. */
8228#if defined(MBEDTLS_THREADING_C)
8229 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(&mbedtls_threading_psa_rngdata_mutex));
8230#endif /* defined(MBEDTLS_THREADING_C) */
8231
8232 /* Initialize and seed the random generator. */
8233 if (global_data.rng_state == RNG_NOT_INITIALIZED && driver_wrappers_initialized) {
8234 mbedtls_psa_random_init(&global_data.rng);
8235 global_data.rng_state = RNG_INITIALIZED;
8236
8237 status = mbedtls_psa_random_seed(&global_data.rng);
8238 if (status == PSA_SUCCESS) {
8239 global_data.rng_state = RNG_SEEDED;
8240 }
8241 }
8242
8243#if defined(MBEDTLS_THREADING_C)
8244 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_unlock(
8245 &mbedtls_threading_psa_rngdata_mutex));
8246#endif /* defined(MBEDTLS_THREADING_C) */
8247
Paul Elliott47cee8e2024-03-08 21:38:02 +00008248 break;
8249
8250 case PSA_CRYPTO_SUBSYSTEM_TRANSACTION:
8251
8252#if defined(MBEDTLS_THREADING_C)
8253 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_lock(&mbedtls_threading_psa_globaldata_mutex));
8254#endif /* defined(MBEDTLS_THREADING_C) */
8255
8256 if (!(global_data.initialized & PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED)) {
8257#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
8258 status = psa_crypto_load_transaction();
8259 if (status == PSA_SUCCESS) {
8260 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
8261 if (status == PSA_SUCCESS) {
8262 global_data.initialized |= PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED;
8263 }
8264 status = psa_crypto_stop_transaction();
8265 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
8266 /* There's no transaction to complete. It's all good. */
8267 global_data.initialized |= PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED;
8268 status = PSA_SUCCESS;
8269 }
8270#else /* defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS) */
8271 global_data.initialized |= PSA_CRYPTO_SUBSYSTEM_TRANSACTION_INITIALIZED;
8272 status = PSA_SUCCESS;
8273#endif /* defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS) */
8274 }
8275
8276#if defined(MBEDTLS_THREADING_C)
8277 PSA_THREADING_CHK_GOTO_EXIT(mbedtls_mutex_unlock(
8278 &mbedtls_threading_psa_globaldata_mutex));
8279#endif /* defined(MBEDTLS_THREADING_C) */
8280
8281 break;
8282
8283 default:
8284 status = PSA_ERROR_CORRUPTION_DETECTED;
8285 }
8286
8287 /* Exit label only required when using threading macros. */
8288#if defined(MBEDTLS_THREADING_C)
8289exit:
8290#endif /* defined(MBEDTLS_THREADING_C) */
8291
8292 return status;
8293}
8294
Gilles Peskine449bd832023-01-11 14:50:10 +01008295psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01008296{
Gilles Peskine66fb1262018-12-10 16:29:04 +01008297 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008298
Paul Elliott47cee8e2024-03-08 21:38:02 +00008299 /* Double initialization is explicitly allowed. Early out if everything is
8300 * done. */
8301 if (psa_get_initialized()) {
Gilles Peskine449bd832023-01-11 14:50:10 +01008302 return PSA_SUCCESS;
8303 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01008304
Paul Elliott47cee8e2024-03-08 21:38:02 +00008305 status = mbedtls_psa_crypto_init_subsystem(PSA_CRYPTO_SUBSYSTEM_DRIVER_WRAPPERS);
Valerio Setti402cfba2023-11-13 10:24:32 +01008306 if (status != PSA_SUCCESS) {
8307 goto exit;
8308 }
8309
Paul Elliott47cee8e2024-03-08 21:38:02 +00008310 status = mbedtls_psa_crypto_init_subsystem(PSA_CRYPTO_SUBSYSTEM_KEY_SLOTS);
Gilles Peskine449bd832023-01-11 14:50:10 +01008311 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01008312 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008313 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01008314
Paul Elliott47cee8e2024-03-08 21:38:02 +00008315 status = mbedtls_psa_crypto_init_subsystem(PSA_CRYPTO_SUBSYSTEM_RNG);
8316 if (status != PSA_SUCCESS) {
8317 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02008318 }
Gilles Peskinefc762652019-07-22 19:30:34 +02008319
Paul Elliott47cee8e2024-03-08 21:38:02 +00008320 status = mbedtls_psa_crypto_init_subsystem(PSA_CRYPTO_SUBSYSTEM_TRANSACTION);
Gilles Peskinee59236f2018-01-27 23:32:46 +01008321
8322exit:
Paul Elliott600472b2024-02-23 17:26:58 +00008323
Gilles Peskine449bd832023-01-11 14:50:10 +01008324 if (status != PSA_SUCCESS) {
8325 mbedtls_psa_crypto_free();
8326 }
Paul Elliott47cee8e2024-03-08 21:38:02 +00008327
Gilles Peskine449bd832023-01-11 14:50:10 +01008328 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008329}
8330
Yanray Wangffc3c482023-07-11 12:01:04 +08008331#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008332psa_status_t psa_crypto_driver_pake_get_password_len(
8333 const psa_crypto_driver_pake_inputs_t *inputs,
8334 size_t *password_len)
8335{
8336 if (inputs->password_len == 0) {
8337 return PSA_ERROR_BAD_STATE;
8338 }
8339
8340 *password_len = inputs->password_len;
8341
8342 return PSA_SUCCESS;
8343}
8344
8345psa_status_t psa_crypto_driver_pake_get_password(
8346 const psa_crypto_driver_pake_inputs_t *inputs,
8347 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
8348{
8349 if (inputs->password_len == 0) {
8350 return PSA_ERROR_BAD_STATE;
8351 }
8352
8353 if (buffer_size < inputs->password_len) {
8354 return PSA_ERROR_BUFFER_TOO_SMALL;
8355 }
8356
8357 memcpy(buffer, inputs->password, inputs->password_len);
8358 *buffer_length = inputs->password_len;
8359
8360 return PSA_SUCCESS;
8361}
8362
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008363psa_status_t psa_crypto_driver_pake_get_user_len(
8364 const psa_crypto_driver_pake_inputs_t *inputs,
8365 size_t *user_len)
8366{
8367 if (inputs->user_len == 0) {
8368 return PSA_ERROR_BAD_STATE;
8369 }
8370
8371 *user_len = inputs->user_len;
8372
8373 return PSA_SUCCESS;
8374}
8375
8376psa_status_t psa_crypto_driver_pake_get_user(
8377 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008378 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008379{
8380 if (inputs->user_len == 0) {
8381 return PSA_ERROR_BAD_STATE;
8382 }
8383
Przemek Stekielc0e62502023-03-14 11:49:36 +01008384 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008385 return PSA_ERROR_BUFFER_TOO_SMALL;
8386 }
8387
Przemek Stekielc0e62502023-03-14 11:49:36 +01008388 memcpy(user_id, inputs->user, inputs->user_len);
8389 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008390
8391 return PSA_SUCCESS;
8392}
8393
8394psa_status_t psa_crypto_driver_pake_get_peer_len(
8395 const psa_crypto_driver_pake_inputs_t *inputs,
8396 size_t *peer_len)
8397{
8398 if (inputs->peer_len == 0) {
8399 return PSA_ERROR_BAD_STATE;
8400 }
8401
8402 *peer_len = inputs->peer_len;
8403
8404 return PSA_SUCCESS;
8405}
8406
8407psa_status_t psa_crypto_driver_pake_get_peer(
8408 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008409 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008410{
8411 if (inputs->peer_len == 0) {
8412 return PSA_ERROR_BAD_STATE;
8413 }
8414
Przemek Stekielc0e62502023-03-14 11:49:36 +01008415 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008416 return PSA_ERROR_BUFFER_TOO_SMALL;
8417 }
8418
Przemek Stekielc0e62502023-03-14 11:49:36 +01008419 memcpy(peer_id, inputs->peer, inputs->peer_len);
8420 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008421
8422 return PSA_SUCCESS;
8423}
8424
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008425psa_status_t psa_crypto_driver_pake_get_cipher_suite(
8426 const psa_crypto_driver_pake_inputs_t *inputs,
8427 psa_pake_cipher_suite_t *cipher_suite)
8428{
8429 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
8430 return PSA_ERROR_BAD_STATE;
8431 }
8432
8433 *cipher_suite = inputs->cipher_suite;
8434
8435 return PSA_SUCCESS;
8436}
8437
Neil Armstronga7d08c32022-06-01 18:21:20 +02008438psa_status_t psa_pake_setup(
8439 psa_pake_operation_t *operation,
8440 const psa_pake_cipher_suite_t *cipher_suite)
8441{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008442 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008443
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008444 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008445 status = PSA_ERROR_BAD_STATE;
8446 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008447 }
8448
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008449 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01008450 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008451 status = PSA_ERROR_INVALID_ARGUMENT;
8452 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008453 }
8454
Przemek Stekiel51eac532022-12-07 11:04:51 +01008455 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
8456
Przemek Stekiele12ed362022-12-21 12:54:46 +01008457 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01008458 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
8459 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008460 operation->data.inputs.cipher_suite = *cipher_suite;
8461
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008462#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008463 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008464 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01008465 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008466
David Horstmann16f01512023-06-14 17:21:07 +01008467 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01008468 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008469 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008470#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008471 {
8472 status = PSA_ERROR_NOT_SUPPORTED;
8473 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008474 }
8475
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008476 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
8477
Przemek Stekiel51eac532022-12-07 11:04:51 +01008478 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008479exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008480 psa_pake_abort(operation);
8481 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008482}
8483
8484psa_status_t psa_pake_set_password_key(
8485 psa_pake_operation_t *operation,
8486 mbedtls_svc_key_id_t password)
8487{
Neil Armstrong5ae60962022-09-15 11:29:46 +02008488 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01008489 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
8490 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008491 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008492
Przemek Stekiel51eac532022-12-07 11:04:51 +01008493 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008494 status = PSA_ERROR_BAD_STATE;
8495 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008496 }
8497
Przemek Stekiel6c764412022-11-22 14:05:12 +01008498 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
8499 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008500 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008501 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008502 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008503 }
8504
Gilles Peskine7a5d9202024-02-28 01:18:23 +01008505 type = psa_get_key_type(&slot->attr);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008506
Przemek Stekiel51eac532022-12-07 11:04:51 +01008507 if (type != PSA_KEY_TYPE_PASSWORD &&
8508 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8509 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008510 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008511 }
8512
Przemek Stekiel51eac532022-12-07 11:04:51 +01008513 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8514 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008515 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008516 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008517 }
8518
8519 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8520 operation->data.inputs.password_len = slot->key.bytes;
Gilles Peskine7fad3ef2024-02-28 01:08:27 +01008521 operation->data.inputs.attributes = slot->attr;
8522
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008523exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008524 if (status != PSA_SUCCESS) {
8525 psa_pake_abort(operation);
8526 }
Ryan Everettbbedfce2024-02-14 18:22:09 +00008527 unlock_status = psa_unregister_read_under_mutex(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008528 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008529}
8530
8531psa_status_t psa_pake_set_user(
8532 psa_pake_operation_t *operation,
David Horstmann4f534ae2024-01-22 17:35:59 +00008533 const uint8_t *user_id_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008534 size_t user_id_len)
8535{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008536 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
David Horstmann4f534ae2024-01-22 17:35:59 +00008537 LOCAL_INPUT_DECLARE(user_id_external, user_id);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008538
8539 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008540 status = PSA_ERROR_BAD_STATE;
8541 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008542 }
8543
Przemek Stekiel51eac532022-12-07 11:04:51 +01008544 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008545 status = PSA_ERROR_INVALID_ARGUMENT;
8546 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008547 }
8548
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008549 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008550 status = PSA_ERROR_BAD_STATE;
8551 goto exit;
8552 }
8553
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008554 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8555 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008556 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8557 goto exit;
8558 }
8559
David Horstmann4f534ae2024-01-22 17:35:59 +00008560 LOCAL_INPUT_ALLOC(user_id_external, user_id_len, user_id);
8561
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008562 memcpy(operation->data.inputs.user, user_id, user_id_len);
8563 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008564
David Horstmann4f534ae2024-01-22 17:35:59 +00008565 status = PSA_SUCCESS;
8566
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008567exit:
David Horstmann4f534ae2024-01-22 17:35:59 +00008568 LOCAL_INPUT_FREE(user_id_external, user_id);
8569 if (status != PSA_SUCCESS) {
8570 psa_pake_abort(operation);
8571 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008572 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008573}
8574
8575psa_status_t psa_pake_set_peer(
8576 psa_pake_operation_t *operation,
David Horstmann4f534ae2024-01-22 17:35:59 +00008577 const uint8_t *peer_id_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008578 size_t peer_id_len)
8579{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008580 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
David Horstmann4f534ae2024-01-22 17:35:59 +00008581 LOCAL_INPUT_DECLARE(peer_id_external, peer_id);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008582
8583 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008584 status = PSA_ERROR_BAD_STATE;
8585 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008586 }
8587
Przemek Stekiel51eac532022-12-07 11:04:51 +01008588 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008589 status = PSA_ERROR_INVALID_ARGUMENT;
8590 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008591 }
8592
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008593 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008594 status = PSA_ERROR_BAD_STATE;
8595 goto exit;
8596 }
8597
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008598 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8599 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008600 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8601 goto exit;
8602 }
8603
David Horstmann4f534ae2024-01-22 17:35:59 +00008604 LOCAL_INPUT_ALLOC(peer_id_external, peer_id_len, peer_id);
8605
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008606 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8607 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008608
David Horstmann4f534ae2024-01-22 17:35:59 +00008609 status = PSA_SUCCESS;
8610
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008611exit:
David Horstmann4f534ae2024-01-22 17:35:59 +00008612 LOCAL_INPUT_FREE(peer_id_external, peer_id);
8613 if (status != PSA_SUCCESS) {
8614 psa_pake_abort(operation);
8615 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008616 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008617}
8618
8619psa_status_t psa_pake_set_role(
8620 psa_pake_operation_t *operation,
8621 psa_pake_role_t role)
8622{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008623 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008624
Przemek Stekiel51eac532022-12-07 11:04:51 +01008625 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008626 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008627 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008628 }
8629
Przemek Stekiel09104b82023-03-06 14:11:51 +01008630 switch (operation->alg) {
8631#if defined(PSA_WANT_ALG_JPAKE)
8632 case PSA_ALG_JPAKE:
8633 if (role == PSA_PAKE_ROLE_NONE) {
8634 return PSA_SUCCESS;
8635 }
8636 status = PSA_ERROR_INVALID_ARGUMENT;
8637 break;
8638#endif
8639 default:
8640 (void) role;
8641 status = PSA_ERROR_NOT_SUPPORTED;
8642 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008643 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008644exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008645 psa_pake_abort(operation);
8646 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008647}
8648
David Horstmanne7f21e62023-05-12 18:17:21 +01008649/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008650#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008651static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008652 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008653{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008654 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008655 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008656 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008657
David Horstmann024e5c52023-06-14 15:48:21 +01008658 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008659 is_x1 = (stage->outputs < 1);
8660 } else {
8661 is_x1 = (stage->inputs < 1);
8662 }
8663
David Horstmann74a3d8c2023-06-14 18:28:19 +01008664 key_share_step = is_x1 ?
8665 PSA_JPAKE_X1_STEP_KEY_SHARE :
8666 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008667 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008668 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8669 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8670 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8671 } else {
8672 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008673 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008674 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008675}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008676#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008677
Przemek Stekiel2797d372022-12-22 11:19:22 +01008678static psa_status_t psa_pake_complete_inputs(
8679 psa_pake_operation_t *operation)
8680{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008681 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008682 /* Create copy of the inputs on stack as inputs share memory
8683 with the driver context which will be setup by the driver. */
8684 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008685
Przemek Stekielfde11282023-03-13 16:06:09 +01008686 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008687 return PSA_ERROR_BAD_STATE;
8688 }
8689
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008690 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008691 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8692 return PSA_ERROR_BAD_STATE;
8693 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008694 }
8695
Przemek Stekiel18620a32023-01-17 16:34:52 +01008696 /* Clear driver context */
8697 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8698
8699 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008700
8701 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008702 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008703
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008704 /* User and peer are translated to role. */
8705 mbedtls_free(inputs.user);
8706 mbedtls_free(inputs.peer);
8707
Przemek Stekiel2797d372022-12-22 11:19:22 +01008708 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008709#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008710 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008711 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008712 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008713#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008714 {
8715 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008716 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008717 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008718 return status;
8719}
8720
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008721#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008722static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008723 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008724 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008725 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008726{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008727 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8728 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8729 step != PSA_PAKE_STEP_ZK_PROOF) {
8730 return PSA_ERROR_INVALID_ARGUMENT;
8731 }
8732
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008733 psa_jpake_computation_stage_t *computation_stage =
8734 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008735
David Horstmann5da95602023-06-08 15:37:12 +01008736 if (computation_stage->round != PSA_JPAKE_FIRST &&
8737 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008738 return PSA_ERROR_BAD_STATE;
8739 }
8740
David Horstmanne7f21e62023-05-12 18:17:21 +01008741 /* Check that the step we are given is the one we were expecting */
8742 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008743 return PSA_ERROR_BAD_STATE;
8744 }
8745
David Horstmanne7f21e62023-05-12 18:17:21 +01008746 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8747 computation_stage->inputs == 0 &&
8748 computation_stage->outputs == 0) {
8749 /* Start of the round, so function decides whether we are inputting
8750 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008751 computation_stage->io_mode = io_mode;
8752 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008753 /* Middle of the round so the mode we are in must match the function
8754 * called by the user */
8755 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008756 }
8757
8758 return PSA_SUCCESS;
8759}
8760
David Horstmanne7f21e62023-05-12 18:17:21 +01008761static psa_status_t psa_jpake_epilogue(
8762 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008763 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008764{
David Horstmanne7f21e62023-05-12 18:17:21 +01008765 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008766 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008767
David Horstmanne7f21e62023-05-12 18:17:21 +01008768 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8769 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008770 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008771 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008772 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008773 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008774 }
8775 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008776 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008777 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008778 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008779 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008780 }
8781 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008782 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8783 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008784 /* End of a round, move to the next round */
8785 stage->inputs = 0;
8786 stage->outputs = 0;
8787 stage->round++;
8788 }
8789 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008790 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008791 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008792 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008793 return PSA_SUCCESS;
8794}
David Horstmanne7f21e62023-05-12 18:17:21 +01008795
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008796#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008797
Neil Armstronga7d08c32022-06-01 18:21:20 +02008798psa_status_t psa_pake_output(
8799 psa_pake_operation_t *operation,
8800 psa_pake_step_t step,
David Horstmannc75639d2024-01-22 17:56:39 +00008801 uint8_t *output_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008802 size_t output_size,
8803 size_t *output_length)
8804{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008805 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008806 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
David Horstmannc75639d2024-01-22 17:56:39 +00008807 LOCAL_OUTPUT_DECLARE(output_external, output);
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008808 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008809
8810 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008811 status = psa_pake_complete_inputs(operation);
8812 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008813 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008814 }
8815 }
8816
8817 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008818 status = PSA_ERROR_BAD_STATE;
8819 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008820 }
8821
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008822 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008823 status = PSA_ERROR_INVALID_ARGUMENT;
8824 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008825 }
8826
Przemek Stekiele12ed362022-12-21 12:54:46 +01008827 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008828#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008829 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008830 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008831 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008832 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008833 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008834 driver_step = convert_jpake_computation_stage_to_driver_step(
8835 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008836 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008837#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008838 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008839 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008840 status = PSA_ERROR_NOT_SUPPORTED;
8841 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008842 }
8843
David Horstmannc75639d2024-01-22 17:56:39 +00008844 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
8845
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008846 status = psa_driver_wrapper_pake_output(operation, driver_step,
8847 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008848
8849 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008850 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008851 }
8852
8853 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008854#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008855 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008856 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008857 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008858 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008859 }
8860 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008861#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008862 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008863 status = PSA_ERROR_NOT_SUPPORTED;
8864 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008865 }
8866
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008867exit:
David Horstmannc75639d2024-01-22 17:56:39 +00008868 LOCAL_OUTPUT_FREE(output_external, output);
8869 if (status != PSA_SUCCESS) {
8870 psa_pake_abort(operation);
8871 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008872 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008873}
8874
8875psa_status_t psa_pake_input(
8876 psa_pake_operation_t *operation,
8877 psa_pake_step_t step,
David Horstmannc75639d2024-01-22 17:56:39 +00008878 const uint8_t *input_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008879 size_t input_length)
8880{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008881 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008882 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008883 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8884 operation->primitive,
8885 step);
David Horstmannc75639d2024-01-22 17:56:39 +00008886 LOCAL_INPUT_DECLARE(input_external, input);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008887
8888 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008889 status = psa_pake_complete_inputs(operation);
8890 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008891 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008892 }
8893 }
8894
8895 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008896 status = PSA_ERROR_BAD_STATE;
8897 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008898 }
8899
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008900 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008901 status = PSA_ERROR_INVALID_ARGUMENT;
8902 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008903 }
8904
Przemek Stekiele12ed362022-12-21 12:54:46 +01008905 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008906#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008907 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008908 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008909 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008910 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008911 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008912 driver_step = convert_jpake_computation_stage_to_driver_step(
8913 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008914 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008915#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008916 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008917 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008918 status = PSA_ERROR_NOT_SUPPORTED;
8919 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008920 }
8921
David Horstmannc75639d2024-01-22 17:56:39 +00008922 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008923 status = psa_driver_wrapper_pake_input(operation, driver_step,
8924 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008925
8926 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008927 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008928 }
8929
8930 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008931#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008932 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008933 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008934 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008935 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008936 }
8937 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008938#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008939 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008940 status = PSA_ERROR_NOT_SUPPORTED;
8941 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008942 }
8943
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008944exit:
David Horstmannc75639d2024-01-22 17:56:39 +00008945 LOCAL_INPUT_FREE(input_external, input);
8946 if (status != PSA_SUCCESS) {
8947 psa_pake_abort(operation);
8948 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008949 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008950}
8951
8952psa_status_t psa_pake_get_implicit_key(
8953 psa_pake_operation_t *operation,
8954 psa_key_derivation_operation_t *output)
8955{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008956 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008957 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008958 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008959 size_t shared_key_len = 0;
8960
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008961 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008962 status = PSA_ERROR_BAD_STATE;
8963 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008964 }
8965
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008966#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008967 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008968 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008969 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008970 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008971 status = PSA_ERROR_BAD_STATE;
8972 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008973 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008974 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008975#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008976 {
8977 status = PSA_ERROR_NOT_SUPPORTED;
8978 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008979 }
8980
Przemek Stekiel0c781802022-11-29 14:53:13 +01008981 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8982 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008983 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008984 &shared_key_len);
8985
8986 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008987 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008988 }
8989
8990 status = psa_key_derivation_input_bytes(output,
8991 PSA_KEY_DERIVATION_INPUT_SECRET,
8992 shared_key,
8993 shared_key_len);
8994
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008995 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008996exit:
8997 abort_status = psa_pake_abort(operation);
8998 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008999}
9000
9001psa_status_t psa_pake_abort(
9002 psa_pake_operation_t *operation)
9003{
Przemek Stekield69dca92023-01-31 19:59:20 +01009004 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01009005
Przemek Stekield69dca92023-01-31 19:59:20 +01009006 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01009007 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02009008 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01009009
Przemek Stekiel26c909d2023-02-28 12:34:03 +01009010 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
9011 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01009012 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01009013 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01009014 }
9015 if (operation->data.inputs.user != NULL) {
9016 mbedtls_free(operation->data.inputs.user);
9017 }
9018 if (operation->data.inputs.peer != NULL) {
9019 mbedtls_free(operation->data.inputs.peer);
9020 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01009021 }
Przemek Stekield69dca92023-01-31 19:59:20 +01009022 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01009023
Przemek Stekield69dca92023-01-31 19:59:20 +01009024 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02009025}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01009026#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02009027
David Horstmann00d7a042023-12-07 18:39:17 +00009028/* Memory copying test hooks. These are called before input copy, after input
9029 * copy, before output copy and after output copy, respectively.
9030 * They are used by memory-poisoning tests to temporarily unpoison buffers
9031 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00009032#if defined(MBEDTLS_TEST_HOOKS)
9033void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
9034void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
9035void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
9036void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
9037#endif
David Horstmannfde97392023-10-30 20:29:43 +00009038
David Horstmann1b7279a2023-11-15 15:18:30 +00009039/** Copy from an input buffer to a local copy.
9040 *
9041 * \param[in] input Pointer to input buffer.
9042 * \param[in] input_len Length of the input buffer.
9043 * \param[out] input_copy Pointer to a local copy in which to store the input data.
9044 * \param[out] input_copy_len Length of the local copy buffer.
9045 * \return #PSA_SUCCESS, if the buffer was successfully
9046 * copied.
9047 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
9048 * copy is too small to hold contents of the
9049 * input buffer.
9050 */
9051MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00009052psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
9053 uint8_t *input_copy, size_t input_copy_len)
9054{
9055 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00009056 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00009057 }
9058
David Horstmann372b8bb2023-11-24 16:21:04 +00009059#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00009060 if (psa_input_pre_copy_hook != NULL) {
9061 psa_input_pre_copy_hook(input, input_len);
9062 }
David Horstmann372b8bb2023-11-24 16:21:04 +00009063#endif
9064
David Horstmann777e7412023-11-15 17:33:47 +00009065 if (input_len > 0) {
9066 memcpy(input_copy, input, input_len);
9067 }
David Horstmannfde97392023-10-30 20:29:43 +00009068
David Horstmann372b8bb2023-11-24 16:21:04 +00009069#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00009070 if (psa_input_post_copy_hook != NULL) {
9071 psa_input_post_copy_hook(input, input_len);
9072 }
David Horstmann372b8bb2023-11-24 16:21:04 +00009073#endif
9074
David Horstmannfde97392023-10-30 20:29:43 +00009075 return PSA_SUCCESS;
9076}
9077
David Horstmann1b7279a2023-11-15 15:18:30 +00009078/** Copy from a local output buffer into a user-supplied one.
9079 *
9080 * \param[in] output_copy Pointer to a local buffer containing the output.
9081 * \param[in] output_copy_len Length of the local buffer.
9082 * \param[out] output Pointer to user-supplied output buffer.
9083 * \param[out] output_len Length of the user-supplied output buffer.
9084 * \return #PSA_SUCCESS, if the buffer was successfully
9085 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00009086 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00009087 * user-supplied output buffer is too small to
9088 * hold the contents of the local buffer.
9089 */
9090MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00009091psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
9092 uint8_t *output, size_t output_len)
9093{
9094 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00009095 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00009096 }
David Horstmann777e7412023-11-15 17:33:47 +00009097
David Horstmann372b8bb2023-11-24 16:21:04 +00009098#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00009099 if (psa_output_pre_copy_hook != NULL) {
9100 psa_output_pre_copy_hook(output, output_len);
9101 }
David Horstmann372b8bb2023-11-24 16:21:04 +00009102#endif
9103
David Horstmann777e7412023-11-15 17:33:47 +00009104 if (output_copy_len > 0) {
9105 memcpy(output, output_copy, output_copy_len);
9106 }
9107
David Horstmann372b8bb2023-11-24 16:21:04 +00009108#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00009109 if (psa_output_post_copy_hook != NULL) {
9110 psa_output_post_copy_hook(output, output_len);
9111 }
David Horstmann372b8bb2023-11-24 16:21:04 +00009112#endif
9113
David Horstmann8978f5c2023-10-30 20:37:12 +00009114 return PSA_SUCCESS;
9115}
9116
David Horstmannf1734052023-11-20 17:15:32 +00009117psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
9118 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00009119{
9120 psa_status_t status;
9121
David Horstmann9db14482023-11-23 15:50:37 +00009122 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00009123
David Horstmannc5cc1c32023-11-15 18:11:26 +00009124 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00009125 return PSA_SUCCESS;
9126 }
9127
David Horstmannf1734052023-11-20 17:15:32 +00009128 local_input->buffer = mbedtls_calloc(input_len, 1);
9129 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +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 Horstmannf1734052023-11-20 17:15:32 +00009134 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00009135
David Horstmannf1734052023-11-20 17:15:32 +00009136 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00009137
9138 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00009139 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00009140 if (status != PSA_SUCCESS) {
9141 goto error;
9142 }
9143
9144 return PSA_SUCCESS;
9145
9146error:
David Horstmannf1734052023-11-20 17:15:32 +00009147 mbedtls_free(local_input->buffer);
9148 local_input->buffer = NULL;
9149 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00009150 return status;
9151}
9152
David Horstmannf1734052023-11-20 17:15:32 +00009153void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00009154{
David Horstmannf1734052023-11-20 17:15:32 +00009155 mbedtls_free(local_input->buffer);
9156 local_input->buffer = NULL;
9157 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00009158}
9159
David Horstmann89875a42023-11-20 12:54:09 +00009160psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
9161 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00009162{
David Horstmann9db14482023-11-23 15:50:37 +00009163 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00009164
David Horstmannc5cc1c32023-11-15 18:11:26 +00009165 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00009166 return PSA_SUCCESS;
9167 }
David Horstmann89875a42023-11-20 12:54:09 +00009168 local_output->buffer = mbedtls_calloc(output_len, 1);
9169 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00009170 /* Since we dealt with the zero-length case above, we know that
9171 * a NULL return value means a failure of allocation. */
9172 return PSA_ERROR_INSUFFICIENT_MEMORY;
9173 }
David Horstmann89875a42023-11-20 12:54:09 +00009174 local_output->length = output_len;
9175 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00009176
9177 return PSA_SUCCESS;
9178}
9179
David Horstmann89875a42023-11-20 12:54:09 +00009180psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00009181{
David Horstmannc335a4e2023-11-15 15:57:32 +00009182 psa_status_t status;
9183
David Horstmann89875a42023-11-20 12:54:09 +00009184 if (local_output->buffer == NULL) {
9185 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00009186 return PSA_SUCCESS;
9187 }
David Horstmann89875a42023-11-20 12:54:09 +00009188 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00009189 /* We have an internal copy but nothing to copy back to. */
9190 return PSA_ERROR_CORRUPTION_DETECTED;
9191 }
9192
David Horstmann89875a42023-11-20 12:54:09 +00009193 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
9194 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00009195 if (status != PSA_SUCCESS) {
9196 return status;
9197 }
David Horstmann9467ea32023-11-08 17:44:18 +00009198
David Horstmann89875a42023-11-20 12:54:09 +00009199 mbedtls_free(local_output->buffer);
9200 local_output->buffer = NULL;
9201 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00009202
9203 return PSA_SUCCESS;
9204}
9205
Gilles Peskinee59236f2018-01-27 23:32:46 +01009206#endif /* MBEDTLS_PSA_CRYPTO_C */