blob: bb924480ed64341901782fed2adab1929d0b87c7 [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"
Gilles Peskinea5905292018-02-07 20:59:33 +010074
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020075#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
76 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
77 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Przemek Stekiel69c46792022-06-10 12:59:51 +020078#define BUILTIN_ALG_ANY_HKDF 1
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020079#endif
80
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010081/****************************************************************/
82/* Global data, support functions and library management */
83/****************************************************************/
84
Gilles Peskine449bd832023-01-11 14:50:10 +010085static int key_type_is_raw_bytes(psa_key_type_t type)
Gilles Peskine48c0ea12018-06-21 14:15:31 +020086{
Gilles Peskine449bd832023-01-11 14:50:10 +010087 return PSA_KEY_TYPE_IS_UNSTRUCTURED(type);
Gilles Peskine48c0ea12018-06-21 14:15:31 +020088}
89
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010090/* Values for psa_global_data_t::rng_state */
91#define RNG_NOT_INITIALIZED 0
92#define RNG_INITIALIZED 1
93#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +010094
Gilles Peskine449bd832023-01-11 14:50:10 +010095typedef struct {
Dave Rodgman864f5942023-08-16 18:04:44 +010096 uint8_t initialized;
97 uint8_t rng_state;
98 uint8_t drivers_initialized;
Gilles Peskine2d8a1822021-11-08 22:20:03 +010099 mbedtls_psa_random_context_t rng;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100100} psa_global_data_t;
101
102static psa_global_data_t global_data;
103
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100104#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
105mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
106 &global_data.rng.drbg;
107#endif
108
itayzafrir0adf0fc2018-09-06 16:24:41 +0300109#define GUARD_MODULE_INITIALIZED \
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 if (global_data.initialized == 0) \
111 return PSA_ERROR_BAD_STATE;
itayzafrir0adf0fc2018-09-06 16:24:41 +0300112
David Horstmann513101b2023-11-29 17:24:08 +0000113#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
David Horstmann36df4b22023-12-13 15:55:25 +0000114
David Horstmann62a56d92023-12-14 18:12:47 +0000115/* Declare a local copy of an input buffer and a variable that will be used
116 * to store a pointer to the start of the buffer.
David Horstmann36df4b22023-12-13 15:55:25 +0000117 *
118 * Note: This macro must be called before any operations which may jump to
119 * the exit label, so that the local input copy object is safe to be freed.
120 *
121 * Assumptions:
122 * - input is the name of a pointer to the buffer to be copied
123 * - The name LOCAL_INPUT_COPY_OF_input is unused in the current scope
David Horstmann62a56d92023-12-14 18:12:47 +0000124 * - input_copy_name is a name that is unused in the current scope
David Horstmann36df4b22023-12-13 15:55:25 +0000125 */
David Horstmann62a56d92023-12-14 18:12:47 +0000126#define LOCAL_INPUT_DECLARE(input, input_copy_name) \
127 psa_crypto_local_input_t LOCAL_INPUT_COPY_OF_##input = PSA_CRYPTO_LOCAL_INPUT_INIT; \
128 const uint8_t *input_copy_name = NULL;
David Horstmann36df4b22023-12-13 15:55:25 +0000129
David Horstmann62a56d92023-12-14 18:12:47 +0000130/* Allocate a copy of the buffer input and set the pointer input_copy to
131 * point to the start of the copy.
David Horstmann36df4b22023-12-13 15:55:25 +0000132 *
David Horstmanne9a88ab2023-11-29 17:07:13 +0000133 * Assumptions:
134 * - psa_status_t status exists
135 * - An exit label is declared
David Horstmann36df4b22023-12-13 15:55:25 +0000136 * - input is the name of a pointer to the buffer to be copied
David Horstmann62a56d92023-12-14 18:12:47 +0000137 * - LOCAL_INPUT_DECLARE(input, input_copy) has previously been called
David Horstmanne9a88ab2023-11-29 17:07:13 +0000138 */
David Horstmann62a56d92023-12-14 18:12:47 +0000139#define LOCAL_INPUT_ALLOC(input, length, input_copy) \
David Horstmann36df4b22023-12-13 15:55:25 +0000140 status = psa_crypto_local_input_alloc(input, length, \
141 &LOCAL_INPUT_COPY_OF_##input); \
David Horstmanne9a88ab2023-11-29 17:07:13 +0000142 if (status != PSA_SUCCESS) { \
143 goto exit; \
144 } \
David Horstmann62a56d92023-12-14 18:12:47 +0000145 input_copy = LOCAL_INPUT_COPY_OF_##input.buffer;
David Horstmanne9a88ab2023-11-29 17:07:13 +0000146
David Horstmann36df4b22023-12-13 15:55:25 +0000147/* Free the local input copy allocated previously by LOCAL_INPUT_ALLOC()
148 *
David Horstmann3e72db42023-12-08 14:08:18 +0000149 * Assumptions:
David Horstmann62a56d92023-12-14 18:12:47 +0000150 * - input_copy is the name of the input copy pointer set by LOCAL_INPUT_ALLOC()
David Horstmann36df4b22023-12-13 15:55:25 +0000151 * - input is the name of the original buffer that was copied
David Horstmann3e72db42023-12-08 14:08:18 +0000152 */
David Horstmann62a56d92023-12-14 18:12:47 +0000153#define LOCAL_INPUT_FREE(input, input_copy) \
154 input_copy = NULL; \
David Horstmann36df4b22023-12-13 15:55:25 +0000155 psa_crypto_local_input_free(&LOCAL_INPUT_COPY_OF_##input);
David Horstmanne9a88ab2023-11-29 17:07:13 +0000156
David Horstmann62a56d92023-12-14 18:12:47 +0000157/* Declare a local copy of an output buffer and a variable that will be used
158 * to store a pointer to the start of the buffer.
David Horstmann36df4b22023-12-13 15:55:25 +0000159 *
160 * Note: This macro must be called before any operations which may jump to
161 * the exit label, so that the local output copy object is safe to be freed.
162 *
163 * Assumptions:
164 * - output is the name of a pointer to the buffer to be copied
165 * - The name LOCAL_OUTPUT_COPY_OF_output is unused in the current scope
David Horstmann62a56d92023-12-14 18:12:47 +0000166 * - output_copy_name is a name that is unused in the current scope
David Horstmann36df4b22023-12-13 15:55:25 +0000167 */
David Horstmann62a56d92023-12-14 18:12:47 +0000168#define LOCAL_OUTPUT_DECLARE(output, output_copy_name) \
169 psa_crypto_local_output_t LOCAL_OUTPUT_COPY_OF_##output = PSA_CRYPTO_LOCAL_OUTPUT_INIT; \
170 uint8_t *output_copy_name = NULL;
David Horstmann36df4b22023-12-13 15:55:25 +0000171
David Horstmann62a56d92023-12-14 18:12:47 +0000172/* Allocate a copy of the buffer output and set the pointer output_copy to
173 * point to the start of the copy.
David Horstmann36df4b22023-12-13 15:55:25 +0000174 *
David Horstmanne9a88ab2023-11-29 17:07:13 +0000175 * Assumptions:
176 * - psa_status_t status exists
177 * - An exit label is declared
David Horstmann36df4b22023-12-13 15:55:25 +0000178 * - output is the name of a pointer to the buffer to be copied
David Horstmann62a56d92023-12-14 18:12:47 +0000179 * - LOCAL_OUTPUT_DECLARE(output, output_copy) has previously been called
David Horstmanne9a88ab2023-11-29 17:07:13 +0000180 */
David Horstmann62a56d92023-12-14 18:12:47 +0000181#define LOCAL_OUTPUT_ALLOC(output, length, output_copy) \
David Horstmann36df4b22023-12-13 15:55:25 +0000182 status = psa_crypto_local_output_alloc(output, length, \
183 &LOCAL_OUTPUT_COPY_OF_##output); \
David Horstmanne9a88ab2023-11-29 17:07:13 +0000184 if (status != PSA_SUCCESS) { \
185 goto exit; \
186 } \
David Horstmann62a56d92023-12-14 18:12:47 +0000187 output_copy = LOCAL_OUTPUT_COPY_OF_##output.buffer;
David Horstmanne9a88ab2023-11-29 17:07:13 +0000188
Gabor Mezei1882c512024-01-24 13:07:17 +0100189/* Allocate a copy of the buffer output and set the pointer output_copy to
190 * point to the start of the copy.
191 *
192 * Assumptions:
193 * - psa_status_t status exists
194 * - An exit label is declared
195 * - output is the name of a pointer to the buffer to be copied
196 * - LOCAL_OUTPUT_DECLARE(output, output_copy) has previously been called
197 */
198#define LOCAL_OUTPUT_ALLOC_WITH_COPY(output, length, output_copy) \
199 status = psa_crypto_local_output_alloc_with_copy(output, length, \
200 &LOCAL_OUTPUT_COPY_OF_##output); \
201 if (status != PSA_SUCCESS) { \
202 goto exit; \
203 } \
204 output_copy = LOCAL_OUTPUT_COPY_OF_##output.buffer;
205
David Horstmann62a56d92023-12-14 18:12:47 +0000206/* Free the local output copy allocated previously by LOCAL_OUTPUT_ALLOC()
David Horstmann3e72db42023-12-08 14:08:18 +0000207 * after first copying back its contents to the original buffer.
David Horstmann36df4b22023-12-13 15:55:25 +0000208 *
David Horstmann3e72db42023-12-08 14:08:18 +0000209 * Assumptions:
David Horstmann3e72db42023-12-08 14:08:18 +0000210 * - psa_status_t status exists
David Horstmann62a56d92023-12-14 18:12:47 +0000211 * - output_copy is the name of the output copy pointer set by LOCAL_OUTPUT_ALLOC()
212 * - output is the name of the original buffer that was copied
David Horstmann3e72db42023-12-08 14:08:18 +0000213 */
David Horstmann62a56d92023-12-14 18:12:47 +0000214#define LOCAL_OUTPUT_FREE(output, output_copy) \
215 output_copy = NULL; \
David Horstmann5a945f52023-12-13 14:09:08 +0000216 do { \
217 psa_status_t local_output_status; \
David Horstmann36df4b22023-12-13 15:55:25 +0000218 local_output_status = psa_crypto_local_output_free(&LOCAL_OUTPUT_COPY_OF_##output); \
David Horstmann5a945f52023-12-13 14:09:08 +0000219 if (local_output_status != PSA_SUCCESS) { \
220 /* Since this error case is an internal error, it's more serious than \
221 * any existing error code and so it's fine to overwrite the existing \
222 * status. */ \
223 status = local_output_status; \
224 } \
225 } while (0)
David Horstmann513101b2023-11-29 17:24:08 +0000226#else /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
David Horstmann62a56d92023-12-14 18:12:47 +0000227#define LOCAL_INPUT_DECLARE(input, input_copy_name) \
228 const uint8_t *input_copy_name = NULL;
229#define LOCAL_INPUT_ALLOC(input, length, input_copy) \
230 input_copy = input;
231#define LOCAL_INPUT_FREE(input, input_copy) \
232 input_copy = NULL;
233#define LOCAL_OUTPUT_DECLARE(output, output_copy_name) \
234 uint8_t *output_copy_name = NULL;
235#define LOCAL_OUTPUT_ALLOC(output, length, output_copy) \
236 output_copy = output;
237#define LOCAL_OUTPUT_FREE(output, output_copy) \
238 output_copy = NULL;
David Horstmann513101b2023-11-29 17:24:08 +0000239#endif /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
David Horstmanne9a88ab2023-11-29 17:07:13 +0000240
241
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100242int psa_can_do_hash(psa_algorithm_t hash_alg)
243{
244 (void) hash_alg;
245 return global_data.drivers_initialized;
246}
Valerio Settic6f004f2023-12-12 11:27:36 +0100247
Valerio Setti1fff4f22023-12-28 14:19:34 +0100248int psa_can_do_cipher(psa_key_type_t key_type, psa_algorithm_t cipher_alg)
Valerio Settic6f004f2023-12-12 11:27:36 +0100249{
Valerio Setti1fff4f22023-12-28 14:19:34 +0100250 (void) key_type;
Valerio Settic6f004f2023-12-12 11:27:36 +0100251 (void) cipher_alg;
252 return global_data.drivers_initialized;
253}
254
255
Valerio Settia55f0422023-07-10 15:34:41 +0200256#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel53410502023-04-28 13:18:43 +0200257 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) || \
Valerio Settia55f0422023-07-10 15:34:41 +0200258 defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekiel134cc2e2023-05-05 10:13:37 +0200259static int psa_is_dh_key_size_valid(size_t bits)
260{
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200261 if (bits != 2048 && bits != 3072 && bits != 4096 &&
262 bits != 6144 && bits != 8192) {
263 return 0;
264 }
265
266 return 1;
267}
Valerio Settia55f0422023-07-10 15:34:41 +0200268#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT ||
Przemek Stekiel53410502023-04-28 13:18:43 +0200269 MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY ||
Valerio Settia55f0422023-07-10 15:34:41 +0200270 PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE */
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100271
Gilles Peskine449bd832023-01-11 14:50:10 +0100272psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100273{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100274 /* Mbed TLS error codes can combine a high-level error code and a
275 * low-level error code. The low-level error usually reflects the
276 * root cause better, so dispatch on that preferably. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100277 int low_level_ret = -(-ret & 0x007f);
278 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100279 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100280 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100281
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100282#if defined(MBEDTLS_AES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100283 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
284 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100285 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman09a9e582023-08-31 11:05:22 +0100286 case MBEDTLS_ERR_AES_BAD_INPUT_DATA:
287 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100288#endif
289
290#if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_ASN1_WRITE_C)
Gilles Peskine9a944802018-06-21 09:35:35 +0200291 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
292 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
293 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
294 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
295 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100296 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200297 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100298 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200299 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100301#endif
Gilles Peskine9a944802018-06-21 09:35:35 +0200302
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100303#if defined(MBEDTLS_CAMELLIA_C)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000304 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Gilles Peskinea5905292018-02-07 20:59:33 +0100305 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100306 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100307#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100308
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100309#if defined(MBEDTLS_CCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100310 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100312 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100313 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100314#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100315
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100316#if defined(MBEDTLS_CHACHA20_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200317 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100319#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200320
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100321#if defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200322 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200324 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100325 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100326#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200327
Dave Rodgman509b5672023-08-16 19:26:23 +0100328#if defined(MBEDTLS_CIPHER_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100329 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100330 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100331 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100332 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100333 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100334 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100335 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100336 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100337 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100338 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100339 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100340 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100341 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100342 return PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100343#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100344
Gilles Peskine449bd832023-01-11 14:50:10 +0100345#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
346 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100347 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
348 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100349 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100351 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
352 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100354 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100356#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100357
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100358#if defined(MBEDTLS_DES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100359 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100360 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100361#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100362
Gilles Peskinee59236f2018-01-27 23:32:46 +0100363 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
364 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
365 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100367
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100368#if defined(MBEDTLS_GCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100369 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100370 return PSA_ERROR_INVALID_SIGNATURE;
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200371 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100373 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100374 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100375#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100376
Gilles Peskine82e57d12020-11-13 21:31:17 +0100377#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100378 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100379 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
380 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100381 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100382 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100383 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
384 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100385 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100386 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100387 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100388#endif
389
Dave Rodgmandea266f2023-08-31 11:52:43 +0100390#if defined(MBEDTLS_MD_LIGHT)
Gilles Peskinea5905292018-02-07 20:59:33 +0100391 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100392 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100393 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100394 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100395 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100396 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100397#if defined(MBEDTLS_FS_IO)
Gilles Peskinea5905292018-02-07 20:59:33 +0100398 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100399 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100400#endif
401#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100402
Dave Rodgman509b5672023-08-16 19:26:23 +0100403#if defined(MBEDTLS_BIGNUM_C)
404#if defined(MBEDTLS_FS_IO)
Gilles Peskinef76aa772018-10-29 19:24:33 +0100405 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100407#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100408 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100409 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100410 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
Gilles Peskine449bd832023-01-11 14:50:10 +0100411 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100412 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100413 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100414 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100415 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100416 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100418 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100419 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100420 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100421 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100422#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100423
Dave Rodgman509b5672023-08-16 19:26:23 +0100424#if defined(MBEDTLS_PK_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100425 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100426 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100427 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
428 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100429 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100430#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) || defined(MBEDTLS_FS_IO) || \
431 defined(MBEDTLS_PSA_ITS_FILE_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100432 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100433 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100434#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100435 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
436 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100437 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100438 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100439 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100440 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
441 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100442 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100443 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100444 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100445 case MBEDTLS_ERR_PK_INVALID_ALG:
446 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
447 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100448 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100449 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100450 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200451 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100452 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100453#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100454
Gilles Peskineff2d2002019-05-06 15:26:23 +0200455 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100456 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200457 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200459
Dave Rodgman509b5672023-08-16 19:26:23 +0100460#if defined(MBEDTLS_RSA_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100461 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100462 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100463 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100465 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100466 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100467 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100468 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100469 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
470 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100471 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100472 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100473 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100474 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100476 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100477 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100478#endif
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200479
Dave Rodgman1dab4452023-09-01 09:59:51 +0100480#if defined(MBEDTLS_ECP_LIGHT)
itayzafrir5c753392018-05-08 11:18:38 +0300481 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300482 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300484 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300486 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100487 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300488 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
489 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100490 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300491 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100492 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100493 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100494 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100495
Dave Rodgman509b5672023-08-16 19:26:23 +0100496#if defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +0000497 case MBEDTLS_ERR_ECP_IN_PROGRESS:
498 return PSA_OPERATION_INCOMPLETE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100499#endif
500#endif
Paul Elliott588f8ed2022-12-02 18:10:26 +0000501
Janos Follatha13b9052019-11-22 12:48:59 +0000502 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100503 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300504
Gilles Peskinee59236f2018-01-27 23:32:46 +0100505 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100506 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100507 }
508}
509
Paul Elliottdc42ca82023-02-24 18:11:59 +0000510/**
511 * \brief For output buffers which contain "tags"
512 * (outputs that may be checked for validity like
513 * hashes, MACs and signatures), fill the unused
514 * part of the output buffer (the whole buffer on
515 * error, the trailing part on success) with
516 * something that isn't a valid tag (barring an
517 * attack on the tag and deliberately-crafted
518 * input), in case the caller doesn't check the
519 * return status properly.
520 *
521 * \param output_buffer Pointer to buffer to wipe. May not be NULL
522 * unless \p output_buffer_size is zero.
523 * \param status Status of function called to generate
524 * output_buffer originally
525 * \param output_buffer_size Size of output buffer. If zero, \p output_buffer
526 * could be NULL.
527 * \param output_buffer_length Length of data written to output_buffer, must be
528 * less than \p output_buffer_size
529 */
530static void psa_wipe_tag_output_buffer(uint8_t *output_buffer, psa_status_t status,
Paul Elliott7118d172023-02-26 16:57:05 +0000531 size_t output_buffer_size, size_t output_buffer_length)
532{
Paul Elliottdc42ca82023-02-24 18:11:59 +0000533 size_t offset = 0;
534
535 if (output_buffer_size == 0) {
536 /* If output_buffer_size is 0 then we have nothing to do. We must not
537 call memset because output_buffer may be NULL in this case */
538 return;
539 }
540
541 if (status == PSA_SUCCESS) {
542 offset = output_buffer_length;
543 }
544
545 memset(output_buffer + offset, '!', output_buffer_size - offset);
546}
547
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200548
Gilles Peskine449bd832023-01-11 14:50:10 +0100549psa_status_t psa_validate_unstructured_key_bit_size(psa_key_type_t type,
550 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200551{
552 /* Check that the bit size is acceptable for the key type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100553 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200554 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200555 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200556 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200557 case PSA_KEY_TYPE_PASSWORD:
558 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200559 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100560#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200561 case PSA_KEY_TYPE_AES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100562 if (bits != 128 && bits != 192 && bits != 256) {
563 return PSA_ERROR_INVALID_ARGUMENT;
564 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200565 break;
566#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200567#if defined(PSA_WANT_KEY_TYPE_ARIA)
568 case PSA_KEY_TYPE_ARIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100569 if (bits != 128 && bits != 192 && bits != 256) {
570 return PSA_ERROR_INVALID_ARGUMENT;
571 }
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200572 break;
573#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100574#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200575 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 if (bits != 128 && bits != 192 && bits != 256) {
577 return PSA_ERROR_INVALID_ARGUMENT;
578 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200579 break;
580#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100581#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200582 case PSA_KEY_TYPE_DES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100583 if (bits != 64 && bits != 128 && bits != 192) {
584 return PSA_ERROR_INVALID_ARGUMENT;
585 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200586 break;
587#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100588#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200589 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine449bd832023-01-11 14:50:10 +0100590 if (bits != 256) {
591 return PSA_ERROR_INVALID_ARGUMENT;
592 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200593 break;
594#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200595 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100596 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200597 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100598 if (bits % 8 != 0) {
599 return PSA_ERROR_INVALID_ARGUMENT;
600 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200601
Gilles Peskine449bd832023-01-11 14:50:10 +0100602 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200603}
604
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100605/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100606 *
Steven Cooremancd640932021-03-08 12:00:27 +0100607 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
608 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100609 *
610 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100611 * \param[in] key_type The key type of the key to be used with the
612 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100613 *
614 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100615 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100616 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100617 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100618 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100619MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100620 psa_algorithm_t algorithm,
Gilles Peskine449bd832023-01-11 14:50:10 +0100621 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100622{
Gilles Peskine449bd832023-01-11 14:50:10 +0100623 if (PSA_ALG_IS_HMAC(algorithm)) {
624 if (key_type == PSA_KEY_TYPE_HMAC) {
625 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100626 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100627 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100628
Gilles Peskine449bd832023-01-11 14:50:10 +0100629 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
630 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
631 * key. */
632 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
633 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
634 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
635 * the block length (larger than 1) for block ciphers. */
636 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
637 return PSA_SUCCESS;
638 }
639 }
640 }
641
642 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100643}
644
Gilles Peskine449bd832023-01-11 14:50:10 +0100645psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
646 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200647{
Gilles Peskine449bd832023-01-11 14:50:10 +0100648 if (slot->key.data != NULL) {
649 return PSA_ERROR_ALREADY_EXISTS;
650 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200651
Gilles Peskine449bd832023-01-11 14:50:10 +0100652 slot->key.data = mbedtls_calloc(1, buffer_length);
653 if (slot->key.data == NULL) {
654 return PSA_ERROR_INSUFFICIENT_MEMORY;
655 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200656
Ronald Cronea0f8a62020-11-25 17:52:23 +0100657 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100658 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200659}
660
Gilles Peskine449bd832023-01-11 14:50:10 +0100661psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
662 const uint8_t *data,
663 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200664{
Gilles Peskine449bd832023-01-11 14:50:10 +0100665 psa_status_t status = psa_allocate_buffer_to_slot(slot,
666 data_length);
667 if (status != PSA_SUCCESS) {
668 return status;
669 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200670
Gilles Peskine449bd832023-01-11 14:50:10 +0100671 memcpy(slot->key.data, data, data_length);
672 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200673}
674
Ronald Crona0fe59f2020-11-29 11:14:53 +0100675psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100676 const psa_key_attributes_t *attributes,
677 const uint8_t *data, size_t data_length,
678 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100680{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100681 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
682 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100683
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200684 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 if (data_length == 0) {
686 return PSA_ERROR_NOT_SUPPORTED;
687 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200688
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 if (key_type_is_raw_bytes(type)) {
690 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200691
Gilles Peskine449bd832023-01-11 14:50:10 +0100692 status = psa_validate_unstructured_key_bit_size(attributes->core.type,
693 *bits);
694 if (status != PSA_SUCCESS) {
695 return status;
696 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200697
Ronald Crondd04d422020-11-28 15:14:42 +0100698 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100700 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200702
Gilles Peskine449bd832023-01-11 14:50:10 +0100703 return PSA_SUCCESS;
704 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +0200705#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200706 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100707 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200708 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100709 return PSA_ERROR_INVALID_ARGUMENT;
710 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200711 return mbedtls_psa_ffdh_import_key(attributes,
712 data, data_length,
713 key_buffer, key_buffer_size,
714 key_buffer_length,
715 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100716 }
Valerio Settia55f0422023-07-10 15:34:41 +0200717#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200718 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti27c501a2023-06-27 16:58:52 +0200719#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100720 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
721 if (PSA_KEY_TYPE_IS_ECC(type)) {
722 return mbedtls_psa_ecp_import_key(attributes,
723 data, data_length,
724 key_buffer, key_buffer_size,
725 key_buffer_length,
726 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100727 }
Valerio Setti27c501a2023-06-27 16:58:52 +0200728#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800729 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settife478902023-07-25 12:27:19 +0200730#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
731 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100732 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
733 if (PSA_KEY_TYPE_IS_RSA(type)) {
734 return mbedtls_psa_rsa_import_key(attributes,
735 data, data_length,
736 key_buffer, key_buffer_size,
737 key_buffer_length,
738 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200739 }
Valerio Settife478902023-07-25 12:27:19 +0200740#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
741 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -0800742 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100743 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100744
Gilles Peskine449bd832023-01-11 14:50:10 +0100745 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100746}
747
Gilles Peskinef603c712019-01-19 13:40:11 +0100748/** Calculate the intersection of two algorithm usage policies.
749 *
750 * Return 0 (which allows no operation) on incompatibility.
751 */
752static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100753 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100754 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100755 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100756{
Gilles Peskine549ea862019-05-22 11:45:59 +0200757 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100758 if (alg1 == alg2) {
759 return alg1;
760 }
Steven Cooreman03488022021-02-18 12:07:20 +0100761 /* If the policies are from the same hash-and-sign family, check
762 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100763 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
764 PSA_ALG_IS_SIGN_HASH(alg2) &&
765 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
766 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
767 return alg2;
768 }
769 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
770 return alg1;
771 }
Steven Cooreman03488022021-02-18 12:07:20 +0100772 }
773 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100774 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100775 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100776 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
777 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
778 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
779 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
780 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100781 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100782
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100783 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100784 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
785 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
786 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
787 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100788 }
789 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
791 (alg1_len <= alg2_len)) {
792 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100793 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100794 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
795 (alg2_len <= alg1_len)) {
796 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100797 }
798 }
799 /* If the policies are from the same MAC family, check whether one
800 * of them is a minimum-MAC-length policy. Calculate the most
801 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100802 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
803 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
804 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100805 /* Validate the combination of key type and algorithm. Since the base
806 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100807 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
808 return 0;
809 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100810
Steven Cooreman31a876d2021-03-03 20:47:40 +0100811 /* Get the (exact or at-least) output lengths for both sides of the
812 * requested intersection. None of the currently supported algorithms
813 * have an output length dependent on the actual key size, so setting it
814 * to a bogus value of 0 is currently OK.
815 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100816 * Note that for at-least-this-length wildcard algorithms, the output
817 * length is set to the shortest allowed length, which allows us to
818 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100819 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
820 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100821 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100822
Steven Cooremana1d83222021-02-25 10:20:29 +0100823 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100824 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
825 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
826 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100827 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100828
829 /* If only one is an at-least-this-length policy, the intersection would
830 * be the other (fixed-length) policy as long as said fixed length is
831 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100832 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
833 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100834 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100835 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
836 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100837 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100838
Steven Cooremancd640932021-03-08 12:00:27 +0100839 /* If none of them are wildcards, check whether they define the same tag
840 * length. This is still possible here when one is default-length and
841 * the other specific-length. Ensure to always return the
842 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100843 if (alg1_len == alg2_len) {
844 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
845 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100846 }
847 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100848 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100849}
850
Gilles Peskine449bd832023-01-11 14:50:10 +0100851static int psa_key_algorithm_permits(psa_key_type_t key_type,
852 psa_algorithm_t policy_alg,
853 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200854{
Gilles Peskine549ea862019-05-22 11:45:59 +0200855 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100856 if (requested_alg == policy_alg) {
857 return 1;
858 }
Steven Cooreman03488022021-02-18 12:07:20 +0100859 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
860 * and requested_alg is the same hash-and-sign family with any hash,
861 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100862 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
863 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
864 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
865 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100866 }
867 /* If policy_alg is a wildcard AEAD algorithm of the same base as
868 * the requested algorithm, check the requested tag length to be
869 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100870 if (PSA_ALG_IS_AEAD(policy_alg) &&
871 PSA_ALG_IS_AEAD(requested_alg) &&
872 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
873 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
874 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
875 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
876 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100877 }
Steven Cooremancd640932021-03-08 12:00:27 +0100878 /* If policy_alg is a MAC algorithm of the same base as the requested
879 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100880 if (PSA_ALG_IS_MAC(policy_alg) &&
881 PSA_ALG_IS_MAC(requested_alg) &&
882 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
883 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100884 /* Validate the combination of key type and algorithm. Since the policy
885 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100886 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
887 return 0;
888 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100889
Steven Cooreman31a876d2021-03-03 20:47:40 +0100890 /* Get both the requested output length for the algorithm which is to be
891 * verified, and the default output length for the base algorithm.
892 * Note that none of the currently supported algorithms have an output
893 * length dependent on actual key size, so setting it to a bogus value
894 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100895 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100896 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100897 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100898 key_type, 0,
899 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100900
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100901 /* If the policy is default-length, only allow an algorithm with
902 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100903 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
904 return requested_output_length == default_output_length;
905 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100906
907 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100908 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100909 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
910 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
911 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100912 }
913
Steven Cooremancd640932021-03-08 12:00:27 +0100914 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
915 * check for the requested MAC length to be equal to or longer than the
916 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100917 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
918 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
919 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100920 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200921 }
Steven Cooremance48e852020-10-05 16:02:45 +0200922 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200923 * a key derivation with that key agreement should also be allowed. This
924 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100925 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
926 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
927 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
928 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +0200929 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100930 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100931 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200932}
933
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100934/** Test whether a policy permits an algorithm.
935 *
936 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100937 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100938 * \note This function requires providing the key type for which the policy is
939 * being validated, since some algorithm policy definitions (e.g. MAC)
940 * have different properties depending on what kind of cipher it is
941 * combined with.
942 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100943 * \retval PSA_SUCCESS When \p alg is a specific algorithm
944 * allowed by the \p policy.
945 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
946 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
947 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100948 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100949static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
950 psa_key_type_t key_type,
951 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100952{
Steven Cooremand788fab2021-02-25 11:29:17 +0100953 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +0100954 if (alg == 0) {
955 return PSA_ERROR_INVALID_ARGUMENT;
956 }
Steven Cooremand788fab2021-02-25 11:29:17 +0100957
Steven Cooreman7e39f052021-02-23 14:18:32 +0100958 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100959 if (PSA_ALG_IS_WILDCARD(alg)) {
960 return PSA_ERROR_INVALID_ARGUMENT;
961 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100962
Gilles Peskine449bd832023-01-11 14:50:10 +0100963 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
964 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
965 return PSA_SUCCESS;
966 } else {
967 return PSA_ERROR_NOT_PERMITTED;
968 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100969}
970
Gilles Peskinef603c712019-01-19 13:40:11 +0100971/** Restrict a key policy based on a constraint.
972 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100973 * \note This function requires providing the key type for which the policy is
974 * being restricted, since some algorithm policy definitions (e.g. MAC)
975 * have different properties depending on what kind of cipher it is
976 * combined with.
977 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100978 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100979 * \param[in,out] policy The policy to restrict.
980 * \param[in] constraint The policy constraint to apply.
981 *
982 * \retval #PSA_SUCCESS
983 * \c *policy contains the intersection of the original value of
984 * \c *policy and \c *constraint.
985 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100986 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100987 * \c *policy is unchanged.
988 */
989static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100990 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100991 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +0100993{
994 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +0100995 psa_key_policy_algorithm_intersection(key_type, policy->alg,
996 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +0200997 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
999 constraint->alg2);
1000 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
1001 return PSA_ERROR_INVALID_ARGUMENT;
1002 }
1003 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
1004 return PSA_ERROR_INVALID_ARGUMENT;
1005 }
Gilles Peskinef603c712019-01-19 13:40:11 +01001006 policy->usage &= constraint->usage;
1007 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001008 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001009 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +01001010}
1011
Przemek Stekiel061f6942022-11-30 10:51:35 +01001012/** Get the description of a key given its identifier and policy constraints
1013 * and lock it.
1014 *
1015 * The key must have allow all the usage flags set in \p usage. If \p alg is
1016 * nonzero, the key must allow operations with this algorithm. If \p alg is
1017 * zero, the algorithm is not checked.
1018 *
1019 * In case of a persistent key, the function loads the description of the key
1020 * into a key slot if not already done.
1021 *
Ryan Everett098c6652024-01-03 13:03:36 +00001022 * On success, the returned key slot has been registered for reading.
1023 * It is the responsibility of the caller to call psa_unregister_read(slot)
1024 * when they have finished reading the contents of the slot.
Przemek Stekiel061f6942022-11-30 10:51:35 +01001025 */
1026static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01001027 mbedtls_svc_key_id_t key,
1028 psa_key_slot_t **p_slot,
1029 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001030 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +01001031{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001032 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01001033 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001034
Gilles Peskine449bd832023-01-11 14:50:10 +01001035 status = psa_get_and_lock_key_slot(key, p_slot);
1036 if (status != PSA_SUCCESS) {
1037 return status;
1038 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001039 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001040
1041 /* Enforce that usage policy for the key slot contains all the flags
1042 * required by the usage parameter. There is one exception: public
1043 * keys can always be exported, so we treat public key objects as
1044 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001045 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +01001046 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001048
Gilles Peskine449bd832023-01-11 14:50:10 +01001049 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +01001050 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001051 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001052 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001053
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001054 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 if (alg != 0) {
1056 status = psa_key_policy_permits(&slot->attr.policy,
1057 slot->attr.type,
1058 alg);
1059 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +01001060 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001062 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001063
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001065
1066error:
1067 *p_slot = NULL;
Ryan Everett098c6652024-01-03 13:03:36 +00001068 psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001069
Gilles Peskine449bd832023-01-11 14:50:10 +01001070 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +01001071}
Darryl Green940d72c2018-07-13 13:18:51 +01001072
Ronald Cron5c522922020-11-14 16:35:34 +01001073/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001074 *
1075 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +02001076 * available, as opposed to a key in a secure element and/or to be used
1077 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001078 *
Ronald Cronddae0f52021-08-24 15:39:44 +02001079 * This is a temporary function that may be used instead of
1080 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
1081 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001082 *
Ryan Everett098c6652024-01-03 13:03:36 +00001083 * On success, the returned key slot has been registered for reading.
1084 * It is the responsibility of the caller to call psa_unregister_read(slot)
1085 * when they have finished reading the contents of the slot.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001086 */
Ronald Cron5c522922020-11-14 16:35:34 +01001087static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1088 mbedtls_svc_key_id_t key,
1089 psa_key_slot_t **p_slot,
1090 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +02001092{
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
1094 usage, alg);
1095 if (status != PSA_SUCCESS) {
1096 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001097 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001098
Gilles Peskine449bd832023-01-11 14:50:10 +01001099 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
Ryan Everett098c6652024-01-03 13:03:36 +00001100 psa_unregister_read(*p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 *p_slot = NULL;
1102 return PSA_ERROR_NOT_SUPPORTED;
1103 }
1104
1105 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001106}
Gilles Peskine28f8f302019-07-24 13:30:31 +02001107
Gilles Peskine449bd832023-01-11 14:50:10 +01001108psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +00001109{
Gilles Peskine449bd832023-01-11 14:50:10 +01001110 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +01001111 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001113
Ronald Cronea0f8a62020-11-25 17:52:23 +01001114 slot->key.data = NULL;
1115 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001116
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001118}
1119
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001120/** Completely wipe a slot in memory, including its policy.
1121 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001122psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001123{
Gilles Peskine449bd832023-01-11 14:50:10 +01001124 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001125
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 /*
1127 * As the return error code may not be handled in case of multiple errors,
Ryan Everett7ed542e2024-01-17 11:39:09 +00001128 * do our best to report an unexpected amount of registered readers or
1129 * an unexpected state.
1130 * Assert with MBEDTLS_TEST_HOOK_TEST_ASSERT that the slot is valid for
1131 * wiping.
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1133 * function is called as part of the execution of a test suite, the
1134 * execution of the test suite is stopped in error if the assertion fails.
1135 */
Ryan Everett7ed542e2024-01-17 11:39:09 +00001136 switch (slot->state) {
1137 case PSA_SLOT_FULL:
1138 /* In this state psa_wipe_key_slot() must only be called if the
1139 * caller is the last reader. */
1140 case PSA_SLOT_PENDING_DELETION:
1141 /* In this state psa_wipe_key_slot() must only be called if the
1142 * caller is the last reader. */
1143 if (slot->registered_readers != 1) {
1144 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 1);
1145 status = PSA_ERROR_CORRUPTION_DETECTED;
1146 }
1147 break;
1148 case PSA_SLOT_FILLING:
1149 /* In this state registered_readers must be 0. */
1150 if (slot->registered_readers != 0) {
1151 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 0);
1152 status = PSA_ERROR_CORRUPTION_DETECTED;
1153 }
1154 break;
1155 case PSA_SLOT_EMPTY:
1156 /* The slot is already empty, it cannot be wiped. */
1157 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->state != PSA_SLOT_EMPTY);
1158 status = PSA_ERROR_CORRUPTION_DETECTED;
1159 break;
1160 default:
1161 /* The slot's state is invalid. */
1162 status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronddd3d052020-10-30 14:07:07 +01001163 }
1164
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001165 /* Multipart operations may still be using the key. This is safe
1166 * because all multipart operation objects are independent from
1167 * the key slot: if they need to access the key after the setup
1168 * phase, they have a copy of the key. Note that this means that
1169 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001170 /* At this point, key material and other type-specific content has
1171 * been wiped. Clear remaining metadata. We can call memset and not
Ryan Everettaa33c512023-12-21 17:32:07 +00001172 * zeroize because the metadata is not particularly sensitive.
1173 * This memset also sets the slot's state to PSA_SLOT_EMPTY. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001174 memset(slot, 0, sizeof(*slot));
1175 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001176}
1177
Gilles Peskine449bd832023-01-11 14:50:10 +01001178psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001179{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001180 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001181 psa_status_t status; /* status of the last operation */
1182 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001183#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1184 psa_se_drv_table_entry_t *driver;
1185#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001186
Gilles Peskine449bd832023-01-11 14:50:10 +01001187 if (mbedtls_svc_key_id_is_null(key)) {
1188 return PSA_SUCCESS;
1189 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001190
Ronald Cronf2911112020-10-29 17:51:10 +01001191 /*
Ryan Everett7ed542e2024-01-17 11:39:09 +00001192 * Get the description of the key in a key slot, and register to read it.
1193 * In the case of a persistent key, this will load the key description
1194 * from persistent memory if not done yet.
1195 * We cannot avoid this loading as without it we don't know if
Ronald Cronf2911112020-10-29 17:51:10 +01001196 * the key is operated by an SE or not and this information is needed by
Ryan Everett7ed542e2024-01-17 11:39:09 +00001197 * the current implementation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001198 status = psa_get_and_lock_key_slot(key, &slot);
1199 if (status != PSA_SUCCESS) {
1200 return status;
1201 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001202
Ryan Everett7ed542e2024-01-17 11:39:09 +00001203 /* Set the key slot containing the key description's state to
1204 * PENDING_DELETION. This stops new operations from registering
1205 * to read the slot. Current readers can safely continue to access
1206 * the key within the slot; the last registered reader will
1207 * automatically wipe the slot when they call psa_unregister_read().
1208 * If the key is persistent, we can now delete the copy of the key
1209 * from memory. If the key is opaque, we require the driver to
1210 * deal with the deletion. */
Ryan Everettc70ce572024-01-03 16:04:33 +00001211 slot->state = PSA_SLOT_PENDING_DELETION;
Ronald Cronf2911112020-10-29 17:51:10 +01001212
Gilles Peskine449bd832023-01-11 14:50:10 +01001213 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001214 /* Refuse the destruction of a read-only key (which may or may not work
1215 * if we attempt it, depending on whether the key is merely read-only
1216 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001217 * Just do the best we can, which is to wipe the copy in memory
1218 * (done in this function's cleanup code). */
1219 overall_status = PSA_ERROR_NOT_PERMITTED;
1220 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001221 }
1222
Gilles Peskine354f7672019-07-12 23:46:38 +02001223#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001224 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1225 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001226 /* For a key in a secure element, we need to do three things:
1227 * remove the key file in internal storage, destroy the
1228 * key inside the secure element, and update the driver's
1229 * persistent data. Start a transaction that will encompass these
1230 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001231 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001232 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001233 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001234 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001235 status = psa_crypto_save_transaction();
1236 if (status != PSA_SUCCESS) {
1237 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001238 /* We should still try to destroy the key in the secure
1239 * element and the key metadata in storage. This is especially
1240 * important if the error is that the storage is full.
1241 * But how to do it exactly without risking an inconsistent
1242 * state after a reset?
1243 * https://github.com/ARMmbed/mbed-crypto/issues/215
1244 */
1245 overall_status = status;
1246 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001247 }
1248
Gilles Peskine449bd832023-01-11 14:50:10 +01001249 status = psa_destroy_se_key(driver,
1250 psa_key_slot_get_slot_number(slot));
1251 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001252 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001253 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001254 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001255#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1256
Darryl Greend49a4992018-06-18 17:27:26 +01001257#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001258 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ryan Everett4a0ba802024-01-17 14:12:33 +00001259 /* Destroy the copy of the persistent key from storage.
Ryan Everett7ed542e2024-01-17 11:39:09 +00001260 * The slot will still hold a copy of the key until the last reader
1261 * unregisters. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001262 status = psa_destroy_persistent_key(slot->attr.id);
1263 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001264 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001265 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001266
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001267 /* TODO: other slots may have a copy of the same key. We should
1268 * invalidate them.
1269 * https://github.com/ARMmbed/mbed-crypto/issues/214
1270 */
Darryl Greend49a4992018-06-18 17:27:26 +01001271 }
1272#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001273
Gilles Peskinefc762652019-07-22 19:30:34 +02001274#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001275 if (driver != NULL) {
1276 status = psa_save_se_persistent_data(driver);
1277 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001278 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001279 }
1280 status = psa_crypto_stop_transaction();
1281 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001282 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001283 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001284 }
1285#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1286
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001287exit:
Ryan Everett7ed542e2024-01-17 11:39:09 +00001288 /* Unregister from reading the slot. If we are the last active reader
1289 * then this will wipe the slot. */
1290 status = psa_unregister_read(slot);
1291 /* Prioritize CORRUPTION_DETECTED from unregistering over
1292 * a storage error. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001293 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001294 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001295 }
1296 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001297}
1298
Valerio Settib2bcedb2023-07-10 11:24:00 +02001299#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001300 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001301static psa_status_t psa_get_rsa_public_exponent(
1302 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001303 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001304{
1305 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001306 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001307 uint8_t *buffer = NULL;
1308 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001309 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001310
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1312 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001313 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001314 }
1315 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001316 /* It's the default value, which is reported as an empty string,
1317 * so there's nothing to do. */
1318 goto exit;
1319 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001320
Gilles Peskine449bd832023-01-11 14:50:10 +01001321 buflen = mbedtls_mpi_size(&mpi);
1322 buffer = mbedtls_calloc(1, buflen);
1323 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001324 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1325 goto exit;
1326 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001327 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1328 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001329 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001331 attributes->domain_parameters = buffer;
1332 attributes->domain_parameters_size = buflen;
1333
1334exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 mbedtls_mpi_free(&mpi);
1336 if (ret != 0) {
1337 mbedtls_free(buffer);
1338 }
1339 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001340}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001341#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001342 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001343
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001344/** Retrieve all the publicly-accessible attributes of a key.
1345 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001346psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1347 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001348{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001349 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001350 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001351 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001352
Gilles Peskine449bd832023-01-11 14:50:10 +01001353 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001354
Gilles Peskine449bd832023-01-11 14:50:10 +01001355 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1356 if (status != PSA_SUCCESS) {
1357 return status;
1358 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001359
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001360 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001361 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1362 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001363
1364#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001365 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1366 psa_set_key_slot_number(attributes,
1367 psa_key_slot_get_slot_number(slot));
1368 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001369#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001370
Gilles Peskine449bd832023-01-11 14:50:10 +01001371 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001372#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1373 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001374 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001375 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001376 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Pengyu Lvf75893b2023-12-08 17:21:39 +08001377 /* TODO: This is a temporary situation where domain parameters are deprecated,
1378 * but we need it for namely generating an RSA key with a non-default exponent.
1379 * This would be improved after https://github.com/Mbed-TLS/mbedtls/issues/6494.
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001380 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001381 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001382 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001383
Ronald Cron90857082020-11-25 14:58:33 +01001384 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001385 slot->attr.type,
1386 slot->key.data,
1387 slot->key.bytes,
1388 &rsa);
1389 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001390 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001391 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001392
Gilles Peskine449bd832023-01-11 14:50:10 +01001393 status = psa_get_rsa_public_exponent(rsa,
1394 attributes);
1395 mbedtls_rsa_free(rsa);
1396 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001397 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001398 break;
Pengyu Lve9efbc22023-12-08 16:59:08 +08001399#else
1400 case PSA_KEY_TYPE_RSA_KEY_PAIR:
1401 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
1402 attributes->domain_parameters = NULL;
1403 attributes->domain_parameters_size = SIZE_MAX;
1404 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001405#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1406 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001407 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001408 default:
1409 /* Nothing else to do. */
1410 break;
1411 }
1412
Gilles Peskine449bd832023-01-11 14:50:10 +01001413 if (status != PSA_SUCCESS) {
1414 psa_reset_key_attributes(attributes);
1415 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001416
Ryan Everett1b70a072024-01-04 10:32:49 +00001417 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001418
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001420}
1421
Gilles Peskinec8000c02019-08-02 20:15:51 +02001422#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1423psa_status_t psa_get_key_slot_number(
1424 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001426{
Gilles Peskine449bd832023-01-11 14:50:10 +01001427 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001428 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001429 return PSA_SUCCESS;
1430 } else {
1431 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001432 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001433}
1434#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1435
Gilles Peskine449bd832023-01-11 14:50:10 +01001436static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1437 size_t key_buffer_size,
1438 uint8_t *data,
1439 size_t data_size,
1440 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001441{
Gilles Peskine449bd832023-01-11 14:50:10 +01001442 if (key_buffer_size > data_size) {
1443 return PSA_ERROR_BUFFER_TOO_SMALL;
1444 }
1445 memcpy(data, key_buffer, key_buffer_size);
1446 memset(data + key_buffer_size, 0,
1447 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001448 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001449 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001450}
1451
Ronald Cron7285cda2020-11-26 14:46:37 +01001452psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001453 const psa_key_attributes_t *attributes,
1454 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001455 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001456{
Ronald Crond18b5f82020-11-25 16:46:05 +01001457 psa_key_type_t type = attributes->core.type;
1458
Gilles Peskine449bd832023-01-11 14:50:10 +01001459 if (key_type_is_raw_bytes(type) ||
1460 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001461 PSA_KEY_TYPE_IS_ECC(type) ||
1462 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001463 return psa_export_key_buffer_internal(
1464 key_buffer, key_buffer_size,
1465 data, data_size, data_length);
1466 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001467 /* This shouldn't happen in the reference implementation, but
1468 it is valid for a special-purpose implementation to omit
1469 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001470 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001471 }
1472}
1473
Gilles Peskine449bd832023-01-11 14:50:10 +01001474psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
Ryan Everett45ac5262024-01-08 17:15:19 +00001475 uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01001476 size_t data_size,
1477 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001478{
1479 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1480 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1481 psa_key_slot_t *slot;
Ryan Everett45ac5262024-01-08 17:15:19 +00001482 LOCAL_OUTPUT_DECLARE(data_external, data);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001483
Ronald Crone907e552021-01-18 13:22:38 +01001484 /* Reject a zero-length output buffer now, since this can never be a
1485 * valid key representation. This way we know that data must be a valid
1486 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001487 if (data_size == 0) {
1488 return PSA_ERROR_BUFFER_TOO_SMALL;
1489 }
Ronald Crone907e552021-01-18 13:22:38 +01001490
Ronald Cron9486f9d2020-11-26 13:36:23 +01001491 /* Set the key to empty now, so that even when there are errors, we always
1492 * set data_length to a value between 0 and data_size. On error, setting
1493 * the key to empty is a good choice because an empty key representation is
1494 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001495 *data_length = 0;
1496
Ronald Cron9486f9d2020-11-26 13:36:23 +01001497 /* Export requires the EXPORT flag. There is an exception for public keys,
1498 * which don't require any flag, but
1499 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1500 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001501 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1502 PSA_KEY_USAGE_EXPORT, 0);
1503 if (status != PSA_SUCCESS) {
1504 return status;
1505 }
mohammad160306e79202018-03-28 13:17:44 +03001506
Ryan Everett45ac5262024-01-08 17:15:19 +00001507 LOCAL_OUTPUT_ALLOC(data_external, data_size, data);
1508
Ronald Crond18b5f82020-11-25 16:46:05 +01001509 psa_key_attributes_t attributes = {
1510 .core = slot->attr
1511 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001512 status = psa_driver_wrapper_export_key(&attributes,
1513 slot->key.data, slot->key.bytes,
1514 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001515
Ryan Everett35f68532024-01-25 12:02:03 +00001516#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Ryan Everett45ac5262024-01-08 17:15:19 +00001517exit:
Ryan Everett35f68532024-01-25 12:02:03 +00001518#endif
Ryan Everett1b70a072024-01-04 10:32:49 +00001519 unlock_status = psa_unregister_read(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001520
Ryan Everett45ac5262024-01-08 17:15:19 +00001521 LOCAL_OUTPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001523}
1524
Ronald Cron7285cda2020-11-26 14:46:37 +01001525psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001526 const psa_key_attributes_t *attributes,
1527 const uint8_t *key_buffer,
1528 size_t key_buffer_size,
1529 uint8_t *data,
1530 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001531 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001532{
Ronald Crond18b5f82020-11-25 16:46:05 +01001533 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001534
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001535 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001536 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1537 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001538 /* Exporting public -> public */
1539 return psa_export_key_buffer_internal(
1540 key_buffer, key_buffer_size,
1541 data, data_size, data_length);
1542 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001543#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001544 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1545 return mbedtls_psa_rsa_export_public_key(attributes,
1546 key_buffer,
1547 key_buffer_size,
1548 data,
1549 data_size,
1550 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001551#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001552 /* We don't know how to convert a private RSA key to public. */
1553 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001554#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001555 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001556 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001557#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001558 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1559 return mbedtls_psa_ecp_export_public_key(attributes,
1560 key_buffer,
1561 key_buffer_size,
1562 data,
1563 data_size,
1564 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001565#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001566 /* We don't know how to convert a private ECC key to public */
1567 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001568#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001569 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001570 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001571#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001572 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001573 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001574 key_buffer,
1575 key_buffer_size,
1576 data, data_size,
1577 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001578#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001579 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001580#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001581 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001582 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001583 (void) key_buffer;
1584 (void) key_buffer_size;
1585 (void) data;
1586 (void) data_size;
1587 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001588 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001589 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001590}
Ronald Crond18b5f82020-11-25 16:46:05 +01001591
Gilles Peskine449bd832023-01-11 14:50:10 +01001592psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
Ryan Everettb1d2c672024-01-08 17:19:30 +00001593 uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01001594 size_t data_size,
1595 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001596{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001597 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001598 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001599 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001600 psa_key_attributes_t attributes;
Ryan Everettb1d2c672024-01-08 17:19:30 +00001601 LOCAL_OUTPUT_DECLARE(data_external, data);
Darryl Greendd8fb772018-11-07 16:00:44 +00001602
Ronald Crone907e552021-01-18 13:22:38 +01001603 /* Reject a zero-length output buffer now, since this can never be a
1604 * valid key representation. This way we know that data must be a valid
1605 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001606 if (data_size == 0) {
1607 return PSA_ERROR_BUFFER_TOO_SMALL;
1608 }
Ronald Crone907e552021-01-18 13:22:38 +01001609
Darryl Greendd8fb772018-11-07 16:00:44 +00001610 /* Set the key to empty now, so that even when there are errors, we always
1611 * set data_length to a value between 0 and data_size. On error, setting
1612 * the key to empty is a good choice because an empty key representation is
1613 * unlikely to be accepted anywhere. */
1614 *data_length = 0;
1615
1616 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001617 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1618 if (status != PSA_SUCCESS) {
1619 return status;
1620 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001621
Ryan Everettb1d2c672024-01-08 17:19:30 +00001622 LOCAL_OUTPUT_ALLOC(data_external, data_size, data);
1623
Gilles Peskine449bd832023-01-11 14:50:10 +01001624 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1625 status = PSA_ERROR_INVALID_ARGUMENT;
1626 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001627 }
1628
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001629 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001630 .core = slot->attr
1631 };
Ronald Cron67227982020-11-26 15:16:05 +01001632 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001633 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001634 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001635
1636exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00001637 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001638
Ryan Everettb1d2c672024-01-08 17:19:30 +00001639 LOCAL_OUTPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01001640 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001641}
1642
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001643MBEDTLS_STATIC_ASSERT(
1644 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1645 "One or more key attribute flag is listed as both external-only and dual-use")
1646MBEDTLS_STATIC_ASSERT(
1647 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1648 "One or more key attribute flag is listed as both internal-only and dual-use")
1649MBEDTLS_STATIC_ASSERT(
1650 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1651 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001652
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001653/** Validate that a key policy is internally well-formed.
1654 *
1655 * This function only rejects invalid policies. It does not validate the
1656 * consistency of the policy with respect to other attributes of the key
1657 * such as the key type.
1658 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001659static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001660{
Gilles Peskine449bd832023-01-11 14:50:10 +01001661 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1662 PSA_KEY_USAGE_COPY |
1663 PSA_KEY_USAGE_ENCRYPT |
1664 PSA_KEY_USAGE_DECRYPT |
1665 PSA_KEY_USAGE_SIGN_MESSAGE |
1666 PSA_KEY_USAGE_VERIFY_MESSAGE |
1667 PSA_KEY_USAGE_SIGN_HASH |
1668 PSA_KEY_USAGE_VERIFY_HASH |
1669 PSA_KEY_USAGE_VERIFY_DERIVATION |
1670 PSA_KEY_USAGE_DERIVE)) != 0) {
1671 return PSA_ERROR_INVALID_ARGUMENT;
1672 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001673
Gilles Peskine449bd832023-01-11 14:50:10 +01001674 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001675}
1676
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001677/** Validate the internal consistency of key attributes.
1678 *
1679 * This function only rejects invalid attribute values. If does not
1680 * validate the consistency of the attributes with any key data that may
1681 * be involved in the creation of the key.
1682 *
1683 * Call this function early in the key creation process.
1684 *
1685 * \param[in] attributes Key attributes for the new key.
1686 * \param[out] p_drv On any return, the driver for the key, if any.
1687 * NULL for a transparent key.
1688 *
1689 */
1690static psa_status_t psa_validate_key_attributes(
1691 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001692 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001693{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001694 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001695 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1696 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001697
Gilles Peskine449bd832023-01-11 14:50:10 +01001698 status = psa_validate_key_location(lifetime, p_drv);
1699 if (status != PSA_SUCCESS) {
1700 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001701 }
1702
Gilles Peskine449bd832023-01-11 14:50:10 +01001703 status = psa_validate_key_persistence(lifetime);
1704 if (status != PSA_SUCCESS) {
1705 return status;
1706 }
1707
1708 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1709 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1710 return PSA_ERROR_INVALID_ARGUMENT;
1711 }
1712 } else {
1713 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1714 return PSA_ERROR_INVALID_ARGUMENT;
1715 }
1716 }
1717
1718 status = psa_validate_key_policy(&attributes->core.policy);
1719 if (status != PSA_SUCCESS) {
1720 return status;
1721 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001722
1723 /* Refuse to create overly large keys.
1724 * Note that this doesn't trigger on import if the attributes don't
1725 * explicitly specify a size (so psa_get_key_bits returns 0), so
1726 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1728 return PSA_ERROR_NOT_SUPPORTED;
1729 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001730
Gilles Peskine91e8c332019-08-02 19:19:39 +02001731 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001732 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1733 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1734 return PSA_ERROR_INVALID_ARGUMENT;
1735 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001736
Gilles Peskine449bd832023-01-11 14:50:10 +01001737 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001738}
1739
Gilles Peskine4747d192019-04-17 15:05:45 +02001740/** Prepare a key slot to receive key material.
1741 *
1742 * This function allocates a key slot and sets its metadata.
1743 *
1744 * If this function fails, call psa_fail_key_creation().
1745 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001746 * This function is intended to be used as follows:
1747 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001748 * it with the specified attributes, and in case of a volatile key assign it
1749 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001750 * -# Populate the slot with the key material.
1751 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1752 * In case of failure at any step, stop the sequence and call
1753 * psa_fail_key_creation().
1754 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001755 * On success, the key slot's state is PSA_SLOT_FILLING.
1756 * It is the responsibility of the caller to change the slot's state to
1757 * PSA_SLOT_EMPTY/FULL once key creation has finished.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001758 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001759 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001760 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001761 * \param[out] p_slot On success, a pointer to the prepared slot.
1762 * \param[out] p_drv On any return, the driver for the key, if any.
1763 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001764 *
1765 * \retval #PSA_SUCCESS
1766 * The key slot is ready to receive key material.
1767 * \return If this function fails, the key slot is an invalid state.
1768 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001769 */
1770static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001771 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001772 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001773 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001774 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001775{
1776 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001777 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001778 psa_key_slot_t *slot;
1779
Gilles Peskinedf179142019-07-15 22:02:14 +02001780 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001781 *p_drv = NULL;
1782
Gilles Peskine449bd832023-01-11 14:50:10 +01001783 status = psa_validate_key_attributes(attributes, p_drv);
1784 if (status != PSA_SUCCESS) {
1785 return status;
1786 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001787
Ryan Everettb69118e2024-01-02 15:54:32 +00001788 status = psa_reserve_free_key_slot(&volatile_key_id, p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001789 if (status != PSA_SUCCESS) {
1790 return status;
1791 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001792 slot = *p_slot;
1793
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001794 /* We're storing the declared bit-size of the key. It's up to each
1795 * creation mechanism to verify that this information is correct.
1796 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001797 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001798 * is optional (import, copy). In case of a volatile key, assign it the
1799 * volatile key identifier associated to the slot returned to contain its
1800 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001801
1802 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001803 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001804#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1805 slot->attr.id = volatile_key_id;
1806#else
1807 slot->attr.id.key_id = volatile_key_id;
1808#endif
1809 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001810
Gilles Peskine91e8c332019-08-02 19:19:39 +02001811 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001812 * external-only flags, query `attributes`. Thanks to the check
1813 * in psa_validate_key_attributes(), this leaves the dual-use
Ryan Everettb69118e2024-01-02 15:54:32 +00001814 * flags and any internal flag that psa_reserve_free_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001815 * may have set. */
1816 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001817
Gilles Peskinecbaff462019-07-12 23:46:04 +02001818#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001819 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001820 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001821 * create the key file in internal storage, create the
1822 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001823 * persistent data. This is done by starting a transaction that will
1824 * encompass these three actions.
1825 * For registering a volatile key, we just need to find an appropriate
1826 * slot number inside the SE. Since the key is designated volatile, creating
1827 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001828 /* The first thing to do is to find a slot number for the new key.
1829 * We save the slot number in persistent storage as part of the
1830 * transaction data. It will be needed to recover if the power
1831 * fails during the key creation process, to clean up on the secure
1832 * element side after restarting. Obtaining a slot number from the
1833 * secure element driver updates its persistent state, but we do not yet
1834 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001835 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001836 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001837 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1839 &slot_number);
1840 if (status != PSA_SUCCESS) {
1841 return status;
1842 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001843
Gilles Peskine449bd832023-01-11 14:50:10 +01001844 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1845 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001846 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001847 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001848 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 status = psa_crypto_save_transaction();
1850 if (status != PSA_SUCCESS) {
1851 (void) psa_crypto_stop_transaction();
1852 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001853 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001854 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001855
1856 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001858 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001859
Gilles Peskine449bd832023-01-11 14:50:10 +01001860 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001861 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001863 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001864#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1865
Gilles Peskine449bd832023-01-11 14:50:10 +01001866 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001867}
Gilles Peskine4747d192019-04-17 15:05:45 +02001868
1869/** Finalize the creation of a key once its key material has been set.
1870 *
1871 * This entails writing the key to persistent storage.
1872 *
1873 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001874 * See the documentation of psa_start_key_creation() for the intended use
1875 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001876 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001877 * If the finalization succeeds, the function sets the key slot's state to
1878 * PSA_SLOT_FULL, and the key slot can no longer be accessed as part of the
1879 * key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001880 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001881 * \param[in,out] slot Pointer to the slot with key material.
1882 * \param[in] driver The secure element driver for the key,
1883 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001884 * \param[out] key On success, identifier of the key. Note that the
1885 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001886 *
1887 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001888 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001889 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1890 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1891 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1892 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1893 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1894 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001895 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001896 * \return If this function fails, the key slot is an invalid state.
1897 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001898 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001899static psa_status_t psa_finish_key_creation(
1900 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001901 psa_se_drv_table_entry_t *driver,
1902 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001903{
1904 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001905 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001906 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001907
1908#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001909 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001910#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001911 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001912 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001913 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001914 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001915
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001916 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1917 sizeof(data.slot_number),
1918 "Slot number size does not match psa_se_key_data_storage_t");
1919
Gilles Peskine449bd832023-01-11 14:50:10 +01001920 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1921 status = psa_save_persistent_key(&slot->attr,
1922 (uint8_t *) &data,
1923 sizeof(data));
1924 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001925#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1926 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001927 /* Key material is saved in export representation in the slot, so
1928 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001929 status = psa_save_persistent_key(&slot->attr,
1930 slot->key.data,
1931 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001932 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001933 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001934#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1935
Gilles Peskinecbaff462019-07-12 23:46:04 +02001936#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001937 /* Finish the transaction for a key creation. This does not
1938 * happen when registering an existing key. Detect this case
1939 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001940 * creation of a persistent key in a secure element requires a transaction,
1941 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001942 if (driver != NULL &&
1943 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1944 status = psa_save_se_persistent_data(driver);
1945 if (status != PSA_SUCCESS) {
1946 psa_destroy_persistent_key(slot->attr.id);
1947 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001948 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001949 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001950 }
1951#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1952
Gilles Peskine449bd832023-01-11 14:50:10 +01001953 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001954 *key = slot->attr.id;
Ryan Everettb69118e2024-01-02 15:54:32 +00001955 status = psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1956 PSA_SLOT_FULL);
Gilles Peskine449bd832023-01-11 14:50:10 +01001957 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001958 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001960 }
Ronald Cron50972942020-11-14 11:28:25 +01001961
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001963}
1964
1965/** Abort the creation of a key.
1966 *
1967 * You may call this function after calling psa_start_key_creation(),
1968 * or after psa_finish_key_creation() fails. In other circumstances, this
1969 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001970 * See the documentation of psa_start_key_creation() for the intended use
Ryan Everettb69118e2024-01-02 15:54:32 +00001971 * of this function. Sets the slot's state to PSA_SLOT_EMPTY.
Gilles Peskine4747d192019-04-17 15:05:45 +02001972 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001973 * \param[in,out] slot Pointer to the slot with key material.
1974 * \param[in] driver The secure element driver for the key,
1975 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001976 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001977static void psa_fail_key_creation(psa_key_slot_t *slot,
1978 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001979{
Gilles Peskine011e4282019-06-26 18:34:38 +02001980 (void) driver;
1981
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001983 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001985
1986#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001987 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001988 * element, and the failure happened later (when saving metadata
1989 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001990 * element.
1991 * https://github.com/ARMmbed/mbed-crypto/issues/217
1992 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001993
Gilles Peskined7729582019-08-05 15:55:54 +02001994 /* Abort the ongoing transaction if any (there may not be one if
1995 * the creation process failed before starting one, or if the
1996 * key creation is a registration of a key in a secure element).
1997 * Earlier functions must already have done what it takes to undo any
1998 * partial creation. All that's left is to update the transaction data
1999 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02002001#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2002
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02002004}
2005
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002006/** Validate optional attributes during key creation.
2007 *
2008 * Some key attributes are optional during key creation. If they are
2009 * specified in the attributes structure, check that they are consistent
2010 * with the data in the slot.
2011 *
2012 * This function should be called near the end of key creation, after
2013 * the slot in memory is fully populated but before saving persistent data.
2014 */
2015static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002016 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002018{
Gilles Peskine449bd832023-01-11 14:50:10 +01002019 if (attributes->core.type != 0) {
2020 if (attributes->core.type != slot->attr.type) {
2021 return PSA_ERROR_INVALID_ARGUMENT;
2022 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002023 }
2024
Gilles Peskine449bd832023-01-11 14:50:10 +01002025 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02002026#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
2027 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002028 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
2029 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02002030 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002031 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002032 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002033
Ronald Cron90857082020-11-25 14:58:33 +01002034 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 slot->attr.type,
2036 slot->key.data,
2037 slot->key.bytes,
2038 &rsa);
2039 if (status != PSA_SUCCESS) {
2040 return status;
2041 }
Steven Cooreman75b74362020-07-28 14:30:13 +02002042
Gilles Peskine449bd832023-01-11 14:50:10 +01002043 mbedtls_mpi_init(&actual);
2044 mbedtls_mpi_init(&required);
2045 ret = mbedtls_rsa_export(rsa,
2046 NULL, NULL, NULL, NULL, &actual);
2047 mbedtls_rsa_free(rsa);
2048 mbedtls_free(rsa);
2049 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002050 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 }
2052 ret = mbedtls_mpi_read_binary(&required,
2053 attributes->domain_parameters,
2054 attributes->domain_parameters_size);
2055 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002056 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002057 }
2058 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002059 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01002060 }
2061rsa_exit:
2062 mbedtls_mpi_free(&actual);
2063 mbedtls_mpi_free(&required);
2064 if (ret != 0) {
2065 return mbedtls_to_psa_error(ret);
2066 }
2067 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02002068#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
2069 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08002070 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002071 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002073 }
2074 }
2075
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 if (attributes->core.bits != 0) {
2077 if (attributes->core.bits != slot->attr.bits) {
2078 return PSA_ERROR_INVALID_ARGUMENT;
2079 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002080 }
2081
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002083}
2084
Gilles Peskine449bd832023-01-11 14:50:10 +01002085psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
Ryan Everettf028fe12024-01-08 17:14:44 +00002086 const uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002087 size_t data_length,
2088 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002089{
2090 psa_status_t status;
Ryan Everettf028fe12024-01-08 17:14:44 +00002091 LOCAL_INPUT_DECLARE(data_external, data);
Gilles Peskine4747d192019-04-17 15:05:45 +02002092 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002093 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002094 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302095 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002096
Ronald Cron81709fc2020-11-14 12:10:32 +01002097 *key = MBEDTLS_SVC_KEY_ID_INIT;
2098
Gilles Peskine0f84d622019-09-12 19:03:13 +02002099 /* Reject zero-length symmetric keys (including raw data key objects).
2100 * This also rejects any key which might be encoded as an empty string,
2101 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002102 if (data_length == 0) {
2103 return PSA_ERROR_INVALID_ARGUMENT;
2104 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002105
Archana449608b2021-09-08 15:36:05 +05302106 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002107 if (data_length > SIZE_MAX / 8) {
2108 return PSA_ERROR_NOT_SUPPORTED;
2109 }
Archana6ed4bda2021-08-04 10:47:15 +05302110
Ryan Everettf028fe12024-01-08 17:14:44 +00002111 LOCAL_INPUT_ALLOC(data_external, data_length, data);
2112
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2114 &slot, &driver);
2115 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002116 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002118
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002119 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302120 * storage ( thus not in the case of importing a key in a secure element
2121 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2122 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 if (slot->key.data == NULL) {
2124 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302125 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 attributes, data, data_length, &storage_size);
2127 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302128 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 }
Archanad8a83dc2021-06-14 10:04:16 +05302130 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 status = psa_allocate_buffer_to_slot(slot, storage_size);
2132 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002133 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002135 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002136
2137 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002138 status = psa_driver_wrapper_import_key(attributes,
2139 data, data_length,
2140 slot->key.data,
2141 slot->key.bytes,
2142 &slot->key.bytes, &bits);
2143 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002144 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002145 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002146
Gilles Peskine449bd832023-01-11 14:50:10 +01002147 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002148 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002150 status = PSA_ERROR_INVALID_ARGUMENT;
2151 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002152 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002153
Archana6ed4bda2021-08-04 10:47:15 +05302154 /* Enforce a size limit, and in particular ensure that the bit
2155 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302157 status = PSA_ERROR_NOT_SUPPORTED;
2158 goto exit;
2159 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002160 status = psa_validate_optional_attributes(slot, attributes);
2161 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002162 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002164
Gilles Peskine449bd832023-01-11 14:50:10 +01002165 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002166exit:
Ryan Everettf028fe12024-01-08 17:14:44 +00002167 LOCAL_INPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01002168 if (status != PSA_SUCCESS) {
2169 psa_fail_key_creation(slot, driver);
2170 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002171
Gilles Peskine449bd832023-01-11 14:50:10 +01002172 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002173}
2174
Gilles Peskined7729582019-08-05 15:55:54 +02002175#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2176psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002178{
2179 psa_status_t status;
2180 psa_key_slot_t *slot = NULL;
2181 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002182 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002183
2184 /* Leaving attributes unspecified is not currently supported.
2185 * It could make sense to query the key type and size from the
2186 * secure element, but not all secure elements support this
2187 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2189 return PSA_ERROR_NOT_SUPPORTED;
2190 }
2191 if (psa_get_key_bits(attributes) == 0) {
2192 return PSA_ERROR_NOT_SUPPORTED;
2193 }
Gilles Peskined7729582019-08-05 15:55:54 +02002194
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2196 &slot, &driver);
2197 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002198 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 }
Gilles Peskined7729582019-08-05 15:55:54 +02002200
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002202
2203exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 if (status != PSA_SUCCESS) {
2205 psa_fail_key_creation(slot, driver);
2206 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002207
Gilles Peskined7729582019-08-05 15:55:54 +02002208 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 psa_close_key(key);
2210 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002211}
2212#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2213
Gilles Peskine449bd832023-01-11 14:50:10 +01002214psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2215 const psa_key_attributes_t *specified_attributes,
2216 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002217{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002218 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002219 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002220 psa_key_slot_t *source_slot = NULL;
2221 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002222 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002223 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302224 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002225
Ronald Cron81709fc2020-11-14 12:10:32 +01002226 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2227
Archana8a180362021-07-05 02:18:48 +05302228 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002229 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2230 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002231 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002233
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 status = psa_validate_optional_attributes(source_slot,
2235 specified_attributes);
2236 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002237 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002238 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002239
Archana9d17bf42021-09-10 06:22:44 +05302240 /* The target key type and number of bits have been validated by
2241 * psa_validate_optional_attributes() to be either equal to zero or
2242 * equal to the ones of the source key. So it is safe to inherit
2243 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302244 * */
Archana9d17bf42021-09-10 06:22:44 +05302245 actual_attributes.core.bits = source_slot->attr.bits;
2246 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302247
2248
Gilles Peskine449bd832023-01-11 14:50:10 +01002249 status = psa_restrict_key_policy(source_slot->attr.type,
2250 &actual_attributes.core.policy,
2251 &source_slot->attr.policy);
2252 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002253 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002254 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002255
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2257 &target_slot, &driver);
2258 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002259 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002260 }
2261 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2262 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302263 /*
Archana9d17bf42021-09-10 06:22:44 +05302264 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302265 * the source key would need to be exported as plaintext and re-imported
2266 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302267 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302268 * appropriate API invocations from the application, if needed.
2269 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002270 status = PSA_ERROR_NOT_SUPPORTED;
2271 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002272 }
Archana8a180362021-07-05 02:18:48 +05302273 /*
2274 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302275 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302276 * - For opaque keys this translates to an invocation of the drivers'
2277 * copy_key entry point through the dispatch layer.
2278 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002279 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2280 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2281 &storage_size);
2282 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302283 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 }
Archana374fe5b2021-09-08 15:50:28 +05302285
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2287 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302288 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002289 }
Archana374fe5b2021-09-08 15:50:28 +05302290
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 status = psa_driver_wrapper_copy_key(&actual_attributes,
2292 source_slot->key.data,
2293 source_slot->key.bytes,
2294 target_slot->key.data,
2295 target_slot->key.bytes,
2296 &target_slot->key.bytes);
2297 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302298 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 }
2300 } else {
2301 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302302 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 source_slot->key.bytes);
2304 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302305 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002306 }
Archana8a180362021-07-05 02:18:48 +05302307 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002309exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 if (status != PSA_SUCCESS) {
2311 psa_fail_key_creation(target_slot, driver);
2312 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002313
Ryan Everett1b70a072024-01-04 10:32:49 +00002314 unlock_status = psa_unregister_read(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002315
Gilles Peskine449bd832023-01-11 14:50:10 +01002316 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002317}
2318
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002319
2320
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002321/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002322/* Message digests */
2323/****************************************************************/
2324
Gilles Peskine449bd832023-01-11 14:50:10 +01002325psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002326{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002327 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002328 if (operation->id == 0) {
2329 return PSA_SUCCESS;
2330 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002331
Gilles Peskine449bd832023-01-11 14:50:10 +01002332 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002333 operation->id = 0;
2334
Gilles Peskine449bd832023-01-11 14:50:10 +01002335 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002336}
2337
Gilles Peskine449bd832023-01-11 14:50:10 +01002338psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2339 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002340{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002341 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002342
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002343 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002345 status = PSA_ERROR_BAD_STATE;
2346 goto exit;
2347 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002348
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002350 status = PSA_ERROR_INVALID_ARGUMENT;
2351 goto exit;
2352 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002353
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002354 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2355 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002357
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002359
2360exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 if (status != PSA_SUCCESS) {
2362 psa_hash_abort(operation);
2363 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002364
2365 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002366}
2367
Gilles Peskine449bd832023-01-11 14:50:10 +01002368psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2369 const uint8_t *input,
2370 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002371{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002372 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2373
Gilles Peskine449bd832023-01-11 14:50:10 +01002374 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002375 status = PSA_ERROR_BAD_STATE;
2376 goto exit;
2377 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002378
Steven Cooremanc8288352021-03-04 14:02:19 +01002379 /* Don't require hash implementations to behave correctly on a
2380 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002381 if (input_length == 0) {
2382 return PSA_SUCCESS;
2383 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002384
Gilles Peskine449bd832023-01-11 14:50:10 +01002385 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002386
2387exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 if (status != PSA_SUCCESS) {
2389 psa_hash_abort(operation);
2390 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002391
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002393}
2394
Gilles Peskine449bd832023-01-11 14:50:10 +01002395psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2396 uint8_t *hash,
2397 size_t hash_size,
2398 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002399{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002400 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002401 if (operation->id == 0) {
2402 return PSA_ERROR_BAD_STATE;
2403 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002404
Steven Cooreman1e582352021-02-18 17:24:37 +01002405 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 operation, hash, hash_size, hash_length);
2407 psa_hash_abort(operation);
2408 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002409}
2410
Gilles Peskine449bd832023-01-11 14:50:10 +01002411psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2412 const uint8_t *hash,
2413 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002414{
Ronald Cron69a63422021-10-18 09:47:58 +02002415 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002416 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002417 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 operation,
2419 actual_hash, sizeof(actual_hash),
2420 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002421
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002423 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002424 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002425
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002427 status = PSA_ERROR_INVALID_SIGNATURE;
2428 goto exit;
2429 }
2430
Dave Rodgman78701152023-08-29 14:20:18 +01002431 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002432 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002433 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002434
2435exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2437 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002438 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002439 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002440
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002442}
2443
Gilles Peskine449bd832023-01-11 14:50:10 +01002444psa_status_t psa_hash_compute(psa_algorithm_t alg,
2445 const uint8_t *input, size_t input_length,
2446 uint8_t *hash, size_t hash_size,
2447 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002448{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002449 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002450 if (!PSA_ALG_IS_HASH(alg)) {
2451 return PSA_ERROR_INVALID_ARGUMENT;
2452 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002453
Gilles Peskine449bd832023-01-11 14:50:10 +01002454 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2455 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002456}
2457
Gilles Peskine449bd832023-01-11 14:50:10 +01002458psa_status_t psa_hash_compare(psa_algorithm_t alg,
2459 const uint8_t *input, size_t input_length,
2460 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002461{
Ronald Cron69a63422021-10-18 09:47:58 +02002462 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002463 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002464
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 if (!PSA_ALG_IS_HASH(alg)) {
2466 return PSA_ERROR_INVALID_ARGUMENT;
2467 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002468
Steven Cooreman1e582352021-02-18 17:24:37 +01002469 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002470 alg, input, input_length,
2471 actual_hash, sizeof(actual_hash),
2472 &actual_hash_length);
2473 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002474 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 }
2476 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002477 status = PSA_ERROR_INVALID_SIGNATURE;
2478 goto exit;
2479 }
Dave Rodgman78701152023-08-29 14:20:18 +01002480 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002481 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002482 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002483
2484exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002485 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2486 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002487}
2488
Gilles Peskine449bd832023-01-11 14:50:10 +01002489psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2490 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002491{
Gilles Peskine449bd832023-01-11 14:50:10 +01002492 if (source_operation->id == 0 ||
2493 target_operation->id != 0) {
2494 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002495 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002496
Gilles Peskine449bd832023-01-11 14:50:10 +01002497 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2498 target_operation);
2499 if (status != PSA_SUCCESS) {
2500 psa_hash_abort(target_operation);
2501 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002502
Gilles Peskine449bd832023-01-11 14:50:10 +01002503 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002504}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002505
2506
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002507/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002508/* MAC */
2509/****************************************************************/
2510
Gilles Peskine449bd832023-01-11 14:50:10 +01002511psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002512{
Steven Cooremane6804192021-03-19 18:28:56 +01002513 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 if (operation->id == 0) {
2515 return PSA_SUCCESS;
2516 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002517
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002519 operation->mac_size = 0;
2520 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002521 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002522
Gilles Peskine449bd832023-01-11 14:50:10 +01002523 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002524}
2525
Ronald Cron2dff3b22021-06-17 16:33:22 +02002526static psa_status_t psa_mac_finalize_alg_and_key_validation(
2527 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002528 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002530{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002531 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002532 psa_key_type_t key_type = psa_get_key_type(attributes);
2533 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002534
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 if (!PSA_ALG_IS_MAC(alg)) {
2536 return PSA_ERROR_INVALID_ARGUMENT;
2537 }
Steven Cooremane6804192021-03-19 18:28:56 +01002538
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002539 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002540 status = psa_mac_key_can_do(alg, key_type);
2541 if (status != PSA_SUCCESS) {
2542 return status;
2543 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002544
Steven Cooremand1a68f12021-05-10 11:13:41 +02002545 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002547
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002549 /* A very short MAC is too short for security since it can be
2550 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2551 * so we make this our minimum, even though 32 bits is still
2552 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002554 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002555
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2557 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002558 /* It's impossible to "truncate" to a larger length than the full length
2559 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002561 }
2562
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002564 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2565 * that is disabled in the compile-time configuration. The result can
2566 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2567 * configuration into account. In this case, force a return of
2568 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2569 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2570 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2571 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2572 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002574 }
2575
Gilles Peskine449bd832023-01-11 14:50:10 +01002576 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002577}
2578
Gilles Peskine449bd832023-01-11 14:50:10 +01002579static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2580 mbedtls_svc_key_id_t key,
2581 psa_algorithm_t alg,
2582 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002583{
2584 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2585 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002586 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002587 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002588
2589 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002590 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002591 status = PSA_ERROR_BAD_STATE;
2592 goto exit;
2593 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002594
2595 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002596 key,
2597 &slot,
2598 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2599 alg);
2600 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002601 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002602 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002603
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002604 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002605 .core = slot->attr
2606 };
2607
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2609 &operation->mac_size);
2610 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002611 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002613
2614 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002615 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002616 if (is_sign) {
2617 status = psa_driver_wrapper_mac_sign_setup(operation,
2618 &attributes,
2619 slot->key.data,
2620 slot->key.bytes,
2621 alg);
2622 } else {
2623 status = psa_driver_wrapper_mac_verify_setup(operation,
2624 &attributes,
2625 slot->key.data,
2626 slot->key.bytes,
2627 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002628 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002629
Gilles Peskinefbfac682018-07-08 20:51:54 +02002630exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002631 if (status != PSA_SUCCESS) {
2632 psa_mac_abort(operation);
2633 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002634
Ryan Everett1b70a072024-01-04 10:32:49 +00002635 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002636
Gilles Peskine449bd832023-01-11 14:50:10 +01002637 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002638}
2639
Gilles Peskine449bd832023-01-11 14:50:10 +01002640psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2641 mbedtls_svc_key_id_t key,
2642 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002643{
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002645}
2646
Gilles Peskine449bd832023-01-11 14:50:10 +01002647psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2648 mbedtls_svc_key_id_t key,
2649 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002650{
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002652}
2653
Gilles Peskine449bd832023-01-11 14:50:10 +01002654psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2655 const uint8_t *input,
2656 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002657{
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 if (operation->id == 0) {
2659 return PSA_ERROR_BAD_STATE;
2660 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002661
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002662 /* Don't require hash implementations to behave correctly on a
2663 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 if (input_length == 0) {
2665 return PSA_SUCCESS;
2666 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002667
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2669 input, input_length);
2670 if (status != PSA_SUCCESS) {
2671 psa_mac_abort(operation);
2672 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002673
Gilles Peskine449bd832023-01-11 14:50:10 +01002674 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002675}
2676
Gilles Peskine449bd832023-01-11 14:50:10 +01002677psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2678 uint8_t *mac,
2679 size_t mac_size,
2680 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002681{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002682 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2683 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002684
Gilles Peskine449bd832023-01-11 14:50:10 +01002685 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002686 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002687 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002688 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002689
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002691 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002692 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002693 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002694
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002695 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2696 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002697 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002698 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002699 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002700 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002701
Gilles Peskine449bd832023-01-11 14:50:10 +01002702 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002703 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002704 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002705 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002706
Gilles Peskine449bd832023-01-11 14:50:10 +01002707 status = psa_driver_wrapper_mac_sign_finish(operation,
2708 mac, operation->mac_size,
2709 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002710
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002711exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002712 /* In case of success, set the potential excess room in the output buffer
2713 * to an invalid value, to avoid potentially leaking a longer MAC.
2714 * In case of error, set the output length and content to a safe default,
2715 * such that in case the caller misses an error check, the output would be
2716 * an unachievable MAC.
2717 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002718 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002719 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002720 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002721 }
mohammad16036df908f2018-04-02 08:34:15 -07002722
Paul Elliottdc42ca82023-02-24 18:11:59 +00002723 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002724
Gilles Peskine449bd832023-01-11 14:50:10 +01002725 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002726
Gilles Peskine449bd832023-01-11 14:50:10 +01002727 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002728}
2729
Gilles Peskine449bd832023-01-11 14:50:10 +01002730psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2731 const uint8_t *mac,
2732 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002733{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002734 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2735 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002736
Gilles Peskine449bd832023-01-11 14:50:10 +01002737 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002738 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002739 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002740 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002741
Gilles Peskine449bd832023-01-11 14:50:10 +01002742 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002743 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002744 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002745 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002746
Gilles Peskine449bd832023-01-11 14:50:10 +01002747 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002748 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002749 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002750 }
2751
Gilles Peskine449bd832023-01-11 14:50:10 +01002752 status = psa_driver_wrapper_mac_verify_finish(operation,
2753 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002754
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002755exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002756 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002757
Gilles Peskine449bd832023-01-11 14:50:10 +01002758 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002759}
2760
Gilles Peskine449bd832023-01-11 14:50:10 +01002761static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2762 psa_algorithm_t alg,
2763 const uint8_t *input,
2764 size_t input_length,
2765 uint8_t *mac,
2766 size_t mac_size,
2767 size_t *mac_length,
2768 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002769{
2770 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002771 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2772 psa_key_slot_t *slot;
2773 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002774 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002775
Ronald Cron51131b52021-06-17 17:17:20 +02002776 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002777 key,
2778 &slot,
2779 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2780 alg);
2781 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002782 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002783 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002784
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002785 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002786 .core = slot->attr
2787 };
2788
Gilles Peskine449bd832023-01-11 14:50:10 +01002789 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2790 &operation_mac_size);
2791 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002792 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002794
Gilles Peskine449bd832023-01-11 14:50:10 +01002795 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002796 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002797 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002798 }
2799
2800 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 &attributes,
2802 slot->key.data, slot->key.bytes,
2803 alg,
2804 input, input_length,
2805 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002806
2807exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002808 /* In case of success, set the potential excess room in the output buffer
2809 * to an invalid value, to avoid potentially leaking a longer MAC.
2810 * In case of error, set the output length and content to a safe default,
2811 * such that in case the caller misses an error check, the output would be
2812 * an unachievable MAC.
2813 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002814 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002815 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002816 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002817 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002818
2819 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002820
Ryan Everett1b70a072024-01-04 10:32:49 +00002821 unlock_status = psa_unregister_read(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002822
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002824}
2825
Gilles Peskine449bd832023-01-11 14:50:10 +01002826psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002827 psa_algorithm_t alg,
2828 const uint8_t *input,
2829 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002830 uint8_t *mac,
2831 size_t mac_size,
2832 size_t *mac_length)
2833{
2834 return psa_mac_compute_internal(key, alg,
2835 input, input_length,
2836 mac, mac_size, mac_length, 1);
2837}
2838
2839psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2840 psa_algorithm_t alg,
2841 const uint8_t *input,
2842 size_t input_length,
2843 const uint8_t *mac,
2844 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002845{
2846 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002847 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2848 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002849
Gilles Peskine449bd832023-01-11 14:50:10 +01002850 status = psa_mac_compute_internal(key, alg,
2851 input, input_length,
2852 actual_mac, sizeof(actual_mac),
2853 &actual_mac_length, 0);
2854 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002855 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002857
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002859 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002860 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002861 }
Dave Rodgman78701152023-08-29 14:20:18 +01002862 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002863 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002864 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002865 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002866
2867exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002868 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002869
Gilles Peskine449bd832023-01-11 14:50:10 +01002870 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002871}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002872
Gilles Peskinee59236f2018-01-27 23:32:46 +01002873/****************************************************************/
2874/* Asymmetric cryptography */
2875/****************************************************************/
2876
Gilles Peskine449bd832023-01-11 14:50:10 +01002877static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2878 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002879{
Gilles Peskine449bd832023-01-11 14:50:10 +01002880 if (input_is_message) {
2881 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2882 return PSA_ERROR_INVALID_ARGUMENT;
2883 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002884
Gilles Peskine449bd832023-01-11 14:50:10 +01002885 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2886 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2887 return PSA_ERROR_INVALID_ARGUMENT;
2888 }
2889 }
2890 } else {
2891 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2892 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002893 }
2894 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002895
Gilles Peskine449bd832023-01-11 14:50:10 +01002896 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002897}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002898
Gilles Peskine449bd832023-01-11 14:50:10 +01002899static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2900 int input_is_message,
2901 psa_algorithm_t alg,
2902 const uint8_t *input,
2903 size_t input_length,
2904 uint8_t *signature,
2905 size_t signature_size,
2906 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002907{
2908 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2909 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2910 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002911 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002912
2913 *signature_length = 0;
2914
Gilles Peskine449bd832023-01-11 14:50:10 +01002915 status = psa_sign_verify_check_alg(input_is_message, alg);
2916 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002917 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002919
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002920 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002921 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002922 * buffer can in principle be empty since it doesn't actually have
2923 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01002924 if (signature_size == 0) {
2925 return PSA_ERROR_BUFFER_TOO_SMALL;
2926 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002927
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002928 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002929 key, &slot,
2930 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
2931 PSA_KEY_USAGE_SIGN_HASH,
2932 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002933
Gilles Peskine449bd832023-01-11 14:50:10 +01002934 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002935 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002936 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002937
Gilles Peskine449bd832023-01-11 14:50:10 +01002938 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002939 status = PSA_ERROR_INVALID_ARGUMENT;
2940 goto exit;
2941 }
2942
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002943 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01002944 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002945 };
2946
Gilles Peskine449bd832023-01-11 14:50:10 +01002947 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002948 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002949 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02002950 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 signature, signature_size, signature_length);
2952 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002953
2954 status = psa_driver_wrapper_sign_hash(
2955 &attributes, slot->key.data, slot->key.bytes,
2956 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002957 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002958 }
2959
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002960
2961exit:
Paul Elliott59200a22023-02-21 15:07:40 +00002962 psa_wipe_tag_output_buffer(signature, status, signature_size,
2963 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002964
Ryan Everett1b70a072024-01-04 10:32:49 +00002965 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002966
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002968}
2969
Gilles Peskine449bd832023-01-11 14:50:10 +01002970static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
2971 int input_is_message,
2972 psa_algorithm_t alg,
2973 const uint8_t *input,
2974 size_t input_length,
2975 const uint8_t *signature,
2976 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002977{
2978 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2979 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2980 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002981
Gilles Peskine449bd832023-01-11 14:50:10 +01002982 status = psa_sign_verify_check_alg(input_is_message, alg);
2983 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002984 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002985 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002986
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002987 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 key, &slot,
2989 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
2990 PSA_KEY_USAGE_VERIFY_HASH,
2991 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002992
Gilles Peskine449bd832023-01-11 14:50:10 +01002993 if (status != PSA_SUCCESS) {
2994 return status;
2995 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002996
2997 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01002998 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002999 };
3000
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003002 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003003 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003004 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 signature, signature_length);
3006 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003007 status = psa_driver_wrapper_verify_hash(
3008 &attributes, slot->key.data, slot->key.bytes,
3009 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003010 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003011 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003012
Ryan Everett1b70a072024-01-04 10:32:49 +00003013 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003014
Gilles Peskine449bd832023-01-11 14:50:10 +01003015 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003016
3017}
3018
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003019psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003020 const psa_key_attributes_t *attributes,
3021 const uint8_t *key_buffer,
3022 size_t key_buffer_size,
3023 psa_algorithm_t alg,
3024 const uint8_t *input,
3025 size_t input_length,
3026 uint8_t *signature,
3027 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01003028 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003029{
3030 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003031
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003033 size_t hash_length;
3034 uint8_t hash[PSA_HASH_MAX_SIZE];
3035
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003036 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003037 PSA_ALG_SIGN_GET_HASH(alg),
3038 input, input_length,
3039 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003040
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003042 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003043 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003044
3045 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003046 attributes, key_buffer, key_buffer_size,
3047 alg, hash, hash_length,
3048 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003049 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003050
Gilles Peskine449bd832023-01-11 14:50:10 +01003051 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003052}
3053
Gilles Peskine449bd832023-01-11 14:50:10 +01003054psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3055 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003056 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003057 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003058 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003059 size_t signature_size,
3060 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003061{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003062 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3063 LOCAL_INPUT_DECLARE(input_external, input);
3064 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3065
3066 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3067 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3068 status = psa_sign_internal(key, 1, alg, input, input_length, signature,
3069 signature_size, signature_length);
3070
Thomas Daubney3e65f522024-01-30 12:37:25 +00003071#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003072exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003073#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003074 LOCAL_INPUT_FREE(input_external, input);
3075 LOCAL_OUTPUT_FREE(signature_external, signature);
3076 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003077}
3078
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003079psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003080 const psa_key_attributes_t *attributes,
3081 const uint8_t *key_buffer,
3082 size_t key_buffer_size,
3083 psa_algorithm_t alg,
3084 const uint8_t *input,
3085 size_t input_length,
3086 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003087 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003088{
3089 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003090
Gilles Peskine449bd832023-01-11 14:50:10 +01003091 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003092 size_t hash_length;
3093 uint8_t hash[PSA_HASH_MAX_SIZE];
3094
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003095 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003096 PSA_ALG_SIGN_GET_HASH(alg),
3097 input, input_length,
3098 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003099
Gilles Peskine449bd832023-01-11 14:50:10 +01003100 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003101 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003102 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003103
3104 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003105 attributes, key_buffer, key_buffer_size,
3106 alg, hash, hash_length,
3107 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003108 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003109
Gilles Peskine449bd832023-01-11 14:50:10 +01003110 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003111}
3112
Gilles Peskine449bd832023-01-11 14:50:10 +01003113psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3114 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003115 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003116 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003117 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003118 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003119{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003120 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3121 LOCAL_INPUT_DECLARE(input_external, input);
3122 LOCAL_INPUT_DECLARE(signature_external, signature);
3123
3124 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3125 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3126 status = psa_verify_internal(key, 1, alg, input, input_length, signature,
3127 signature_length);
3128
Thomas Daubney3e65f522024-01-30 12:37:25 +00003129#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003130exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003131#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003132 LOCAL_INPUT_FREE(input_external, input);
3133 LOCAL_INPUT_FREE(signature_external, signature);
3134
3135 return status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003136}
3137
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003138psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003139 const psa_key_attributes_t *attributes,
3140 const uint8_t *key_buffer, size_t key_buffer_size,
3141 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003142 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003143{
Gilles Peskine449bd832023-01-11 14:50:10 +01003144 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3145 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3146 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003147#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003148 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3149 return mbedtls_psa_rsa_sign_hash(
3150 attributes,
3151 key_buffer, key_buffer_size,
3152 alg, hash, hash_length,
3153 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003154#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3155 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003156 } else {
3157 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003158 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003159 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3160 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003161#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003162 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3163 return mbedtls_psa_ecdsa_sign_hash(
3164 attributes,
3165 key_buffer, key_buffer_size,
3166 alg, hash, hash_length,
3167 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003168#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3169 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003170 } else {
3171 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003172 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003173 }
Ronald Cron4501c982021-03-19 20:09:32 +01003174
Gilles Peskine449bd832023-01-11 14:50:10 +01003175 (void) key_buffer;
3176 (void) key_buffer_size;
3177 (void) hash;
3178 (void) hash_length;
3179 (void) signature;
3180 (void) signature_size;
3181 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003182
Gilles Peskine449bd832023-01-11 14:50:10 +01003183 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003184}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003185
Gilles Peskine449bd832023-01-11 14:50:10 +01003186psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3187 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003188 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003189 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003190 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003191 size_t signature_size,
3192 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003193{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003194 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3195 LOCAL_INPUT_DECLARE(hash_external, hash);
3196 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3197
3198 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3199 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3200 status = psa_sign_internal(key, 0, alg, hash, hash_length, signature,
3201 signature_size, signature_length);
3202
Thomas Daubney3e65f522024-01-30 12:37:25 +00003203#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003204exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003205#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003206 LOCAL_INPUT_FREE(hash_external, hash);
3207 LOCAL_OUTPUT_FREE(signature_external, signature);
3208
3209 return status;
itayzafrir5c753392018-05-08 11:18:38 +03003210}
3211
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003212psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003213 const psa_key_attributes_t *attributes,
3214 const uint8_t *key_buffer, size_t key_buffer_size,
3215 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003216 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003217{
Gilles Peskine449bd832023-01-11 14:50:10 +01003218 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3219 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3220 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003221#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003222 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3223 return mbedtls_psa_rsa_verify_hash(
3224 attributes,
3225 key_buffer, key_buffer_size,
3226 alg, hash, hash_length,
3227 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003228#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3229 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003230 } else {
3231 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003232 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003233 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3234 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003235#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003236 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3237 return mbedtls_psa_ecdsa_verify_hash(
3238 attributes,
3239 key_buffer, key_buffer_size,
3240 alg, hash, hash_length,
3241 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003242#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3243 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003244 } else {
3245 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003246 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003247 }
Ronald Cron4501c982021-03-19 20:09:32 +01003248
Gilles Peskine449bd832023-01-11 14:50:10 +01003249 (void) key_buffer;
3250 (void) key_buffer_size;
3251 (void) hash;
3252 (void) hash_length;
3253 (void) signature;
3254 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003255
Gilles Peskine449bd832023-01-11 14:50:10 +01003256 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003257}
3258
Gilles Peskine449bd832023-01-11 14:50:10 +01003259psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3260 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003261 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003262 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003263 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003264 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003265{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003266 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3267 LOCAL_INPUT_DECLARE(hash_external, hash);
3268 LOCAL_INPUT_DECLARE(signature_external, signature);
3269
3270 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3271 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3272 status = psa_verify_internal(key, 0, alg, hash, hash_length, signature,
3273 signature_length);
3274
Thomas Daubney3e65f522024-01-30 12:37:25 +00003275#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003276exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003277#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003278 LOCAL_INPUT_FREE(hash_external, hash);
3279 LOCAL_INPUT_FREE(signature_external, signature);
3280
3281 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01003282}
3283
Gilles Peskine449bd832023-01-11 14:50:10 +01003284psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3285 psa_algorithm_t alg,
3286 const uint8_t *input,
3287 size_t input_length,
3288 const uint8_t *salt,
3289 size_t salt_length,
3290 uint8_t *output,
3291 size_t output_size,
3292 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003293{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003294 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003295 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003296 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003297 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003298
Darryl Green5cc689a2018-07-24 15:34:10 +01003299 (void) input;
3300 (void) input_length;
3301 (void) salt;
3302 (void) output;
3303 (void) output_size;
3304
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003305 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003306
Gilles Peskine449bd832023-01-11 14:50:10 +01003307 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3308 return PSA_ERROR_INVALID_ARGUMENT;
3309 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003310
Valerio Setti5bb454a2024-01-15 10:43:16 +01003311 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003312 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3313 if (status != PSA_SUCCESS) {
3314 return status;
3315 }
3316 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3317 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003318 status = PSA_ERROR_INVALID_ARGUMENT;
3319 goto exit;
3320 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003321
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003322 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003323 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003324 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003325
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003326 status = psa_driver_wrapper_asymmetric_encrypt(
3327 &attributes, slot->key.data, slot->key.bytes,
3328 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003329 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003330exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003331 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003332
Gilles Peskine449bd832023-01-11 14:50:10 +01003333 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003334}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003335
Gilles Peskine449bd832023-01-11 14:50:10 +01003336psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3337 psa_algorithm_t alg,
3338 const uint8_t *input,
3339 size_t input_length,
3340 const uint8_t *salt,
3341 size_t salt_length,
3342 uint8_t *output,
3343 size_t output_size,
3344 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003345{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003346 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003347 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003348 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003349 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003350
Darryl Green5cc689a2018-07-24 15:34:10 +01003351 (void) input;
3352 (void) input_length;
3353 (void) salt;
3354 (void) output;
3355 (void) output_size;
3356
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003357 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003358
Gilles Peskine449bd832023-01-11 14:50:10 +01003359 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3360 return PSA_ERROR_INVALID_ARGUMENT;
3361 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003362
Valerio Setti5bb454a2024-01-15 10:43:16 +01003363 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003364 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3365 if (status != PSA_SUCCESS) {
3366 return status;
3367 }
3368 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003369 status = PSA_ERROR_INVALID_ARGUMENT;
3370 goto exit;
3371 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003372
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003373 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003374 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003375 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003376
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003377 status = psa_driver_wrapper_asymmetric_decrypt(
3378 &attributes, slot->key.data, slot->key.bytes,
3379 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003380 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003381
3382exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003383 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003384
Gilles Peskine449bd832023-01-11 14:50:10 +01003385 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003386}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003387
Paul Elliott9fe12f62022-11-30 19:16:02 +00003388/****************************************************************/
3389/* Asymmetric interruptible cryptography */
3390/****************************************************************/
3391
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003392static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3393
Paul Elliott9fe12f62022-11-30 19:16:02 +00003394void psa_interruptible_set_max_ops(uint32_t max_ops)
3395{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003396 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003397}
3398
3399uint32_t psa_interruptible_get_max_ops(void)
3400{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003401 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003402}
3403
Paul Elliott9fe12f62022-11-30 19:16:02 +00003404uint32_t psa_sign_hash_get_num_ops(
3405 const psa_sign_hash_interruptible_operation_t *operation)
3406{
Paul Elliott296ede92022-12-15 17:00:30 +00003407 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003408}
3409
3410uint32_t psa_verify_hash_get_num_ops(
3411 const psa_verify_hash_interruptible_operation_t *operation)
3412{
Paul Elliott296ede92022-12-15 17:00:30 +00003413 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003414}
3415
Paul Elliott59ad9452022-12-18 15:09:02 +00003416static psa_status_t psa_sign_hash_abort_internal(
3417 psa_sign_hash_interruptible_operation_t *operation)
3418{
3419 if (operation->id == 0) {
3420 /* The object has (apparently) been initialized but it is not (yet)
3421 * in use. It's ok to call abort on such an object, and there's
3422 * nothing to do. */
3423 return PSA_SUCCESS;
3424 }
3425
3426 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3427
3428 status = psa_driver_wrapper_sign_hash_abort(operation);
3429
3430 operation->id = 0;
3431
Paul Elliotte6145dc2023-02-07 12:51:21 +00003432 /* Do not clear either the error_occurred or num_ops elements here as they
3433 * only want to be cleared by the application calling abort, not by abort
3434 * being called at completion of an operation. */
3435
Paul Elliott59ad9452022-12-18 15:09:02 +00003436 return status;
3437}
3438
Paul Elliott9fe12f62022-11-30 19:16:02 +00003439psa_status_t psa_sign_hash_start(
3440 psa_sign_hash_interruptible_operation_t *operation,
3441 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3442 const uint8_t *hash, size_t hash_length)
3443{
3444 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3445 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3446 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003447 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003448
Paul Elliottc9774412023-02-06 15:14:07 +00003449 /* Check that start has not been previously called, or operation has not
3450 * previously errored. */
3451 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003452 return PSA_ERROR_BAD_STATE;
3453 }
3454
Paul Elliott9fe12f62022-11-30 19:16:02 +00003455 status = psa_sign_verify_check_alg(0, alg);
3456 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003457 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003458 return status;
3459 }
3460
3461 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3462 PSA_KEY_USAGE_SIGN_HASH,
3463 alg);
3464
3465 if (status != PSA_SUCCESS) {
3466 goto exit;
3467 }
3468
3469 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3470 status = PSA_ERROR_INVALID_ARGUMENT;
3471 goto exit;
3472 }
3473
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003474 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003475 .core = slot->attr
3476 };
3477
Paul Elliott296ede92022-12-15 17:00:30 +00003478 /* Ensure ops count gets reset, in case of operation re-use. */
3479 operation->num_ops = 0;
3480
Paul Elliott9fe12f62022-11-30 19:16:02 +00003481 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3482 slot->key.data,
3483 slot->key.bytes, alg,
3484 hash, hash_length);
3485exit:
3486
3487 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003488 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003489 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003490 }
3491
Ryan Everett1b70a072024-01-04 10:32:49 +00003492 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003493
Paul Elliottc9774412023-02-06 15:14:07 +00003494 if (unlock_status != PSA_SUCCESS) {
3495 operation->error_occurred = 1;
3496 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003497
Paul Elliottc9774412023-02-06 15:14:07 +00003498 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003499}
3500
3501
3502psa_status_t psa_sign_hash_complete(
3503 psa_sign_hash_interruptible_operation_t *operation,
3504 uint8_t *signature, size_t signature_size,
3505 size_t *signature_length)
3506{
3507 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3508
3509 *signature_length = 0;
3510
Paul Elliottc9774412023-02-06 15:14:07 +00003511 /* Check that start has been called first, and that operation has not
3512 * previously errored. */
3513 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003514 status = PSA_ERROR_BAD_STATE;
3515 goto exit;
3516 }
3517
Paul Elliott096abc42023-02-03 18:33:23 +00003518 /* Immediately reject a zero-length signature buffer. This guarantees that
3519 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003520 if (signature_size == 0) {
3521 status = PSA_ERROR_BUFFER_TOO_SMALL;
3522 goto exit;
3523 }
3524
3525 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3526 signature_size,
3527 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003528
Paul Elliott296ede92022-12-15 17:00:30 +00003529 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003530 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003531
Paul Elliottebe225c2023-02-10 14:32:53 +00003532exit:
3533
Paul Elliott59200a22023-02-21 15:07:40 +00003534 psa_wipe_tag_output_buffer(signature, status, signature_size,
3535 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003536
Paul Elliott53bb3122023-02-10 14:22:22 +00003537 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003538 if (status != PSA_SUCCESS) {
3539 operation->error_occurred = 1;
3540 }
3541
Paul Elliott59ad9452022-12-18 15:09:02 +00003542 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003543 }
3544
3545 return status;
3546}
3547
3548psa_status_t psa_sign_hash_abort(
3549 psa_sign_hash_interruptible_operation_t *operation)
3550{
Paul Elliott59ad9452022-12-18 15:09:02 +00003551 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3552
3553 status = psa_sign_hash_abort_internal(operation);
3554
3555 /* We clear the number of ops done here, so that it is not cleared when
3556 * the operation fails or succeeds, only on manual abort. */
3557 operation->num_ops = 0;
3558
Paul Elliottc9774412023-02-06 15:14:07 +00003559 /* Likewise, failure state. */
3560 operation->error_occurred = 0;
3561
Paul Elliott59ad9452022-12-18 15:09:02 +00003562 return status;
3563}
3564
3565static psa_status_t psa_verify_hash_abort_internal(
3566 psa_verify_hash_interruptible_operation_t *operation)
3567{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003568 if (operation->id == 0) {
3569 /* The object has (apparently) been initialized but it is not (yet)
3570 * in use. It's ok to call abort on such an object, and there's
3571 * nothing to do. */
3572 return PSA_SUCCESS;
3573 }
3574
Paul Elliott59ad9452022-12-18 15:09:02 +00003575 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3576
3577 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003578
3579 operation->id = 0;
3580
Paul Elliotte6145dc2023-02-07 12:51:21 +00003581 /* Do not clear either the error_occurred or num_ops elements here as they
3582 * only want to be cleared by the application calling abort, not by abort
3583 * being called at completion of an operation. */
3584
Paul Elliott59ad9452022-12-18 15:09:02 +00003585 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003586}
3587
3588psa_status_t psa_verify_hash_start(
3589 psa_verify_hash_interruptible_operation_t *operation,
3590 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3591 const uint8_t *hash, size_t hash_length,
3592 const uint8_t *signature, size_t signature_length)
3593{
3594 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3595 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3596 psa_key_slot_t *slot;
3597
Paul Elliottc9774412023-02-06 15:14:07 +00003598 /* Check that start has not been previously called, or operation has not
3599 * previously errored. */
3600 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003601 return PSA_ERROR_BAD_STATE;
3602 }
3603
3604 status = psa_sign_verify_check_alg(0, alg);
3605 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003606 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003607 return status;
3608 }
3609
3610 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3611 PSA_KEY_USAGE_VERIFY_HASH,
3612 alg);
3613
3614 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003615 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003616 return status;
3617 }
3618
3619 psa_key_attributes_t attributes = {
3620 .core = slot->attr
3621 };
3622
Paul Elliott296ede92022-12-15 17:00:30 +00003623 /* Ensure ops count gets reset, in case of operation re-use. */
3624 operation->num_ops = 0;
3625
Paul Elliott9fe12f62022-11-30 19:16:02 +00003626 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3627 slot->key.data,
3628 slot->key.bytes,
3629 alg, hash, hash_length,
3630 signature, signature_length);
3631
3632 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003633 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003634 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003635 }
3636
Ryan Everett1b70a072024-01-04 10:32:49 +00003637 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003638
Paul Elliottc9774412023-02-06 15:14:07 +00003639 if (unlock_status != PSA_SUCCESS) {
3640 operation->error_occurred = 1;
3641 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003642
Paul Elliottc9774412023-02-06 15:14:07 +00003643 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003644}
3645
3646psa_status_t psa_verify_hash_complete(
3647 psa_verify_hash_interruptible_operation_t *operation)
3648{
3649 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3650
Paul Elliottc9774412023-02-06 15:14:07 +00003651 /* Check that start has been called first, and that operation has not
3652 * previously errored. */
3653 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003654 status = PSA_ERROR_BAD_STATE;
3655 goto exit;
3656 }
3657
3658 status = psa_driver_wrapper_verify_hash_complete(operation);
3659
Paul Elliott296ede92022-12-15 17:00:30 +00003660 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003661 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003662 operation);
3663
Paul Elliottebe225c2023-02-10 14:32:53 +00003664exit:
3665
Paul Elliott9fe12f62022-11-30 19:16:02 +00003666 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003667 if (status != PSA_SUCCESS) {
3668 operation->error_occurred = 1;
3669 }
3670
Paul Elliott59ad9452022-12-18 15:09:02 +00003671 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003672 }
3673
3674 return status;
3675}
3676
3677psa_status_t psa_verify_hash_abort(
3678 psa_verify_hash_interruptible_operation_t *operation)
3679{
Paul Elliott59ad9452022-12-18 15:09:02 +00003680 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003681
Paul Elliott59ad9452022-12-18 15:09:02 +00003682 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003683
Paul Elliott59ad9452022-12-18 15:09:02 +00003684 /* We clear the number of ops done here, so that it is not cleared when
3685 * the operation fails or succeeds, only on manual abort. */
3686 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003687
Paul Elliottc9774412023-02-06 15:14:07 +00003688 /* Likewise, failure state. */
3689 operation->error_occurred = 0;
3690
Paul Elliott59ad9452022-12-18 15:09:02 +00003691 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003692}
3693
Paul Elliott588f8ed2022-12-02 18:10:26 +00003694/****************************************************************/
3695/* Asymmetric interruptible cryptography internal */
3696/* implementations */
3697/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003698
Paul Elliott588f8ed2022-12-02 18:10:26 +00003699void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3700{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003701
Paul Elliott588f8ed2022-12-02 18:10:26 +00003702#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3703 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3704 defined(MBEDTLS_ECP_RESTARTABLE)
3705
3706 /* Internal implementation uses zero to indicate infinite number max ops,
3707 * therefore avoid this value, and set to minimum possible. */
3708 if (max_ops == 0) {
3709 max_ops = 1;
3710 }
3711
Paul Elliott588f8ed2022-12-02 18:10:26 +00003712 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003713#else
3714 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003715#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3716 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3717 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3718}
3719
Paul Elliott588f8ed2022-12-02 18:10:26 +00003720uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003721 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003722{
3723#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3724 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3725 defined(MBEDTLS_ECP_RESTARTABLE)
3726
Paul Elliott93d9ca82023-02-15 18:14:21 +00003727 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003728#else
3729 (void) operation;
3730 return 0;
3731#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3732 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3733 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3734}
3735
3736uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003737 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003738{
3739 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3740 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3741 defined(MBEDTLS_ECP_RESTARTABLE)
3742
Paul Elliott93d9ca82023-02-15 18:14:21 +00003743 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003744#else
3745 (void) operation;
3746 return 0;
3747#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3748 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3749 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3750}
3751
3752psa_status_t mbedtls_psa_sign_hash_start(
3753 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3754 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3755 size_t key_buffer_size, psa_algorithm_t alg,
3756 const uint8_t *hash, size_t hash_length)
3757{
3758 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003759 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003760
Paul Elliott068fe072023-01-16 13:59:15 +00003761 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3762 return PSA_ERROR_NOT_SUPPORTED;
3763 }
3764
3765 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003766 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003767 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003768
3769#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003770 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3771 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003772
Paul Elliotta1c94092023-02-15 16:38:04 +00003773 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3774
Paul Elliott93d9ca82023-02-15 18:14:21 +00003775 /* Ensure num_ops is zero'ed in case of context re-use. */
3776 operation->num_ops = 0;
3777
Paul Elliott068fe072023-01-16 13:59:15 +00003778 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3779 attributes->core.bits,
3780 key_buffer,
3781 key_buffer_size,
3782 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003783
Paul Elliott068fe072023-01-16 13:59:15 +00003784 if (status != PSA_SUCCESS) {
3785 return status;
3786 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003787
Paul Elliott1bc59df2023-02-05 13:41:57 +00003788 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003789 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003790
Paul Elliott068fe072023-01-16 13:59:15 +00003791 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003792 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003793 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003794
Paul Elliott0290a762023-02-09 14:30:24 +00003795 /* We only need to store the same length of hash as the private key size
3796 * here, it would be truncated by the internal implementation anyway. */
3797 required_hash_length = (hash_length < operation->coordinate_bytes ?
3798 hash_length : operation->coordinate_bytes);
3799
Paul Elliottba70ad42023-02-15 18:23:53 +00003800 if (required_hash_length > sizeof(operation->hash)) {
3801 /* Shouldn't happen, but better safe than sorry. */
3802 return PSA_ERROR_CORRUPTION_DETECTED;
3803 }
3804
Paul Elliott0290a762023-02-09 14:30:24 +00003805 memcpy(operation->hash, hash, required_hash_length);
3806 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003807
3808 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003809
3810#else
Paul Elliott068fe072023-01-16 13:59:15 +00003811 (void) operation;
3812 (void) key_buffer;
3813 (void) key_buffer_size;
3814 (void) alg;
3815 (void) hash;
3816 (void) hash_length;
3817 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003818 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003819
Paul Elliott068fe072023-01-16 13:59:15 +00003820 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003821#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3822 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3823 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003824}
3825
3826psa_status_t mbedtls_psa_sign_hash_complete(
3827 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3828 uint8_t *signature, size_t signature_size,
3829 size_t *signature_length)
3830{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003831#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3832 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3833 defined(MBEDTLS_ECP_RESTARTABLE)
3834
Paul Elliotta1c94092023-02-15 16:38:04 +00003835 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003836 mbedtls_mpi r;
3837 mbedtls_mpi s;
3838
Paul Elliott46845252023-02-03 14:59:11 +00003839 mbedtls_mpi_init(&r);
3840 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003841
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003842 /* Ensure max_ops is set to the current value (or default). */
3843 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3844
Paul Elliotta1c94092023-02-15 16:38:04 +00003845 if (signature_size < 2 * operation->coordinate_bytes) {
3846 status = PSA_ERROR_BUFFER_TOO_SMALL;
3847 goto exit;
3848 }
3849
Paul Elliott588f8ed2022-12-02 18:10:26 +00003850 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003851
Paul Elliott588f8ed2022-12-02 18:10:26 +00003852#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3853 status = mbedtls_to_psa_error(
3854 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003855 &r,
3856 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003857 &operation->ctx->d,
3858 operation->hash,
3859 operation->hash_length,
3860 operation->md_alg,
3861 mbedtls_psa_get_random,
3862 MBEDTLS_PSA_RANDOM_STATE,
3863 &operation->restart_ctx));
3864#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003865 status = PSA_ERROR_NOT_SUPPORTED;
3866 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003867#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3868 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003869 status = mbedtls_to_psa_error(
3870 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003871 &r,
3872 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003873 &operation->ctx->d,
3874 operation->hash,
3875 operation->hash_length,
3876 mbedtls_psa_get_random,
3877 MBEDTLS_PSA_RANDOM_STATE,
3878 mbedtls_psa_get_random,
3879 MBEDTLS_PSA_RANDOM_STATE,
3880 &operation->restart_ctx));
3881 }
3882
Paul Elliottf8e5b562023-02-19 18:43:45 +00003883 /* Hide the fact that the restart context only holds a delta of number of
3884 * ops done during the last operation, not an absolute value. */
3885 operation->num_ops += operation->restart_ctx.ecp.ops_done;
3886
Paul Elliott724bd252023-02-08 12:35:08 +00003887 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003888 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003889 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003890 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00003891 operation->coordinate_bytes)
3892 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003893
3894 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003895 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003896 }
3897
3898 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00003899 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003900 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00003901 operation->coordinate_bytes,
3902 operation->coordinate_bytes)
3903 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00003904
3905 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00003906 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003907 }
3908
Paul Elliott1bc59df2023-02-05 13:41:57 +00003909 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003910
Paul Elliott724bd252023-02-08 12:35:08 +00003911 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003912 }
Paul Elliott724bd252023-02-08 12:35:08 +00003913
3914exit:
3915
3916 mbedtls_mpi_free(&r);
3917 mbedtls_mpi_free(&s);
3918 return status;
3919
Paul Elliott588f8ed2022-12-02 18:10:26 +00003920 #else
3921
3922 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003923 (void) signature;
3924 (void) signature_size;
3925 (void) signature_length;
3926
3927 return PSA_ERROR_NOT_SUPPORTED;
3928
3929#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3930 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3931 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3932}
3933
3934psa_status_t mbedtls_psa_sign_hash_abort(
3935 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
3936{
3937
3938#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3939 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3940 defined(MBEDTLS_ECP_RESTARTABLE)
3941
3942 if (operation->ctx) {
3943 mbedtls_ecdsa_free(operation->ctx);
3944 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00003945 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003946 }
3947
3948 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
3949
Paul Elliott93d9ca82023-02-15 18:14:21 +00003950 operation->num_ops = 0;
3951
Paul Elliott588f8ed2022-12-02 18:10:26 +00003952 return PSA_SUCCESS;
3953
3954#else
3955
3956 (void) operation;
3957
3958 return PSA_ERROR_NOT_SUPPORTED;
3959
3960#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3961 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3962 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3963}
3964
3965psa_status_t mbedtls_psa_verify_hash_start(
3966 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
3967 const psa_key_attributes_t *attributes,
3968 const uint8_t *key_buffer, size_t key_buffer_size,
3969 psa_algorithm_t alg,
3970 const uint8_t *hash, size_t hash_length,
3971 const uint8_t *signature, size_t signature_length)
3972{
3973 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00003974 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00003975 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003976
Paul Elliott068fe072023-01-16 13:59:15 +00003977 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3978 return PSA_ERROR_NOT_SUPPORTED;
3979 }
3980
3981 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003982 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003983 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003984
3985#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003986 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3987 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003988
Paul Elliotta1c94092023-02-15 16:38:04 +00003989 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3990 mbedtls_mpi_init(&operation->r);
3991 mbedtls_mpi_init(&operation->s);
3992
Paul Elliott93d9ca82023-02-15 18:14:21 +00003993 /* Ensure num_ops is zero'ed in case of context re-use. */
3994 operation->num_ops = 0;
3995
Paul Elliott068fe072023-01-16 13:59:15 +00003996 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3997 attributes->core.bits,
3998 key_buffer,
3999 key_buffer_size,
4000 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004001
Paul Elliott068fe072023-01-16 13:59:15 +00004002 if (status != PSA_SUCCESS) {
4003 return status;
4004 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004005
Paul Elliottc569fc22023-02-10 13:02:54 +00004006 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004007
Paul Elliott1bc59df2023-02-05 13:41:57 +00004008 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004009 return PSA_ERROR_INVALID_SIGNATURE;
4010 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004011
Paul Elliott068fe072023-01-16 13:59:15 +00004012 status = mbedtls_to_psa_error(
4013 mbedtls_mpi_read_binary(&operation->r,
4014 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004015 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004016
Paul Elliott068fe072023-01-16 13:59:15 +00004017 if (status != PSA_SUCCESS) {
4018 return status;
4019 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004020
Paul Elliott068fe072023-01-16 13:59:15 +00004021 status = mbedtls_to_psa_error(
4022 mbedtls_mpi_read_binary(&operation->s,
4023 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004024 coordinate_bytes,
4025 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004026
Paul Elliott068fe072023-01-16 13:59:15 +00004027 if (status != PSA_SUCCESS) {
4028 return status;
4029 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004030
Paul Elliott2c9843f2023-02-15 17:32:42 +00004031 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004032
Paul Elliott2c9843f2023-02-15 17:32:42 +00004033 if (status != PSA_SUCCESS) {
4034 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004035 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004036
Paul Elliott0290a762023-02-09 14:30:24 +00004037 /* We only need to store the same length of hash as the private key size
4038 * here, it would be truncated by the internal implementation anyway. */
4039 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4040 coordinate_bytes);
4041
Paul Elliottba70ad42023-02-15 18:23:53 +00004042 if (required_hash_length > sizeof(operation->hash)) {
4043 /* Shouldn't happen, but better safe than sorry. */
4044 return PSA_ERROR_CORRUPTION_DETECTED;
4045 }
4046
Paul Elliott0290a762023-02-09 14:30:24 +00004047 memcpy(operation->hash, hash, required_hash_length);
4048 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004049
4050 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004051#else
Paul Elliott068fe072023-01-16 13:59:15 +00004052 (void) operation;
4053 (void) key_buffer;
4054 (void) key_buffer_size;
4055 (void) alg;
4056 (void) hash;
4057 (void) hash_length;
4058 (void) signature;
4059 (void) signature_length;
4060 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004061 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004062 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004063
Paul Elliott068fe072023-01-16 13:59:15 +00004064 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004065#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4066 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4067 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004068}
4069
4070psa_status_t mbedtls_psa_verify_hash_complete(
4071 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4072{
4073
4074#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4075 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4076 defined(MBEDTLS_ECP_RESTARTABLE)
4077
Paul Elliottf8e5b562023-02-19 18:43:45 +00004078 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4079
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004080 /* Ensure max_ops is set to the current value (or default). */
4081 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4082
Paul Elliottf8e5b562023-02-19 18:43:45 +00004083 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004084 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4085 operation->hash,
4086 operation->hash_length,
4087 &operation->ctx->Q,
4088 &operation->r,
4089 &operation->s,
4090 &operation->restart_ctx));
4091
Paul Elliottf8e5b562023-02-19 18:43:45 +00004092 /* Hide the fact that the restart context only holds a delta of number of
4093 * ops done during the last operation, not an absolute value. */
4094 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4095
4096 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004097#else
4098 (void) operation;
4099
4100 return PSA_ERROR_NOT_SUPPORTED;
4101
4102#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4103 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4104 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4105}
4106
4107psa_status_t mbedtls_psa_verify_hash_abort(
4108 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4109{
4110
4111#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4112 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4113 defined(MBEDTLS_ECP_RESTARTABLE)
4114
4115 if (operation->ctx) {
4116 mbedtls_ecdsa_free(operation->ctx);
4117 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004118 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004119 }
4120
4121 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4122
Paul Elliott93d9ca82023-02-15 18:14:21 +00004123 operation->num_ops = 0;
4124
Paul Elliott588f8ed2022-12-02 18:10:26 +00004125 mbedtls_mpi_free(&operation->r);
4126 mbedtls_mpi_free(&operation->s);
4127
4128 return PSA_SUCCESS;
4129
4130#else
4131 (void) operation;
4132
4133 return PSA_ERROR_NOT_SUPPORTED;
4134
4135#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4136 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4137 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4138}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004139
mohammad1603503973b2018-03-12 15:59:30 +02004140/****************************************************************/
4141/* Symmetric cryptography */
4142/****************************************************************/
4143
Gilles Peskine449bd832023-01-11 14:50:10 +01004144static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4145 mbedtls_svc_key_id_t key,
4146 psa_algorithm_t alg,
4147 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004148{
4149 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4150 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004151 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004152 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4153 PSA_KEY_USAGE_ENCRYPT :
4154 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004155 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004156
4157 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004158 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004159 status = PSA_ERROR_BAD_STATE;
4160 goto exit;
4161 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004162
Gilles Peskine449bd832023-01-11 14:50:10 +01004163 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004164 status = PSA_ERROR_INVALID_ARGUMENT;
4165 goto exit;
4166 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004167
Gilles Peskine449bd832023-01-11 14:50:10 +01004168 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4169 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004170 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004171 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004172
Ronald Cron49fafa92021-03-10 08:34:23 +01004173 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004174 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004175 * so we only set it (in the driver wrapper) after resources have been
4176 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004177 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004178 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004179 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004180 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004181 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004182 }
4183 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004184
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004185 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004186 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004187 };
4188
Ronald Cronab99ac22020-10-01 16:38:28 +02004189 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004190 if (cipher_operation == MBEDTLS_ENCRYPT) {
4191 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4192 &attributes,
4193 slot->key.data,
4194 slot->key.bytes,
4195 alg);
4196 } else {
4197 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4198 &attributes,
4199 slot->key.data,
4200 slot->key.bytes,
4201 alg);
4202 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004203
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004204exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004205 if (status != PSA_SUCCESS) {
4206 psa_cipher_abort(operation);
4207 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004208
Ryan Everett1b70a072024-01-04 10:32:49 +00004209 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004210
Gilles Peskine449bd832023-01-11 14:50:10 +01004211 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004212}
4213
Gilles Peskine449bd832023-01-11 14:50:10 +01004214psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4215 mbedtls_svc_key_id_t key,
4216 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004217{
Gilles Peskine449bd832023-01-11 14:50:10 +01004218 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004219}
4220
Gilles Peskine449bd832023-01-11 14:50:10 +01004221psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4222 mbedtls_svc_key_id_t key,
4223 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004224{
Gilles Peskine449bd832023-01-11 14:50:10 +01004225 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004226}
4227
Gilles Peskine449bd832023-01-11 14:50:10 +01004228psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4229 uint8_t *iv,
4230 size_t iv_size,
4231 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004232{
Ronald Cron6d051732020-10-01 14:10:20 +02004233 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004234 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004235 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004236
Gilles Peskine449bd832023-01-11 14:50:10 +01004237 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004238 status = PSA_ERROR_BAD_STATE;
4239 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004240 }
4241
Gilles Peskine449bd832023-01-11 14:50:10 +01004242 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004243 status = PSA_ERROR_BAD_STATE;
4244 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004245 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004246
Ronald Cron2fb90522021-07-05 12:31:44 +02004247 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004248 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004249 status = PSA_ERROR_BUFFER_TOO_SMALL;
4250 goto exit;
4251 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004252
Gilles Peskine449bd832023-01-11 14:50:10 +01004253 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004254 status = PSA_ERROR_GENERIC_ERROR;
4255 goto exit;
4256 }
4257
Gilles Peskine449bd832023-01-11 14:50:10 +01004258 status = psa_generate_random(local_iv, default_iv_length);
4259 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004260 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004261 }
Ronald Cron5618a392021-03-26 09:52:26 +01004262
Gilles Peskine449bd832023-01-11 14:50:10 +01004263 status = psa_driver_wrapper_cipher_set_iv(operation,
4264 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004265
4266exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004267 if (status == PSA_SUCCESS) {
4268 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004269 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004270 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004271 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004272 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004273 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004274 }
Ronald Cron6d051732020-10-01 14:10:20 +02004275
Gilles Peskine449bd832023-01-11 14:50:10 +01004276 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004277}
4278
Gilles Peskine449bd832023-01-11 14:50:10 +01004279psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4280 const uint8_t *iv,
4281 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004282{
Ronald Cron6d051732020-10-01 14:10:20 +02004283 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004284
Gilles Peskine449bd832023-01-11 14:50:10 +01004285 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004286 status = PSA_ERROR_BAD_STATE;
4287 goto exit;
4288 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004289
Gilles Peskine449bd832023-01-11 14:50:10 +01004290 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004291 status = PSA_ERROR_BAD_STATE;
4292 goto exit;
4293 }
Ronald Crona0d68172021-03-26 10:15:08 +01004294
Gilles Peskine449bd832023-01-11 14:50:10 +01004295 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004296 status = PSA_ERROR_INVALID_ARGUMENT;
4297 goto exit;
4298 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004299
Gilles Peskine449bd832023-01-11 14:50:10 +01004300 status = psa_driver_wrapper_cipher_set_iv(operation,
4301 iv,
4302 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004303
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004304exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004305 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004306 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004307 } else {
4308 psa_cipher_abort(operation);
4309 }
4310 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004311}
4312
Gilles Peskine449bd832023-01-11 14:50:10 +01004313psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4314 const uint8_t *input,
4315 size_t input_length,
4316 uint8_t *output,
4317 size_t output_size,
4318 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004319{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004320 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004321
Gilles Peskine449bd832023-01-11 14:50:10 +01004322 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004323 status = PSA_ERROR_BAD_STATE;
4324 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004325 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004326
Gilles Peskine449bd832023-01-11 14:50:10 +01004327 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004328 status = PSA_ERROR_BAD_STATE;
4329 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004330 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004331
Gilles Peskine449bd832023-01-11 14:50:10 +01004332 status = psa_driver_wrapper_cipher_update(operation,
4333 input,
4334 input_length,
4335 output,
4336 output_size,
4337 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004338
4339exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004340 if (status != PSA_SUCCESS) {
4341 psa_cipher_abort(operation);
4342 }
Ronald Cron6d051732020-10-01 14:10:20 +02004343
Gilles Peskine449bd832023-01-11 14:50:10 +01004344 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004345}
4346
Gilles Peskine449bd832023-01-11 14:50:10 +01004347psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4348 uint8_t *output,
4349 size_t output_size,
4350 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004351{
David Saadab4ecc272019-02-14 13:48:10 +02004352 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004353
Gilles Peskine449bd832023-01-11 14:50:10 +01004354 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004355 status = PSA_ERROR_BAD_STATE;
4356 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004357 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004358
Gilles Peskine449bd832023-01-11 14:50:10 +01004359 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004360 status = PSA_ERROR_BAD_STATE;
4361 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004362 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004363
Gilles Peskine449bd832023-01-11 14:50:10 +01004364 status = psa_driver_wrapper_cipher_finish(operation,
4365 output,
4366 output_size,
4367 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004368
4369exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004370 if (status == PSA_SUCCESS) {
4371 return psa_cipher_abort(operation);
4372 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004373 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004374 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004375
Gilles Peskine449bd832023-01-11 14:50:10 +01004376 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004377 }
mohammad1603503973b2018-03-12 15:59:30 +02004378}
4379
Gilles Peskine449bd832023-01-11 14:50:10 +01004380psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004381{
Gilles Peskine449bd832023-01-11 14:50:10 +01004382 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004383 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004384 * in use. It's ok to call abort on such an object, and there's
4385 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004386 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004387 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004388
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004390
Ronald Cron49fafa92021-03-10 08:34:23 +01004391 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004392 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004393 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004394
Gilles Peskine449bd832023-01-11 14:50:10 +01004395 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004396}
4397
Gilles Peskine449bd832023-01-11 14:50:10 +01004398psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4399 psa_algorithm_t alg,
David Horstmann36df4b22023-12-13 15:55:25 +00004400 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004401 size_t input_length,
David Horstmann36df4b22023-12-13 15:55:25 +00004402 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004403 size_t output_size,
4404 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004405{
4406 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004407 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004408 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004409 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4410 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004411 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004412
David Horstmann62a56d92023-12-14 18:12:47 +00004413 LOCAL_INPUT_DECLARE(input_external, input);
4414 LOCAL_OUTPUT_DECLARE(output_external, output);
4415
David Horstmann36df4b22023-12-13 15:55:25 +00004416 LOCAL_INPUT_ALLOC(input_external, input_length, input);
David Horstmann36df4b22023-12-13 15:55:25 +00004417 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004418
Gilles Peskine449bd832023-01-11 14:50:10 +01004419 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004420 status = PSA_ERROR_INVALID_ARGUMENT;
4421 goto exit;
4422 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004423
Gilles Peskine449bd832023-01-11 14:50:10 +01004424 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4425 PSA_KEY_USAGE_ENCRYPT,
4426 alg);
4427 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004428 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004429 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004430
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004431 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004432 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004433 };
4434
Gilles Peskine449bd832023-01-11 14:50:10 +01004435 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4436 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004437 status = PSA_ERROR_GENERIC_ERROR;
4438 goto exit;
4439 }
4440
Gilles Peskine449bd832023-01-11 14:50:10 +01004441 if (default_iv_length > 0) {
4442 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004443 status = PSA_ERROR_BUFFER_TOO_SMALL;
4444 goto exit;
4445 }
4446
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 status = psa_generate_random(local_iv, default_iv_length);
4448 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004449 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004450 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004451 }
4452
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004453 status = psa_driver_wrapper_cipher_encrypt(
4454 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004455 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004456 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004457 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004458
4459exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004460 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004461 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004462 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004463 }
Ronald Cron23919522021-07-08 19:00:07 +02004464
Gilles Peskine449bd832023-01-11 14:50:10 +01004465 if (status == PSA_SUCCESS) {
4466 if (default_iv_length > 0) {
4467 memcpy(output, local_iv, default_iv_length);
4468 }
4469 *output_length += default_iv_length;
4470 } else {
4471 *output_length = 0;
4472 }
4473
David Horstmann62a56d92023-12-14 18:12:47 +00004474 LOCAL_INPUT_FREE(input_external, input);
4475 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004476
Gilles Peskine449bd832023-01-11 14:50:10 +01004477 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004478}
4479
Gilles Peskine449bd832023-01-11 14:50:10 +01004480psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4481 psa_algorithm_t alg,
4482 const uint8_t *input,
4483 size_t input_length,
4484 uint8_t *output,
4485 size_t output_size,
4486 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004487{
4488 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004489 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004490 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004491 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004492
Gilles Peskine449bd832023-01-11 14:50:10 +01004493 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004494 status = PSA_ERROR_INVALID_ARGUMENT;
4495 goto exit;
4496 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004497
Gilles Peskine449bd832023-01-11 14:50:10 +01004498 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4499 PSA_KEY_USAGE_DECRYPT,
4500 alg);
4501 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004502 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004503 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004504
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004505 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004506 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004507 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004508
Gilles Peskine449bd832023-01-11 14:50:10 +01004509 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4510 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004511 status = PSA_ERROR_INVALID_ARGUMENT;
4512 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004513 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004514 status = PSA_ERROR_INVALID_ARGUMENT;
4515 goto exit;
4516 }
4517
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004518 status = psa_driver_wrapper_cipher_decrypt(
4519 &attributes, slot->key.data, slot->key.bytes,
4520 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004522
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004523exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004524 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004525 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004526 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004528
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004530 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 }
Ronald Cron23919522021-07-08 19:00:07 +02004532
Gilles Peskine449bd832023-01-11 14:50:10 +01004533 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004534}
4535
4536
mohammad16035955c982018-04-26 00:53:03 +03004537/****************************************************************/
4538/* AEAD */
4539/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004540
Paul Elliottbaff51c2021-09-28 17:44:45 +01004541/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004542static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004543{
Gilles Peskine449bd832023-01-11 14:50:10 +01004544 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004545}
4546
4547/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004548static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4549 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004550{
Gilles Peskine449bd832023-01-11 14:50:10 +01004551 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004552
Gilles Peskine449bd832023-01-11 14:50:10 +01004553 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004554#if defined(PSA_WANT_ALG_GCM)
4555 case PSA_ALG_GCM:
4556 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 * arbitrarily large nonces. Please note that we do not generally
4558 * recommend the usage of nonces of greater length than
4559 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4560 * size, which can then lead to collisions if you encrypt a very
4561 * large number of messages.*/
4562 if (nonce_length != 0) {
4563 return PSA_SUCCESS;
4564 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004565 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004566#endif /* PSA_WANT_ALG_GCM */
4567#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004568 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004569 if (nonce_length >= 7 && nonce_length <= 13) {
4570 return PSA_SUCCESS;
4571 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004572 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004573#endif /* PSA_WANT_ALG_CCM */
4574#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004575 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004576 if (nonce_length == 12) {
4577 return PSA_SUCCESS;
4578 } else if (nonce_length == 8) {
4579 return PSA_ERROR_NOT_SUPPORTED;
4580 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004581 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004582#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004583 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004584 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004585 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004586 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004587
Gilles Peskine449bd832023-01-11 14:50:10 +01004588 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004589}
4590
Gilles Peskine449bd832023-01-11 14:50:10 +01004591static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004592{
Gilles Peskine449bd832023-01-11 14:50:10 +01004593 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4594 return PSA_ERROR_INVALID_ARGUMENT;
4595 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004596
Gilles Peskine449bd832023-01-11 14:50:10 +01004597 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004598}
4599
Gilles Peskine449bd832023-01-11 14:50:10 +01004600psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4601 psa_algorithm_t alg,
David Horstmann9d09a022023-11-28 19:25:00 +00004602 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 size_t nonce_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004604 const uint8_t *additional_data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 size_t additional_data_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004606 const uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004607 size_t plaintext_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004608 uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004609 size_t ciphertext_size,
4610 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004611{
Ronald Cron215633c2021-03-16 17:15:37 +01004612 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4613 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004614
David Horstmann9d09a022023-11-28 19:25:00 +00004615 LOCAL_INPUT_DECLARE(nonce_external, nonce);
4616 LOCAL_INPUT_DECLARE(additional_data_external, additional_data);
4617 LOCAL_INPUT_DECLARE(plaintext_external, plaintext);
4618 LOCAL_OUTPUT_DECLARE(ciphertext_external, ciphertext);
4619
mohammad1603f08a5502018-06-03 15:05:47 +03004620 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004621
Gilles Peskine449bd832023-01-11 14:50:10 +01004622 status = psa_aead_check_algorithm(alg);
4623 if (status != PSA_SUCCESS) {
4624 return status;
4625 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004626
Ronald Cron9a986162021-03-26 12:40:07 +01004627 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004628 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4629 if (status != PSA_SUCCESS) {
4630 return status;
4631 }
mohammad16035955c982018-04-26 00:53:03 +03004632
Ronald Cron215633c2021-03-16 17:15:37 +01004633 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004634 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004635 };
mohammad16035955c982018-04-26 00:53:03 +03004636
David Horstmann9d09a022023-11-28 19:25:00 +00004637 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
4638 LOCAL_INPUT_ALLOC(additional_data_external, additional_data_length, additional_data);
4639 LOCAL_INPUT_ALLOC(plaintext_external, plaintext_length, plaintext);
4640 LOCAL_OUTPUT_ALLOC(ciphertext_external, ciphertext_size, ciphertext);
4641
Gilles Peskine449bd832023-01-11 14:50:10 +01004642 status = psa_aead_check_nonce_length(alg, nonce_length);
4643 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004644 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004645 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004646
Ronald Cronde822812021-03-17 16:08:20 +01004647 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004648 &attributes, slot->key.data, slot->key.bytes,
4649 alg,
4650 nonce, nonce_length,
4651 additional_data, additional_data_length,
4652 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004654
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4656 memset(ciphertext, 0, ciphertext_size);
4657 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004658
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004659exit:
David Horstmann9d09a022023-11-28 19:25:00 +00004660 LOCAL_INPUT_FREE(nonce_external, nonce);
4661 LOCAL_INPUT_FREE(additional_data_external, additional_data);
4662 LOCAL_INPUT_FREE(plaintext_external, plaintext);
4663 LOCAL_OUTPUT_FREE(ciphertext_external, ciphertext);
4664
Ryan Everett1b70a072024-01-04 10:32:49 +00004665 psa_unregister_read(slot);
mohammad16035955c982018-04-26 00:53:03 +03004666
Gilles Peskine449bd832023-01-11 14:50:10 +01004667 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004668}
4669
Gilles Peskine449bd832023-01-11 14:50:10 +01004670psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4671 psa_algorithm_t alg,
David Horstmann7f2e0402023-11-28 19:43:53 +00004672 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004673 size_t nonce_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004674 const uint8_t *additional_data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004675 size_t additional_data_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004676 const uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004677 size_t ciphertext_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004678 uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004679 size_t plaintext_size,
4680 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004681{
Ronald Cron215633c2021-03-16 17:15:37 +01004682 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4683 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004684
David Horstmann7f2e0402023-11-28 19:43:53 +00004685 LOCAL_INPUT_DECLARE(nonce_external, nonce);
4686 LOCAL_INPUT_DECLARE(additional_data_external, additional_data);
4687 LOCAL_INPUT_DECLARE(ciphertext_external, ciphertext);
4688 LOCAL_OUTPUT_DECLARE(plaintext_external, plaintext);
4689
Gilles Peskineee652a32018-06-01 19:23:52 +02004690 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004691
Gilles Peskine449bd832023-01-11 14:50:10 +01004692 status = psa_aead_check_algorithm(alg);
4693 if (status != PSA_SUCCESS) {
4694 return status;
4695 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004696
Ronald Cron9a986162021-03-26 12:40:07 +01004697 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4699 if (status != PSA_SUCCESS) {
4700 return status;
4701 }
mohammad16035955c982018-04-26 00:53:03 +03004702
Ronald Cron215633c2021-03-16 17:15:37 +01004703 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004704 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004705 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004706
David Horstmann7f2e0402023-11-28 19:43:53 +00004707 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
4708 LOCAL_INPUT_ALLOC(additional_data_external, additional_data_length,
4709 additional_data);
4710 LOCAL_INPUT_ALLOC(ciphertext_external, ciphertext_length, ciphertext);
4711 LOCAL_OUTPUT_ALLOC(plaintext_external, plaintext_size, plaintext);
4712
Gilles Peskine449bd832023-01-11 14:50:10 +01004713 status = psa_aead_check_nonce_length(alg, nonce_length);
4714 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004715 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004717
Ronald Cronde822812021-03-17 16:08:20 +01004718 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004719 &attributes, slot->key.data, slot->key.bytes,
4720 alg,
4721 nonce, nonce_length,
4722 additional_data, additional_data_length,
4723 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004724 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004725
Gilles Peskine449bd832023-01-11 14:50:10 +01004726 if (status != PSA_SUCCESS && plaintext_size != 0) {
4727 memset(plaintext, 0, plaintext_size);
4728 }
mohammad160360a64d02018-06-03 17:20:42 +03004729
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004730exit:
David Horstmann7f2e0402023-11-28 19:43:53 +00004731 LOCAL_INPUT_FREE(nonce_external, nonce);
4732 LOCAL_INPUT_FREE(additional_data_external, additional_data);
4733 LOCAL_INPUT_FREE(ciphertext_external, ciphertext);
4734 LOCAL_OUTPUT_FREE(plaintext_external, plaintext);
4735
Ryan Everett1b70a072024-01-04 10:32:49 +00004736 psa_unregister_read(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004737
Gilles Peskine449bd832023-01-11 14:50:10 +01004738 return status;
mohammad16035955c982018-04-26 00:53:03 +03004739}
4740
Gilles Peskine449bd832023-01-11 14:50:10 +01004741static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4742{
4743 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004744
Gilles Peskine449bd832023-01-11 14:50:10 +01004745 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004746#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004747 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004748 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004749 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4750 return PSA_ERROR_INVALID_ARGUMENT;
4751 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004752 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004753#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004754
Przemek Stekiel86679c72022-10-06 17:06:56 +02004755#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004756 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004757 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004758 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4759 return PSA_ERROR_INVALID_ARGUMENT;
4760 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004761 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004762#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004763
Przemek Stekiel86679c72022-10-06 17:06:56 +02004764#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004765 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004766 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004767 if (tag_len != 16) {
4768 return PSA_ERROR_INVALID_ARGUMENT;
4769 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004770 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004771#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004772
4773 default:
4774 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004775 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004776 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004777 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004778}
4779
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004780/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004781static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4782 int is_encrypt,
4783 mbedtls_svc_key_id_t key,
4784 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004785{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004786 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4787 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4788 psa_key_slot_t *slot = NULL;
4789 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004790 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004791
Gilles Peskine449bd832023-01-11 14:50:10 +01004792 status = psa_aead_check_algorithm(alg);
4793 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004794 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004795 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004796
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004798 status = PSA_ERROR_BAD_STATE;
4799 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004800 }
4801
Gilles Peskine449bd832023-01-11 14:50:10 +01004802 if (operation->nonce_set || operation->lengths_set ||
4803 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004804 status = PSA_ERROR_BAD_STATE;
4805 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004806 }
4807
Gilles Peskine449bd832023-01-11 14:50:10 +01004808 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004809 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004811 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004812 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004813
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4815 alg);
4816 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004817 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004819
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004820 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004821 .core = slot->attr
4822 };
4823
Gilles Peskine449bd832023-01-11 14:50:10 +01004824 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004825 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004827
Gilles Peskine449bd832023-01-11 14:50:10 +01004828 if (is_encrypt) {
4829 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4830 &attributes,
4831 slot->key.data,
4832 slot->key.bytes,
4833 alg);
4834 } else {
4835 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4836 &attributes,
4837 slot->key.data,
4838 slot->key.bytes,
4839 alg);
4840 }
4841 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004842 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004843 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004844
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004846
4847exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004848 unlock_status = psa_unregister_read(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004849
Gilles Peskine449bd832023-01-11 14:50:10 +01004850 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004851 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004852 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004853 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 } else {
4855 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004856 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004857
Gilles Peskine449bd832023-01-11 14:50:10 +01004858 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004859}
4860
Paul Elliott302ff6b2021-04-20 18:10:30 +01004861/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004862psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4863 mbedtls_svc_key_id_t key,
4864 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004865{
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004867}
4868
4869/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004870psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4871 mbedtls_svc_key_id_t key,
4872 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004873{
Gilles Peskine449bd832023-01-11 14:50:10 +01004874 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004875}
4876
David Horstmannfed23772023-12-19 17:49:20 +00004877static psa_status_t psa_aead_set_nonce_internal(psa_aead_operation_t *operation,
4878 const uint8_t *nonce,
4879 size_t nonce_length)
4880{
4881 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4882
4883 if (operation->id == 0) {
4884 status = PSA_ERROR_BAD_STATE;
4885 goto exit;
4886 }
4887
4888 if (operation->nonce_set) {
4889 status = PSA_ERROR_BAD_STATE;
4890 goto exit;
4891 }
4892
4893 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
4894 if (status != PSA_SUCCESS) {
4895 status = PSA_ERROR_INVALID_ARGUMENT;
4896 goto exit;
4897 }
4898
4899 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
4900 nonce_length);
4901
4902exit:
4903 if (status == PSA_SUCCESS) {
4904 operation->nonce_set = 1;
4905 } else {
4906 psa_aead_abort(operation);
4907 }
4908
4909 return status;
4910}
4911
Paul Elliott302ff6b2021-04-20 18:10:30 +01004912/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004913psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
David Horstmannd3cad8b2023-12-11 14:46:04 +00004914 uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004915 size_t nonce_size,
4916 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004917{
4918 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004919 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004920 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004921
David Horstmannd3cad8b2023-12-11 14:46:04 +00004922 LOCAL_OUTPUT_DECLARE(nonce_external, nonce);
4923 LOCAL_OUTPUT_ALLOC(nonce_external, nonce_size, nonce);
4924
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004925 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004926
Gilles Peskine449bd832023-01-11 14:50:10 +01004927 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004928 status = PSA_ERROR_BAD_STATE;
4929 goto exit;
4930 }
4931
Gilles Peskine449bd832023-01-11 14:50:10 +01004932 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004933 status = PSA_ERROR_BAD_STATE;
4934 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004935 }
4936
Paul Elliotte193ea82021-10-01 13:00:16 +01004937 /* For CCM, this size may not be correct according to the PSA
4938 * specification. The PSA Crypto 1.0.1 specification states:
4939 *
4940 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4941 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4942 *
4943 * However this restriction that L has to be the smallest integer is not
4944 * applied in practice, and it is not implementable here since the
4945 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004946 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
4947 operation->alg);
4948 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004949 status = PSA_ERROR_BUFFER_TOO_SMALL;
4950 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004951 }
4952
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 status = psa_generate_random(local_nonce, required_nonce_size);
4954 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004955 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004956 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01004957
David Horstmannfed23772023-12-19 17:49:20 +00004958 status = psa_aead_set_nonce_internal(operation, local_nonce,
4959 required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004960
Paul Elliott39dc6b82021-05-11 19:16:09 +01004961exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004962 if (status == PSA_SUCCESS) {
4963 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01004964 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01004965 } else {
4966 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01004967 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01004968
David Horstmannd3cad8b2023-12-11 14:46:04 +00004969 LOCAL_OUTPUT_FREE(nonce_external, nonce);
4970
Gilles Peskine449bd832023-01-11 14:50:10 +01004971 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004972}
4973
4974/* Set the nonce for a multipart authenticated encryption or decryption
4975 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004976psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
David Horstmann8f0ef512023-12-11 15:17:11 +00004977 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004978 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004979{
David Horstmannfed23772023-12-19 17:49:20 +00004980 psa_status_t status;
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004981
David Horstmann8f0ef512023-12-11 15:17:11 +00004982 LOCAL_INPUT_DECLARE(nonce_external, nonce);
4983 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
4984
David Horstmannfed23772023-12-19 17:49:20 +00004985 status = psa_aead_set_nonce_internal(operation, nonce, nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004986
Paul Elliott39dc6b82021-05-11 19:16:09 +01004987exit:
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004988
David Horstmann8f0ef512023-12-11 15:17:11 +00004989 LOCAL_INPUT_FREE(nonce_external, nonce);
4990
Gilles Peskine449bd832023-01-11 14:50:10 +01004991 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004992}
4993
4994/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004995psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
4996 size_t ad_length,
4997 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004998{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01004999 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5000
Gilles Peskine449bd832023-01-11 14:50:10 +01005001 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005002 status = PSA_ERROR_BAD_STATE;
5003 goto exit;
5004 }
5005
Gilles Peskine449bd832023-01-11 14:50:10 +01005006 if (operation->lengths_set || operation->ad_started ||
5007 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005008 status = PSA_ERROR_BAD_STATE;
5009 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005010 }
5011
Gilles Peskine449bd832023-01-11 14:50:10 +01005012 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005013#if defined(PSA_WANT_ALG_GCM)
5014 case PSA_ALG_GCM:
5015 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01005016 * bits. Without the guard this code will generate warnings on 32bit
5017 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01005018#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01005019 if (((uint64_t) ad_length) >> 61 != 0 ||
5020 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005021 status = PSA_ERROR_INVALID_ARGUMENT;
5022 goto exit;
5023 }
Paul Elliott325d3742021-09-27 17:56:28 +01005024#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005025 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005026#endif /* PSA_WANT_ALG_GCM */
5027#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005028 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01005029 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005030 status = PSA_ERROR_INVALID_ARGUMENT;
5031 goto exit;
5032 }
5033 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005034#endif /* PSA_WANT_ALG_CCM */
5035#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005036 case PSA_ALG_CHACHA20_POLY1305:
5037 /* No length restrictions for ChaChaPoly. */
5038 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005039#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005040 default:
5041 break;
5042 }
Paul Elliott325d3742021-09-27 17:56:28 +01005043
Gilles Peskine449bd832023-01-11 14:50:10 +01005044 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
5045 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005046
Paul Elliott39dc6b82021-05-11 19:16:09 +01005047exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005048 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005049 operation->ad_remaining = ad_length;
5050 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01005051 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005052 } else {
5053 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01005054 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005055
Gilles Peskine449bd832023-01-11 14:50:10 +01005056 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005057}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005058
5059/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005060psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
5061 const uint8_t *input,
5062 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005063{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005064 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5065
Gilles Peskine449bd832023-01-11 14:50:10 +01005066 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005067 status = PSA_ERROR_BAD_STATE;
5068 goto exit;
5069 }
5070
Gilles Peskine449bd832023-01-11 14:50:10 +01005071 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005072 status = PSA_ERROR_BAD_STATE;
5073 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005074 }
5075
Gilles Peskine449bd832023-01-11 14:50:10 +01005076 if (operation->lengths_set) {
5077 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005078 status = PSA_ERROR_INVALID_ARGUMENT;
5079 goto exit;
5080 }
5081
5082 operation->ad_remaining -= input_length;
5083 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005084#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005085 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005086 status = PSA_ERROR_BAD_STATE;
5087 goto exit;
5088 }
5089#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005090
Gilles Peskine449bd832023-01-11 14:50:10 +01005091 status = psa_driver_wrapper_aead_update_ad(operation, input,
5092 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005093
Paul Elliott39dc6b82021-05-11 19:16:09 +01005094exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005095 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005096 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005097 } else {
5098 psa_aead_abort(operation);
5099 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005100
Gilles Peskine449bd832023-01-11 14:50:10 +01005101 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005102}
5103
5104/* Encrypt or decrypt a message fragment in an active multipart AEAD
5105 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005106psa_status_t psa_aead_update(psa_aead_operation_t *operation,
5107 const uint8_t *input,
5108 size_t input_length,
5109 uint8_t *output,
5110 size_t output_size,
5111 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005112{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005113 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005114
5115 *output_length = 0;
5116
Gilles Peskine449bd832023-01-11 14:50:10 +01005117 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005118 status = PSA_ERROR_BAD_STATE;
5119 goto exit;
5120 }
5121
Gilles Peskine449bd832023-01-11 14:50:10 +01005122 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005123 status = PSA_ERROR_BAD_STATE;
5124 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005125 }
5126
Gilles Peskine449bd832023-01-11 14:50:10 +01005127 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005128 /* Additional data length was supplied, but not all the additional
5129 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005130 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005131 status = PSA_ERROR_INVALID_ARGUMENT;
5132 goto exit;
5133 }
5134
5135 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005136 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005137 status = PSA_ERROR_INVALID_ARGUMENT;
5138 goto exit;
5139 }
5140
5141 operation->body_remaining -= input_length;
5142 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005143#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005144 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005145 status = PSA_ERROR_BAD_STATE;
5146 goto exit;
5147 }
5148#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005149
Gilles Peskine449bd832023-01-11 14:50:10 +01005150 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5151 output, output_size,
5152 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005153
Paul Elliott39dc6b82021-05-11 19:16:09 +01005154exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005155 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005156 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005157 } else {
5158 psa_aead_abort(operation);
5159 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005160
Gilles Peskine449bd832023-01-11 14:50:10 +01005161 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005162}
5163
Gilles Peskine449bd832023-01-11 14:50:10 +01005164static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005165{
Gilles Peskine449bd832023-01-11 14:50:10 +01005166 if (operation->id == 0 || !operation->nonce_set) {
5167 return PSA_ERROR_BAD_STATE;
5168 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005169
Gilles Peskine449bd832023-01-11 14:50:10 +01005170 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5171 operation->body_remaining != 0)) {
5172 return PSA_ERROR_INVALID_ARGUMENT;
5173 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005174
Gilles Peskine449bd832023-01-11 14:50:10 +01005175 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005176}
5177
Paul Elliott302ff6b2021-04-20 18:10:30 +01005178/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005179psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
5180 uint8_t *ciphertext,
5181 size_t ciphertext_size,
5182 size_t *ciphertext_length,
5183 uint8_t *tag,
5184 size_t tag_size,
5185 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005186{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005187 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5188
Paul Elliott302ff6b2021-04-20 18:10:30 +01005189 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005190 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005191
Gilles Peskine449bd832023-01-11 14:50:10 +01005192 status = psa_aead_final_checks(operation);
5193 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005194 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005195 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005196
Gilles Peskine449bd832023-01-11 14:50:10 +01005197 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005198 status = PSA_ERROR_BAD_STATE;
5199 goto exit;
5200 }
5201
Gilles Peskine449bd832023-01-11 14:50:10 +01005202 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5203 ciphertext_size,
5204 ciphertext_length,
5205 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005206
Paul Elliott39dc6b82021-05-11 19:16:09 +01005207exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005208
5209
Paul Elliottf47b0952021-05-21 18:02:33 +01005210 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005211 * the zero tag size, make sure the tag is set to something implausible.
5212 * Even if the operation succeeds, make sure we clear the rest of the
5213 * buffer to prevent potential leakage of anything previously placed in
5214 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005215 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005216
Gilles Peskine449bd832023-01-11 14:50:10 +01005217 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005218
Gilles Peskine449bd832023-01-11 14:50:10 +01005219 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005220}
5221
5222/* Finish authenticating and decrypting a message in a multipart AEAD
5223 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005224psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5225 uint8_t *plaintext,
5226 size_t plaintext_size,
5227 size_t *plaintext_length,
5228 const uint8_t *tag,
5229 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005230{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005231 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5232
Paul Elliott302ff6b2021-04-20 18:10:30 +01005233 *plaintext_length = 0;
5234
Gilles Peskine449bd832023-01-11 14:50:10 +01005235 status = psa_aead_final_checks(operation);
5236 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005237 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005238 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005239
Gilles Peskine449bd832023-01-11 14:50:10 +01005240 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005241 status = PSA_ERROR_BAD_STATE;
5242 goto exit;
5243 }
5244
Gilles Peskine449bd832023-01-11 14:50:10 +01005245 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5246 plaintext_size,
5247 plaintext_length,
5248 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005249
5250exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005251 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005252
Gilles Peskine449bd832023-01-11 14:50:10 +01005253 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005254}
5255
5256/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005257psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005258{
5259 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5260
Gilles Peskine449bd832023-01-11 14:50:10 +01005261 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005262 /* The object has (apparently) been initialized but it is not (yet)
5263 * in use. It's ok to call abort on such an object, and there's
5264 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005265 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005266 }
5267
Gilles Peskine449bd832023-01-11 14:50:10 +01005268 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005269
Gilles Peskine449bd832023-01-11 14:50:10 +01005270 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005271
Gilles Peskine449bd832023-01-11 14:50:10 +01005272 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005273}
5274
Gilles Peskinee59236f2018-01-27 23:32:46 +01005275/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005276/* Generators */
5277/****************************************************************/
5278
Przemek Stekiel69c46792022-06-10 12:59:51 +02005279#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005280 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005281 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305282 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305283 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005284#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005285#endif /* At least one builtin KDF */
5286
Przemek Stekiel69c46792022-06-10 12:59:51 +02005287#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005288 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5289 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5290static psa_status_t psa_key_derivation_start_hmac(
5291 psa_mac_operation_t *operation,
5292 psa_algorithm_t hash_alg,
5293 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005294 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005295{
5296 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5297 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005298 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5299 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5300 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005301
Steven Cooreman72f736a2021-05-07 14:14:37 +02005302 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005303 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005304
Gilles Peskine449bd832023-01-11 14:50:10 +01005305 status = psa_driver_wrapper_mac_sign_setup(operation,
5306 &attributes,
5307 hmac_key, hmac_key_length,
5308 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005309
Gilles Peskine449bd832023-01-11 14:50:10 +01005310 psa_reset_key_attributes(&attributes);
5311 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005312}
5313#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005314
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005315#define HKDF_STATE_INIT 0 /* no input yet */
5316#define HKDF_STATE_STARTED 1 /* got salt */
5317#define HKDF_STATE_KEYED 2 /* got key */
5318#define HKDF_STATE_OUTPUT 3 /* output started */
5319
Gilles Peskinecbe66502019-05-16 16:59:18 +02005320static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005321 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005322{
Gilles Peskine449bd832023-01-11 14:50:10 +01005323 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5324 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5325 } else {
5326 return operation->alg;
5327 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005328}
5329
Gilles Peskine449bd832023-01-11 14:50:10 +01005330psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005331{
5332 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005333 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5334 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005335 /* The object has (apparently) been initialized but it is not
5336 * in use. It's ok to call abort on such an object, and there's
5337 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005338 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005339#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005340 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5341 mbedtls_free(operation->ctx.hkdf.info);
5342 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5343 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005344#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005345#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5346 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005347 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5348 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5349 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5350 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005351 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005352 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005353 }
5354
Gilles Peskine449bd832023-01-11 14:50:10 +01005355 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005356 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005357 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005358 }
5359
Gilles Peskine449bd832023-01-11 14:50:10 +01005360 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005361 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005362 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005363 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005364#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005365 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005366 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005367 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005368 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005369#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005370 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005371
5372 /* We leave the fields Ai and output_block to be erased safely by the
5373 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005374 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005375#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5376 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005377#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005378 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5379 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5380 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5381 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005382#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305383#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305384 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305385 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005386 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305387 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305388 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305389
5390 status = PSA_SUCCESS;
5391 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305392#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005393 {
5394 status = PSA_ERROR_BAD_STATE;
5395 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005396 mbedtls_platform_zeroize(operation, sizeof(*operation));
5397 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005398}
5399
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005400psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005401 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005402{
Gilles Peskine449bd832023-01-11 14:50:10 +01005403 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005404 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005405 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005406 }
5407
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005408 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005409 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005410}
5411
Gilles Peskine449bd832023-01-11 14:50:10 +01005412psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5413 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005414{
Gilles Peskine449bd832023-01-11 14:50:10 +01005415 if (operation->alg == 0) {
5416 return PSA_ERROR_BAD_STATE;
5417 }
5418 if (capacity > operation->capacity) {
5419 return PSA_ERROR_INVALID_ARGUMENT;
5420 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005421 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005422 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005423}
5424
Przemek Stekiel69c46792022-06-10 12:59:51 +02005425#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005426/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005427static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5428 psa_algorithm_t kdf_alg,
5429 uint8_t *output,
5430 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005431{
Gilles Peskine449bd832023-01-11 14:50:10 +01005432 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5433 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005434 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005435 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005436#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005437 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005438#else
5439 const uint8_t last_block = 0xff;
5440#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005441
Gilles Peskine449bd832023-01-11 14:50:10 +01005442 if (hkdf->state < HKDF_STATE_KEYED ||
5443 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005444#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005445 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005446#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005447 )) {
5448 return PSA_ERROR_BAD_STATE;
5449 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005450 hkdf->state = HKDF_STATE_OUTPUT;
5451
Gilles Peskine449bd832023-01-11 14:50:10 +01005452 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005453 /* Copy what remains of the current block */
5454 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005455 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005456 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005457 }
5458 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005459 output += n;
5460 output_length -= n;
5461 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005462 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005463 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005464 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005465 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005466 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005467 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005468 * object was corrupted or if this function is called directly
5469 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005470 if (hkdf->block_number == last_block) {
5471 return PSA_ERROR_BAD_STATE;
5472 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005473
5474 /* We need a new block */
5475 ++hkdf->block_number;
5476 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005477
Gilles Peskine449bd832023-01-11 14:50:10 +01005478 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5479 hash_alg,
5480 hkdf->prk,
5481 hash_length);
5482 if (status != PSA_SUCCESS) {
5483 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005484 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005485
5486 if (hkdf->block_number != 1) {
5487 status = psa_mac_update(&hkdf->hmac,
5488 hkdf->output_block,
5489 hash_length);
5490 if (status != PSA_SUCCESS) {
5491 return status;
5492 }
5493 }
5494 status = psa_mac_update(&hkdf->hmac,
5495 hkdf->info,
5496 hkdf->info_length);
5497 if (status != PSA_SUCCESS) {
5498 return status;
5499 }
5500 status = psa_mac_update(&hkdf->hmac,
5501 &hkdf->block_number, 1);
5502 if (status != PSA_SUCCESS) {
5503 return status;
5504 }
5505 status = psa_mac_sign_finish(&hkdf->hmac,
5506 hkdf->output_block,
5507 sizeof(hkdf->output_block),
5508 &hmac_output_length);
5509 if (status != PSA_SUCCESS) {
5510 return status;
5511 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005512 }
5513
Gilles Peskine449bd832023-01-11 14:50:10 +01005514 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005515}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005516#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005517
John Durkop07cc04a2020-11-16 22:08:34 -08005518#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5519 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005520static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5521 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005522 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005523{
Gilles Peskine449bd832023-01-11 14:50:10 +01005524 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5525 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005526 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5527 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005528 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005529
Janos Follath7742fee2019-06-17 12:58:10 +01005530 /* We can't be wanting more output after block 0xff, otherwise
5531 * the capacity check in psa_key_derivation_output_bytes() would have
5532 * prevented this call. It could happen only if the operation
5533 * object was corrupted or if this function is called directly
5534 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005535 if (tls12_prf->block_number == 0xff) {
5536 return PSA_ERROR_CORRUPTION_DETECTED;
5537 }
Janos Follath7742fee2019-06-17 12:58:10 +01005538
5539 /* We need a new block */
5540 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005541 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005542
5543 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5544 *
5545 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5546 *
5547 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5548 * HMAC_hash(secret, A(2) + seed) +
5549 * HMAC_hash(secret, A(3) + seed) + ...
5550 *
5551 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005552 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005553 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005554 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005555 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005556 * is currently extracted as `output_block` and where i is
5557 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005558 */
5559
Gilles Peskine449bd832023-01-11 14:50:10 +01005560 status = psa_key_derivation_start_hmac(&hmac,
5561 hash_alg,
5562 tls12_prf->secret,
5563 tls12_prf->secret_length);
5564 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005565 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005566 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005567
5568 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005569 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005570 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5571 * the variable seed and in this instance means it in the context of the
5572 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005573 status = psa_mac_update(&hmac,
5574 tls12_prf->label,
5575 tls12_prf->label_length);
5576 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005577 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005578 }
5579 status = psa_mac_update(&hmac,
5580 tls12_prf->seed,
5581 tls12_prf->seed_length);
5582 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005583 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005584 }
5585 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005586 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005587 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5588 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005589 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005590 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005591 }
5592
Gilles Peskine449bd832023-01-11 14:50:10 +01005593 status = psa_mac_sign_finish(&hmac,
5594 tls12_prf->Ai, hash_length,
5595 &hmac_output_length);
5596 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005597 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005598 }
5599 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005600 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005601 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005602
5603 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005604 status = psa_key_derivation_start_hmac(&hmac,
5605 hash_alg,
5606 tls12_prf->secret,
5607 tls12_prf->secret_length);
5608 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005609 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005610 }
5611 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5612 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005613 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005614 }
5615 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5616 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005617 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005618 }
5619 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5620 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005621 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005622 }
5623 status = psa_mac_sign_finish(&hmac,
5624 tls12_prf->output_block, hash_length,
5625 &hmac_output_length);
5626 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005627 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005628 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005629
Janos Follath7742fee2019-06-17 12:58:10 +01005630
5631cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005632 cleanup_status = psa_mac_abort(&hmac);
5633 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005634 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005635 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005636
Gilles Peskine449bd832023-01-11 14:50:10 +01005637 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005638}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005639
Janos Follath844eb0e2019-06-19 12:10:49 +01005640static psa_status_t psa_key_derivation_tls12_prf_read(
5641 psa_tls12_prf_key_derivation_t *tls12_prf,
5642 psa_algorithm_t alg,
5643 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005644 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005645{
Gilles Peskine449bd832023-01-11 14:50:10 +01005646 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5647 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005648 psa_status_t status;
5649 uint8_t offset, length;
5650
Gilles Peskine449bd832023-01-11 14:50:10 +01005651 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005652 case PSA_TLS12_PRF_STATE_LABEL_SET:
5653 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5654 break;
5655 case PSA_TLS12_PRF_STATE_OUTPUT:
5656 break;
5657 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005658 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005659 }
5660
Gilles Peskine449bd832023-01-11 14:50:10 +01005661 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005662 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005663 if (tls12_prf->left_in_block == 0) {
5664 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5665 alg);
5666 if (status != PSA_SUCCESS) {
5667 return status;
5668 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005669
5670 continue;
5671 }
5672
Gilles Peskine449bd832023-01-11 14:50:10 +01005673 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005674 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005675 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005676 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005677 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005678
5679 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005680 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005681 output += length;
5682 output_length -= length;
5683 tls12_prf->left_in_block -= length;
5684 }
5685
Gilles Peskine449bd832023-01-11 14:50:10 +01005686 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005687}
John Durkop07cc04a2020-11-16 22:08:34 -08005688#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5689 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005690
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005691#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5692static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5693 psa_tls12_ecjpake_to_pms_t *ecjpake,
5694 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005695 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005696{
5697 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005698 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005699
Gilles Peskine449bd832023-01-11 14:50:10 +01005700 if (output_length != 32) {
5701 return PSA_ERROR_INVALID_ARGUMENT;
5702 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005703
Gilles Peskine449bd832023-01-11 14:50:10 +01005704 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5705 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5706 &output_size);
5707 if (status != PSA_SUCCESS) {
5708 return status;
5709 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005710
Gilles Peskine449bd832023-01-11 14:50:10 +01005711 if (output_size != output_length) {
5712 return PSA_ERROR_GENERIC_ERROR;
5713 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005714
Gilles Peskine449bd832023-01-11 14:50:10 +01005715 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005716}
5717#endif
5718
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305719#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305720static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5721 psa_pbkdf2_key_derivation_t *pbkdf2,
5722 psa_algorithm_t prf_alg,
5723 uint8_t prf_output_length,
5724 psa_key_attributes_t *attributes)
5725{
5726 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305727 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305728 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305729 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305730 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305731 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305732 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305733
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305734 mac_operation.is_sign = 1;
5735 mac_operation.mac_size = prf_output_length;
5736 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305737
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305738 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5739 attributes,
5740 pbkdf2->password,
5741 pbkdf2->password_length,
5742 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305743 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305744 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305745 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305746 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5747 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305748 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305749 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305750 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305751 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305752 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305753 }
5754 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5755 &mac_output_length);
5756 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305757 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305758 }
5759
5760 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305761 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305762 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305763 }
5764
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305765 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305766
5767 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305768 /* We are passing prf_output_length as mac_size because the driver
5769 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305770 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305771 status = psa_driver_wrapper_mac_compute(attributes,
5772 pbkdf2->password,
5773 pbkdf2->password_length,
5774 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305775 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305776 &mac_output_length);
5777 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305778 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305779 }
5780
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305781 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305782 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305783
5784cleanup:
5785 /* Zeroise buffers to clear sensitive data from memory. */
5786 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5787 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305788}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305789
5790static psa_status_t psa_key_derivation_pbkdf2_read(
5791 psa_pbkdf2_key_derivation_t *pbkdf2,
5792 psa_algorithm_t kdf_alg,
5793 uint8_t *output,
5794 size_t output_length)
5795{
5796 psa_status_t status;
5797 psa_algorithm_t prf_alg;
5798 uint8_t prf_output_length;
5799 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5800 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5801 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5802
5803 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5804 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5805 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5806 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305807 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5808 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305809 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305810 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305811 } else {
5812 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305813 }
5814
5815 switch (pbkdf2->state) {
5816 case PSA_PBKDF2_STATE_PASSWORD_SET:
5817 /* Initially we need a new block so bytes_used is equal to block size*/
5818 pbkdf2->bytes_used = prf_output_length;
5819 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5820 break;
5821 case PSA_PBKDF2_STATE_OUTPUT:
5822 break;
5823 default:
5824 return PSA_ERROR_BAD_STATE;
5825 }
5826
5827 while (output_length != 0) {
5828 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5829 if (n > output_length) {
5830 n = (uint8_t) output_length;
5831 }
5832 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5833 output += n;
5834 output_length -= n;
5835 pbkdf2->bytes_used += n;
5836
5837 if (output_length == 0) {
5838 break;
5839 }
5840
5841 /* We need a new block */
5842 pbkdf2->bytes_used = 0;
5843 pbkdf2->block_number++;
5844
5845 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5846 prf_output_length,
5847 &attributes);
5848 if (status != PSA_SUCCESS) {
5849 return status;
5850 }
5851 }
5852
5853 return PSA_SUCCESS;
5854}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305855#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305856
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005857psa_status_t psa_key_derivation_output_bytes(
5858 psa_key_derivation_operation_t *operation,
5859 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005860 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005861{
5862 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005863 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005864
Gilles Peskine449bd832023-01-11 14:50:10 +01005865 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005866 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005867 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005868 }
5869
Gilles Peskine449bd832023-01-11 14:50:10 +01005870 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005871 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005872 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005873 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005874 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005875 goto exit;
5876 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005877 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005878 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005879 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005880 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5881 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005882 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005883 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005884 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005885 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005886 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005887
Przemek Stekiel69c46792022-06-10 12:59:51 +02005888#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005889 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5890 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5891 output, output_length);
5892 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005893#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005894#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5895 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005896 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5897 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5898 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5899 kdf_alg, output,
5900 output_length);
5901 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005902#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5903 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005904#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005905 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005906 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005907 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5908 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005909#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305910#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305911 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305912 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5913 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305914 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305915#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005916
Gilles Peskineeab56e42018-07-12 17:12:33 +02005917 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005918 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005919 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005920 }
5921
5922exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005923 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005924 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005925 * This allows us to differentiate between exhausted operations and
5926 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5927 * operations. */
5928 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005929 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005930 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005931 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005932 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005933 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005934}
5935
David Brown7807bf72021-02-09 16:28:23 -07005936#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01005937static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02005938{
Gilles Peskine449bd832023-01-11 14:50:10 +01005939 if (data_size >= 8) {
5940 mbedtls_des_key_set_parity(data);
5941 }
5942 if (data_size >= 16) {
5943 mbedtls_des_key_set_parity(data + 8);
5944 }
5945 if (data_size >= 24) {
5946 mbedtls_des_key_set_parity(data + 16);
5947 }
Gilles Peskine08542d82018-07-19 17:05:42 +02005948}
David Brown7807bf72021-02-09 16:28:23 -07005949#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02005950
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005951/*
Gilles Peskine449bd832023-01-11 14:50:10 +01005952 * ECC keys on a Weierstrass elliptic curve require the generation
5953 * of a private key which is an integer
5954 * in the range [1, N - 1], where N is the boundary of the private key domain:
5955 * N is the prime p for Diffie-Hellman, or the order of the
5956 * curve’s base point for ECC.
5957 *
5958 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
5959 * This function generates the private key using the following process:
5960 *
5961 * 1. Draw a byte string of length ceiling(m/8) bytes.
5962 * 2. If m is not a multiple of 8, set the most significant
5963 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
5964 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
5965 * 4. If k > N - 2, discard the result and return to step 1.
5966 * 5. Output k + 1 as the private key.
5967 *
5968 * This method allows compliance to NIST standards, specifically the methods titled
5969 * Key-Pair Generation by Testing Candidates in the following publications:
5970 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
5971 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
5972 * Diffie-Hellman keys.
5973 *
5974 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
5975 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
5976 *
5977 * Note: Function allocates memory for *data buffer, so given *data should be
5978 * always NULL.
5979 */
Valerio Setti86587ab2023-06-27 13:09:30 +02005980#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
5981#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01005982static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005983 psa_key_slot_t *slot,
5984 size_t bits,
5985 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005986 uint8_t **data
5987 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005988{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01005989 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005990 mbedtls_mpi k;
5991 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01005992 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01005993 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005994 size_t m;
5995 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01005996
Gilles Peskine449bd832023-01-11 14:50:10 +01005997 mbedtls_mpi_init(&k);
5998 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01005999
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006000 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01006001 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006002 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01006003 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006004
Gilles Peskine449bd832023-01-11 14:50:10 +01006005 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006006 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01006007 goto cleanup;
6008 }
6009
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006010 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01006011 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006012
Gilles Peskine449bd832023-01-11 14:50:10 +01006013 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006014
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006015 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006016 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006017 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006018
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006019 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006020
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006021 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006022 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006023
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006024 /* Note: This function is always called with *data == NULL and it
6025 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006026 *data = mbedtls_calloc(1, m_bytes);
6027 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006028 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006029 goto cleanup;
6030 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006031
Gilles Peskine449bd832023-01-11 14:50:10 +01006032 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006033 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006034 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006035 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01006036 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006037
6038 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006039 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006040 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006041 * (8 * ceiling(m/8) - m) bits of the first byte in
6042 * the string to zero.
6043 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006044 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006045 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006046 }
6047
6048 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01006049 * big-endian byte string.
6050 */
6051 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006052
6053 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01006054 * Result of comparison is returned. When it indicates error
6055 * then this function is called again.
6056 */
6057 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006058 }
6059
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006060 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006061 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6062 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006063cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006064 if (ret != 0) {
6065 status = mbedtls_to_psa_error(ret);
6066 }
6067 if (status != PSA_SUCCESS) {
6068 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006069 *data = NULL;
6070 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006071 mbedtls_mpi_free(&k);
6072 mbedtls_mpi_free(&diff_N_2);
6073 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006074}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006075
6076/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6077 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6078 *
6079 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6080 * draw a 32-byte string and process it as specified in
6081 * Elliptic Curves for Security [RFC7748] §5.
6082 *
6083 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6084 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6085 *
6086 * Note: Function allocates memory for *data buffer, so given *data should be
6087 * always NULL.
6088 */
6089
6090static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6091 size_t bits,
6092 psa_key_derivation_operation_t *operation,
6093 uint8_t **data
6094 )
6095{
6096 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006097 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006098
Gilles Peskine449bd832023-01-11 14:50:10 +01006099 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006100 case 255:
6101 output_length = 32;
6102 break;
6103 case 448:
6104 output_length = 56;
6105 break;
6106 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006107 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006108 break;
6109 }
6110
Gilles Peskine449bd832023-01-11 14:50:10 +01006111 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006112
Gilles Peskine449bd832023-01-11 14:50:10 +01006113 if (*data == NULL) {
6114 return PSA_ERROR_INSUFFICIENT_MEMORY;
6115 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006116
Gilles Peskine449bd832023-01-11 14:50:10 +01006117 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006118
Gilles Peskine449bd832023-01-11 14:50:10 +01006119 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006120 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006121 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006122
Gilles Peskine449bd832023-01-11 14:50:10 +01006123 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006124 case 255:
6125 (*data)[0] &= 248;
6126 (*data)[31] &= 127;
6127 (*data)[31] |= 64;
6128 break;
6129 case 448:
6130 (*data)[0] &= 252;
6131 (*data)[55] |= 128;
6132 break;
6133 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006134 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006135 break;
6136 }
6137
6138 return status;
6139}
Valerio Setti86587ab2023-06-27 13:09:30 +02006140#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6141static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6142 psa_key_slot_t *slot, size_t bits,
6143 psa_key_derivation_operation_t *operation, uint8_t **data)
6144{
6145 (void) slot;
6146 (void) bits;
6147 (void) operation;
6148 (void) data;
6149 return PSA_ERROR_NOT_SUPPORTED;
6150}
6151
6152static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6153 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6154{
6155 (void) bits;
6156 (void) operation;
6157 (void) data;
6158 return PSA_ERROR_NOT_SUPPORTED;
6159}
6160#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6161#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006162
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006163static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006164 psa_key_slot_t *slot,
6165 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006166 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006167{
6168 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006169 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306170 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006171 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006172 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006173
Gilles Peskine449bd832023-01-11 14:50:10 +01006174 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6175 return PSA_ERROR_INVALID_ARGUMENT;
6176 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006177
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006178#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006179 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006180 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6181 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6182 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006183 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006184 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6185 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006186 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006187 }
6188 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006189 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6191 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006192 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006193 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006194 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006195 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006196#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006197 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006198 if (key_type_is_raw_bytes(slot->attr.type)) {
6199 if (bits % 8 != 0) {
6200 return PSA_ERROR_INVALID_ARGUMENT;
6201 }
6202 data = mbedtls_calloc(1, bytes);
6203 if (data == NULL) {
6204 return PSA_ERROR_INSUFFICIENT_MEMORY;
6205 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006206
Gilles Peskine449bd832023-01-11 14:50:10 +01006207 status = psa_key_derivation_output_bytes(operation, data, bytes);
6208 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006209 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006210 }
David Brown12ca5032021-02-11 11:02:00 -07006211#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006212 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6213 psa_des_set_key_parity(data, bytes);
6214 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006215#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006216 } else {
6217 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006218 }
Ronald Crondd04d422020-11-28 15:14:42 +01006219
Ronald Cronbf33c932020-11-28 18:06:53 +01006220 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006221 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006222 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006223 };
6224
Gilles Peskine449bd832023-01-11 14:50:10 +01006225 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6226 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6227 &storage_size);
6228 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306229 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006230 }
Archanad8a83dc2021-06-14 10:04:16 +05306231 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006232 status = psa_allocate_buffer_to_slot(slot, storage_size);
6233 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306234 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006235 }
Archanad8a83dc2021-06-14 10:04:16 +05306236
Gilles Peskine449bd832023-01-11 14:50:10 +01006237 status = psa_driver_wrapper_import_key(&attributes,
6238 data, bytes,
6239 slot->key.data,
6240 slot->key.bytes,
6241 &slot->key.bytes, &bits);
6242 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006243 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006244 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006245
6246exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006247 mbedtls_free(data);
6248 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006249}
6250
Gilles Peskine449bd832023-01-11 14:50:10 +01006251psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6252 psa_key_derivation_operation_t *operation,
6253 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006254{
6255 psa_status_t status;
6256 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006257 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006258
Ronald Cron81709fc2020-11-14 12:10:32 +01006259 *key = MBEDTLS_SVC_KEY_ID_INIT;
6260
Gilles Peskine0f84d622019-09-12 19:03:13 +02006261 /* Reject any attempt to create a zero-length key so that we don't
6262 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006263 if (psa_get_key_bits(attributes) == 0) {
6264 return PSA_ERROR_INVALID_ARGUMENT;
6265 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006266
Gilles Peskine449bd832023-01-11 14:50:10 +01006267 if (operation->alg == PSA_ALG_NONE) {
6268 return PSA_ERROR_BAD_STATE;
6269 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006270
Gilles Peskine449bd832023-01-11 14:50:10 +01006271 if (!operation->can_output_key) {
6272 return PSA_ERROR_NOT_PERMITTED;
6273 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006274
Gilles Peskine449bd832023-01-11 14:50:10 +01006275 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6276 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006277#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006278 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006279 /* Deriving a key in a secure element is not implemented yet. */
6280 status = PSA_ERROR_NOT_SUPPORTED;
6281 }
6282#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006283 if (status == PSA_SUCCESS) {
6284 status = psa_generate_derived_key_internal(slot,
6285 attributes->core.bits,
6286 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006287 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006288 if (status == PSA_SUCCESS) {
6289 status = psa_finish_key_creation(slot, driver, key);
6290 }
6291 if (status != PSA_SUCCESS) {
6292 psa_fail_key_creation(slot, driver);
6293 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006294
Gilles Peskine449bd832023-01-11 14:50:10 +01006295 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006296}
6297
Gilles Peskineeab56e42018-07-12 17:12:33 +02006298
6299
6300/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006301/* Key derivation */
6302/****************************************************************/
6303
Steven Cooreman932ffb72021-02-15 12:14:32 +01006304#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006305static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006306{
6307#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006308 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6309 return 1;
6310 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006311#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006312#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006313 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6314 return 1;
6315 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006316#endif
6317#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006318 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6319 return 1;
6320 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006321#endif
6322#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6324 return 1;
6325 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006326#endif
6327#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006328 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6329 return 1;
6330 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006331#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006332#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006333 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6334 return 1;
6335 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006336#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306337#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6338 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6339 return 1;
6340 }
6341#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306342#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6343 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6344 return 1;
6345 }
6346#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006347 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006348}
6349
Gilles Peskine449bd832023-01-11 14:50:10 +01006350static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006351{
6352 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006353 psa_status_t status = psa_hash_setup(&operation, alg);
6354 psa_hash_abort(&operation);
6355 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006356}
6357
Gilles Peskine969c5d62019-01-16 15:53:06 +01006358static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006359 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006360 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006361{
Janos Follath5fe19732019-06-20 15:09:30 +01006362 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6363 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006364 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006365
Gilles Peskine969c5d62019-01-16 15:53:06 +01006366 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006367 if (!is_kdf_alg_supported(kdf_alg)) {
6368 return PSA_ERROR_NOT_SUPPORTED;
6369 }
John Durkop07cc04a2020-11-16 22:08:34 -08006370
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006371 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306372 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006373 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6374 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306375 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6376 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6377 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306378 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306379 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006380 if (hash_size == 0) {
6381 return PSA_ERROR_NOT_SUPPORTED;
6382 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006383
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006384 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6385 * we might fail later, which is somewhat unfriendly and potentially
6386 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006387 psa_status_t status = psa_hash_try_support(hash_alg);
6388 if (status != PSA_SUCCESS) {
6389 return status;
6390 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006391 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006392
Gilles Peskine449bd832023-01-11 14:50:10 +01006393 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6394 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6395 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6396 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006397 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006398#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006399 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006400 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6401 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006402 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006403 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006404#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6405 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006406 operation->capacity = 255 * hash_size;
6407 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006408}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006409
Gilles Peskine449bd832023-01-11 14:50:10 +01006410static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006411{
6412#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006413 if (alg == PSA_ALG_ECDH) {
6414 return PSA_SUCCESS;
6415 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006416#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006417#if defined(PSA_WANT_ALG_FFDH)
6418 if (alg == PSA_ALG_FFDH) {
6419 return PSA_SUCCESS;
6420 }
6421#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006422 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006423 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006424}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006425
6426static int psa_key_derivation_allows_free_form_secret_input(
6427 psa_algorithm_t kdf_alg)
6428{
6429#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6430 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6431 return 0;
6432 }
6433#endif
6434 (void) kdf_alg;
6435 return 1;
6436}
John Durkop07cc04a2020-11-16 22:08:34 -08006437#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006438
Gilles Peskine449bd832023-01-11 14:50:10 +01006439psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6440 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006441{
6442 psa_status_t status;
6443
Gilles Peskine449bd832023-01-11 14:50:10 +01006444 if (operation->alg != 0) {
6445 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006446 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006447
Gilles Peskine449bd832023-01-11 14:50:10 +01006448 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6449 return PSA_ERROR_INVALID_ARGUMENT;
6450 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6451#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6452 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6453 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6454 status = psa_key_agreement_try_support(ka_alg);
6455 if (status != PSA_SUCCESS) {
6456 return status;
6457 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006458 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6459 return PSA_ERROR_INVALID_ARGUMENT;
6460 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006461 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6462#else
6463 return PSA_ERROR_NOT_SUPPORTED;
6464#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6465 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6466#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6467 status = psa_key_derivation_setup_kdf(operation, alg);
6468#else
6469 return PSA_ERROR_NOT_SUPPORTED;
6470#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6471 } else {
6472 return PSA_ERROR_INVALID_ARGUMENT;
6473 }
6474
6475 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006476 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006477 }
6478 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006479}
6480
Przemek Stekiel69c46792022-06-10 12:59:51 +02006481#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006482static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6483 psa_algorithm_t kdf_alg,
6484 psa_key_derivation_step_t step,
6485 const uint8_t *data,
6486 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006487{
Gilles Peskine449bd832023-01-11 14:50:10 +01006488 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006489 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006490 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006491 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006492#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006493 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6494 return PSA_ERROR_INVALID_ARGUMENT;
6495 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006496#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006497 if (hkdf->state != HKDF_STATE_INIT) {
6498 return PSA_ERROR_BAD_STATE;
6499 } else {
6500 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6501 hash_alg,
6502 data, data_length);
6503 if (status != PSA_SUCCESS) {
6504 return status;
6505 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006506 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006507 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006508 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006509 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006510#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006511 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006512 /* We shouldn't be in different state as HKDF_EXPAND only allows
6513 * two inputs: SECRET (this case) and INFO which does not modify
6514 * the state. It could happen only if the hkdf
6515 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006516 if (hkdf->state != HKDF_STATE_INIT) {
6517 return PSA_ERROR_BAD_STATE;
6518 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006519
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006520 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006521 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6522 return PSA_ERROR_INVALID_ARGUMENT;
6523 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006524
Gilles Peskine449bd832023-01-11 14:50:10 +01006525 memcpy(hkdf->prk, data, data_length);
6526 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006527#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006528 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006529 /* HKDF: If no salt was provided, use an empty salt.
6530 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006531 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006532#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006533 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6534 return PSA_ERROR_BAD_STATE;
6535 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006536#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006537 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6538 hash_alg,
6539 NULL, 0);
6540 if (status != PSA_SUCCESS) {
6541 return status;
6542 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006543 hkdf->state = HKDF_STATE_STARTED;
6544 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006545 if (hkdf->state != HKDF_STATE_STARTED) {
6546 return PSA_ERROR_BAD_STATE;
6547 }
6548 status = psa_mac_update(&hkdf->hmac,
6549 data, data_length);
6550 if (status != PSA_SUCCESS) {
6551 return status;
6552 }
6553 status = psa_mac_sign_finish(&hkdf->hmac,
6554 hkdf->prk,
6555 sizeof(hkdf->prk),
6556 &data_length);
6557 if (status != PSA_SUCCESS) {
6558 return status;
6559 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006560 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006561
Gilles Peskine2b522db2019-04-12 15:11:49 +02006562 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006563 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006564#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006565 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006566 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006567 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006568 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006569 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006570#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006571 {
6572 /* Block 0 is empty, and the next block will be
6573 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006574 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006575 }
6576
Gilles Peskine449bd832023-01-11 14:50:10 +01006577 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006578 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006579#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006580 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6581 return PSA_ERROR_INVALID_ARGUMENT;
6582 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006583#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006584#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006585 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6586 hkdf->state == HKDF_STATE_INIT) {
6587 return PSA_ERROR_BAD_STATE;
6588 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006589#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006590 if (hkdf->state == HKDF_STATE_OUTPUT) {
6591 return PSA_ERROR_BAD_STATE;
6592 }
6593 if (hkdf->info_set) {
6594 return PSA_ERROR_BAD_STATE;
6595 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006596 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006597 if (data_length != 0) {
6598 hkdf->info = mbedtls_calloc(1, data_length);
6599 if (hkdf->info == NULL) {
6600 return PSA_ERROR_INSUFFICIENT_MEMORY;
6601 }
6602 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006603 }
6604 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006605 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006606 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006607 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006608 }
6609}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006610#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006611
John Durkop07cc04a2020-11-16 22:08:34 -08006612#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6613 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006614static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6615 const uint8_t *data,
6616 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006617{
Gilles Peskine449bd832023-01-11 14:50:10 +01006618 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6619 return PSA_ERROR_BAD_STATE;
6620 }
Janos Follathf08e2652019-06-13 09:05:41 +01006621
Gilles Peskine449bd832023-01-11 14:50:10 +01006622 if (data_length != 0) {
6623 prf->seed = mbedtls_calloc(1, data_length);
6624 if (prf->seed == NULL) {
6625 return PSA_ERROR_INSUFFICIENT_MEMORY;
6626 }
Janos Follathf08e2652019-06-13 09:05:41 +01006627
Gilles Peskine449bd832023-01-11 14:50:10 +01006628 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006629 prf->seed_length = data_length;
6630 }
Janos Follathf08e2652019-06-13 09:05:41 +01006631
Gilles Peskine43f958b2020-12-13 14:55:14 +01006632 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006633
Gilles Peskine449bd832023-01-11 14:50:10 +01006634 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006635}
6636
Gilles Peskine449bd832023-01-11 14:50:10 +01006637static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6638 const uint8_t *data,
6639 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006640{
Gilles Peskine449bd832023-01-11 14:50:10 +01006641 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6642 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6643 return PSA_ERROR_BAD_STATE;
6644 }
Janos Follath81550542019-06-13 14:26:34 +01006645
Gilles Peskine449bd832023-01-11 14:50:10 +01006646 if (data_length != 0) {
6647 prf->secret = mbedtls_calloc(1, data_length);
6648 if (prf->secret == NULL) {
6649 return PSA_ERROR_INSUFFICIENT_MEMORY;
6650 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006651
Gilles Peskine449bd832023-01-11 14:50:10 +01006652 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006653 prf->secret_length = data_length;
6654 }
Janos Follath81550542019-06-13 14:26:34 +01006655
Gilles Peskine43f958b2020-12-13 14:55:14 +01006656 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006657
Gilles Peskine449bd832023-01-11 14:50:10 +01006658 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006659}
6660
Gilles Peskine449bd832023-01-11 14:50:10 +01006661static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6662 const uint8_t *data,
6663 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006664{
Gilles Peskine449bd832023-01-11 14:50:10 +01006665 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6666 return PSA_ERROR_BAD_STATE;
6667 }
Janos Follath63028dd2019-06-13 09:15:47 +01006668
Gilles Peskine449bd832023-01-11 14:50:10 +01006669 if (data_length != 0) {
6670 prf->label = mbedtls_calloc(1, data_length);
6671 if (prf->label == NULL) {
6672 return PSA_ERROR_INSUFFICIENT_MEMORY;
6673 }
Janos Follath63028dd2019-06-13 09:15:47 +01006674
Gilles Peskine449bd832023-01-11 14:50:10 +01006675 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006676 prf->label_length = data_length;
6677 }
Janos Follath63028dd2019-06-13 09:15:47 +01006678
Gilles Peskine43f958b2020-12-13 14:55:14 +01006679 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006680
Gilles Peskine449bd832023-01-11 14:50:10 +01006681 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006682}
6683
Gilles Peskine449bd832023-01-11 14:50:10 +01006684static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6685 psa_key_derivation_step_t step,
6686 const uint8_t *data,
6687 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006688{
Gilles Peskine449bd832023-01-11 14:50:10 +01006689 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006690 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006691 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006692 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006693 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006694 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006695 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006696 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006697 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006698 }
6699}
John Durkop07cc04a2020-11-16 22:08:34 -08006700#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6701 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6702
6703#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6704static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6705 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006706 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006707 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006708{
6709 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006710 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6711 4 + data_length + prf->other_secret_length :
6712 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006713
Gilles Peskine449bd832023-01-11 14:50:10 +01006714 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6715 return PSA_ERROR_INVALID_ARGUMENT;
6716 }
John Durkop07cc04a2020-11-16 22:08:34 -08006717
Gilles Peskine449bd832023-01-11 14:50:10 +01006718 uint8_t *pms = mbedtls_calloc(1, pms_len);
6719 if (pms == NULL) {
6720 return PSA_ERROR_INSUFFICIENT_MEMORY;
6721 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006722 uint8_t *cur = pms;
6723
6724 /* pure-PSK:
6725 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006726 *
6727 * The premaster secret is formed as follows: if the PSK is N octets
6728 * long, concatenate a uint16 with the value N, N zero octets, a second
6729 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006730 *
6731 * mixed-PSK:
6732 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6733 * follows: concatenate a uint16 with the length of the other secret,
6734 * the other secret itself, uint16 with the length of PSK, and the
6735 * PSK itself.
6736 * For details please check:
6737 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6738 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6739 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006740 */
6741
Gilles Peskine449bd832023-01-11 14:50:10 +01006742 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6743 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6744 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6745 if (prf->other_secret_length != 0) {
6746 memcpy(cur, prf->other_secret, prf->other_secret_length);
6747 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006748 cur += prf->other_secret_length;
6749 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006750 } else {
6751 *cur++ = MBEDTLS_BYTE_1(data_length);
6752 *cur++ = MBEDTLS_BYTE_0(data_length);
6753 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006754 cur += data_length;
6755 }
6756
Gilles Peskine449bd832023-01-11 14:50:10 +01006757 *cur++ = MBEDTLS_BYTE_1(data_length);
6758 *cur++ = MBEDTLS_BYTE_0(data_length);
6759 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006760 cur += data_length;
6761
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006762 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006763
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006764 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006765 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006766}
Janos Follath6660f0e2019-06-17 08:44:03 +01006767
Przemek Stekiele47201b2022-04-19 13:53:28 +02006768static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6769 psa_tls12_prf_key_derivation_t *prf,
6770 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006771 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006772{
Gilles Peskine449bd832023-01-11 14:50:10 +01006773 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6774 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006775 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006776
6777 if (data_length != 0) {
6778 prf->other_secret = mbedtls_calloc(1, data_length);
6779 if (prf->other_secret == NULL) {
6780 return PSA_ERROR_INSUFFICIENT_MEMORY;
6781 }
6782
6783 memcpy(prf->other_secret, data, data_length);
6784 prf->other_secret_length = data_length;
6785 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006786 prf->other_secret_length = 0;
6787 }
6788
6789 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6790
Gilles Peskine449bd832023-01-11 14:50:10 +01006791 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006792}
6793
Janos Follath6660f0e2019-06-17 08:44:03 +01006794static psa_status_t psa_tls12_prf_psk_to_ms_input(
6795 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006796 psa_key_derivation_step_t step,
6797 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006798 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006799{
Gilles Peskine449bd832023-01-11 14:50:10 +01006800 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006801 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006802 return psa_tls12_prf_psk_to_ms_set_key(prf,
6803 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006804 break;
6805 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006806 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6807 data,
6808 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006809 break;
6810 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006811 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006812 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006813
Przemek Stekiele47201b2022-04-19 13:53:28 +02006814 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006815}
John Durkop07cc04a2020-11-16 22:08:34 -08006816#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006817
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006818#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6819static psa_status_t psa_tls12_ecjpake_to_pms_input(
6820 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006821 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006822 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006823 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006824{
Gilles Peskine449bd832023-01-11 14:50:10 +01006825 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6826 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6827 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006828 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006829
6830 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006831 if (data[0] != 0x04) {
6832 return PSA_ERROR_INVALID_ARGUMENT;
6833 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006834
6835 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006836 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006837
Gilles Peskine449bd832023-01-11 14:50:10 +01006838 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006839}
6840#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306841
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306842#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306843static psa_status_t psa_pbkdf2_set_input_cost(
6844 psa_pbkdf2_key_derivation_t *pbkdf2,
6845 psa_key_derivation_step_t step,
6846 uint64_t data)
6847{
6848 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6849 return PSA_ERROR_INVALID_ARGUMENT;
6850 }
6851
6852 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6853 return PSA_ERROR_BAD_STATE;
6854 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306855
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306856 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306857 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306858 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306859
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306860 if (data == 0) {
6861 return PSA_ERROR_INVALID_ARGUMENT;
6862 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306863
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306864 pbkdf2->input_cost = data;
6865 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6866
6867 return PSA_SUCCESS;
6868}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306869
6870static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6871 const uint8_t *data,
6872 size_t data_length)
6873{
Gilles Peskineead17662023-08-20 22:02:51 +02006874 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6875 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6876 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6877 /* Appending to existing salt. No state change. */
6878 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306879 return PSA_ERROR_BAD_STATE;
6880 }
6881
Gilles Peskineca57d782023-07-20 19:08:06 +02006882 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006883 /* Appending an empty string, nothing to do. */
6884 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306885 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306886
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306887 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6888 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306889 return PSA_ERROR_INSUFFICIENT_MEMORY;
6890 }
6891
Gilles Peskineead17662023-08-20 22:02:51 +02006892 if (pbkdf2->salt_length != 0) {
6893 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6894 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306895 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306896 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306897 mbedtls_free(pbkdf2->salt);
6898 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306899 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306900 return PSA_SUCCESS;
6901}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306902
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306903#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306904static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306905 const uint8_t *input,
6906 size_t input_len,
6907 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306908 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306909{
6910 psa_status_t status = PSA_SUCCESS;
6911 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6912 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306913 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306914 } else {
6915 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306916 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306917 }
6918 return status;
6919}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306920#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306921
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306922#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306923static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6924 size_t input_len,
6925 uint8_t *output,
6926 size_t *output_len)
6927{
6928 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306929 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306930 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05306931 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306932 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
6933 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
6934 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306935 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306936 * mac_size as the driver function sets mac_output_length = mac_size
6937 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306938 status = psa_driver_wrapper_mac_compute(&attributes,
6939 zeros, sizeof(zeros),
6940 PSA_ALG_CMAC, input, input_len,
6941 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306942 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
6943 128U,
6944 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306945 output_len);
6946 } else {
6947 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306948 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306949 }
6950 return status;
6951}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306952#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306953
6954static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306955 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306956 const uint8_t *data,
6957 size_t data_length)
6958{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306959 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306960 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
6961 return PSA_ERROR_BAD_STATE;
6962 }
6963
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306964#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306965 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6966 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
6967 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
6968 pbkdf2->password,
6969 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306970 } else
6971#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
6972#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6973 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306974 status = psa_pbkdf2_cmac_set_password(data, data_length,
6975 pbkdf2->password,
6976 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05306977 } else
6978#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
6979 {
6980 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306981 }
6982
6983 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
6984
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306985 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306986}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306987
6988static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306989 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306990 psa_key_derivation_step_t step,
6991 const uint8_t *data,
6992 size_t data_length)
6993{
6994 switch (step) {
6995 case PSA_KEY_DERIVATION_INPUT_SALT:
6996 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
6997 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306998 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05306999 default:
7000 return PSA_ERROR_INVALID_ARGUMENT;
7001 }
7002}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307003#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307004
Gilles Peskineb8965192019-09-24 16:21:10 +02007005/** Check whether the given key type is acceptable for the given
7006 * input step of a key derivation.
7007 *
7008 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
7009 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
7010 * Both secret and non-secret inputs can alternatively have the type
7011 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
7012 * that the input was passed as a buffer rather than via a key object.
7013 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02007014static int psa_key_derivation_check_input_type(
7015 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007016 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02007017{
Gilles Peskine449bd832023-01-11 14:50:10 +01007018 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007019 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007020 if (key_type == PSA_KEY_TYPE_DERIVE) {
7021 return PSA_SUCCESS;
7022 }
7023 if (key_type == PSA_KEY_TYPE_NONE) {
7024 return PSA_SUCCESS;
7025 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007026 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02007027 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007028 if (key_type == PSA_KEY_TYPE_DERIVE) {
7029 return PSA_SUCCESS;
7030 }
7031 if (key_type == PSA_KEY_TYPE_NONE) {
7032 return PSA_SUCCESS;
7033 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02007034 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007035 case PSA_KEY_DERIVATION_INPUT_LABEL:
7036 case PSA_KEY_DERIVATION_INPUT_SALT:
7037 case PSA_KEY_DERIVATION_INPUT_INFO:
7038 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01007039 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
7040 return PSA_SUCCESS;
7041 }
7042 if (key_type == PSA_KEY_TYPE_NONE) {
7043 return PSA_SUCCESS;
7044 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007045 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307046 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
7047 if (key_type == PSA_KEY_TYPE_PASSWORD) {
7048 return PSA_SUCCESS;
7049 }
7050 if (key_type == PSA_KEY_TYPE_DERIVE) {
7051 return PSA_SUCCESS;
7052 }
7053 if (key_type == PSA_KEY_TYPE_NONE) {
7054 return PSA_SUCCESS;
7055 }
7056 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007057 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007058 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007059}
7060
Janos Follathb80a94e2019-06-12 15:54:46 +01007061static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007062 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007063 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007064 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007065 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007066 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007067{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007068 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007069 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007070
Gilles Peskine449bd832023-01-11 14:50:10 +01007071 status = psa_key_derivation_check_input_type(step, key_type);
7072 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007073 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007074 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007075
Przemek Stekiel69c46792022-06-10 12:59:51 +02007076#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007077 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7078 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7079 step, data, data_length);
7080 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007081#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007082#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007083 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7084 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7085 step, data, data_length);
7086 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007087#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7088#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007089 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7090 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7091 step, data, data_length);
7092 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007093#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007094#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007095 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007096 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007097 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7098 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007099#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307100#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307101 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307102 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7103 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307104 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307105#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007106 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007107 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007108 (void) data;
7109 (void) data_length;
7110 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007111 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007112 }
7113
Gilles Peskine224b0d62019-09-23 18:13:17 +02007114exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007115 if (status != PSA_SUCCESS) {
7116 psa_key_derivation_abort(operation);
7117 }
7118 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007119}
7120
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307121static psa_status_t psa_key_derivation_input_integer_internal(
7122 psa_key_derivation_operation_t *operation,
7123 psa_key_derivation_step_t step,
7124 uint64_t value)
7125{
7126 psa_status_t status;
7127 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7128
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307129#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307130 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307131 status = psa_pbkdf2_set_input_cost(
7132 &operation->ctx.pbkdf2, step, value);
7133 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307134#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307135 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307136 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307137 (void) value;
7138 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307139 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307140 }
7141
7142 if (status != PSA_SUCCESS) {
7143 psa_key_derivation_abort(operation);
7144 }
7145 return status;
7146}
7147
Janos Follath51f4a0f2019-06-14 11:35:55 +01007148psa_status_t psa_key_derivation_input_bytes(
7149 psa_key_derivation_operation_t *operation,
7150 psa_key_derivation_step_t step,
7151 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007152 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007153{
Gilles Peskine449bd832023-01-11 14:50:10 +01007154 return psa_key_derivation_input_internal(operation, step,
7155 PSA_KEY_TYPE_NONE,
7156 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007157}
7158
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307159psa_status_t psa_key_derivation_input_integer(
7160 psa_key_derivation_operation_t *operation,
7161 psa_key_derivation_step_t step,
7162 uint64_t value)
7163{
7164 return psa_key_derivation_input_integer_internal(operation, step, value);
7165}
7166
Janos Follath51f4a0f2019-06-14 11:35:55 +01007167psa_status_t psa_key_derivation_input_key(
7168 psa_key_derivation_operation_t *operation,
7169 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007170 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007171{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007172 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007173 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007174 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007175
Ronald Cron5c522922020-11-14 16:35:34 +01007176 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007177 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7178 if (status != PSA_SUCCESS) {
7179 psa_key_derivation_abort(operation);
7180 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007181 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007182
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307183 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7184 * permission to output to a key object. */
7185 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7186 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007187 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007188 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007189
Gilles Peskine449bd832023-01-11 14:50:10 +01007190 status = psa_key_derivation_input_internal(operation,
7191 step, slot->attr.type,
7192 slot->key.data,
7193 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007194
Ryan Everett1b70a072024-01-04 10:32:49 +00007195 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007196
Gilles Peskine449bd832023-01-11 14:50:10 +01007197 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007198}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007199
7200
7201
7202/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007203/* Key agreement */
7204/****************************************************************/
7205
Gilles Peskine449bd832023-01-11 14:50:10 +01007206psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7207 const uint8_t *key_buffer,
7208 size_t key_buffer_size,
7209 psa_algorithm_t alg,
7210 const uint8_t *peer_key,
7211 size_t peer_key_length,
7212 uint8_t *shared_secret,
7213 size_t shared_secret_size,
7214 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007215{
Gilles Peskine449bd832023-01-11 14:50:10 +01007216 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007217#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007218 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007219 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7220 key_buffer_size, alg,
7221 peer_key, peer_key_length,
7222 shared_secret,
7223 shared_secret_size,
7224 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007225#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007226
7227#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7228 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007229 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007230 peer_key,
7231 peer_key_length,
7232 key_buffer,
7233 key_buffer_size,
7234 shared_secret,
7235 shared_secret_size,
7236 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007237#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7238
Gilles Peskine01d718c2018-09-18 12:01:02 +02007239 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007240 (void) attributes;
7241 (void) key_buffer;
7242 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007243 (void) peer_key;
7244 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007245 (void) shared_secret;
7246 (void) shared_secret_size;
7247 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007248 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007249 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007250}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007251
Aditya Deshpande17845b82022-10-13 17:21:01 +01007252/** Internal function for raw key agreement
7253 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007254 * to the driver's implementation if a driver is present.
7255 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007256 * (psa_key_agreement_raw_builtin).
7257 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007258static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7259 psa_key_slot_t *private_key,
7260 const uint8_t *peer_key,
7261 size_t peer_key_length,
7262 uint8_t *shared_secret,
7263 size_t shared_secret_size,
7264 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007265{
Gilles Peskine449bd832023-01-11 14:50:10 +01007266 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7267 return PSA_ERROR_NOT_SUPPORTED;
7268 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007269
7270 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007271 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007272 };
7273
Gilles Peskine449bd832023-01-11 14:50:10 +01007274 return psa_driver_wrapper_key_agreement(&attributes,
7275 private_key->key.data,
7276 private_key->key.bytes, alg,
7277 peer_key, peer_key_length,
7278 shared_secret,
7279 shared_secret_size,
7280 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007281}
7282
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007283/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007284 * to potentially free embedded data structures and wipe confidential data.
7285 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007286static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7287 psa_key_derivation_step_t step,
7288 psa_key_slot_t *private_key,
7289 const uint8_t *peer_key,
7290 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007291{
7292 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007293 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007294 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007295 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007296
7297 /* Step 1: run the secret agreement algorithm to generate the shared
7298 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007299 status = psa_key_agreement_raw_internal(ka_alg,
7300 private_key,
7301 peer_key, peer_key_length,
7302 shared_secret,
7303 sizeof(shared_secret),
7304 &shared_secret_length);
7305 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007306 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007307 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007308
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007309 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007310 * the shared secret. A shared secret is permitted wherever a key
7311 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007312 status = psa_key_derivation_input_internal(operation, step,
7313 PSA_KEY_TYPE_DERIVE,
7314 shared_secret,
7315 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007316exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007317 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7318 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007319}
7320
Gilles Peskine449bd832023-01-11 14:50:10 +01007321psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7322 psa_key_derivation_step_t step,
7323 mbedtls_svc_key_id_t private_key,
7324 const uint8_t *peer_key,
7325 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007326{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007327 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007328 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007329 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007330
Gilles Peskine449bd832023-01-11 14:50:10 +01007331 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7332 return PSA_ERROR_INVALID_ARGUMENT;
7333 }
Ronald Cron5c522922020-11-14 16:35:34 +01007334 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007335 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7336 if (status != PSA_SUCCESS) {
7337 return status;
7338 }
7339 status = psa_key_agreement_internal(operation, step,
7340 slot,
7341 peer_key, peer_key_length);
7342 if (status != PSA_SUCCESS) {
7343 psa_key_derivation_abort(operation);
7344 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007345 /* If a private key has been added as SECRET, we allow the derived
7346 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007347 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007348 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007349 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007350 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007351
Ryan Everett1b70a072024-01-04 10:32:49 +00007352 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007353
Gilles Peskine449bd832023-01-11 14:50:10 +01007354 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007355}
7356
Gilles Peskine449bd832023-01-11 14:50:10 +01007357psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7358 mbedtls_svc_key_id_t private_key,
7359 const uint8_t *peer_key,
7360 size_t peer_key_length,
7361 uint8_t *output,
7362 size_t output_size,
7363 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007364{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007365 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007366 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007367 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007368 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007369
Gilles Peskine449bd832023-01-11 14:50:10 +01007370 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007371 status = PSA_ERROR_INVALID_ARGUMENT;
7372 goto exit;
7373 }
Ronald Cron5c522922020-11-14 16:35:34 +01007374 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007375 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7376 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007377 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007378 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007379
Gilles Peskine3e561302022-04-14 00:17:15 +02007380 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7381 * for the output size. The PSA specification only guarantees that this
7382 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7383 * but it might be nice to allow smaller buffers if the output fits.
7384 * At the time of writing this comment, with only ECDH implemented,
7385 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7386 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7387 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007388 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007389 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7390 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007391 status = PSA_ERROR_BUFFER_TOO_SMALL;
7392 goto exit;
7393 }
7394
Gilles Peskine449bd832023-01-11 14:50:10 +01007395 status = psa_key_agreement_raw_internal(alg, slot,
7396 peer_key, peer_key_length,
7397 output, output_size,
7398 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007399
7400exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007401 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007402 /* If an error happens and is not handled properly, the output
7403 * may be used as a key to protect sensitive data. Arrange for such
7404 * a key to be random, which is likely to result in decryption or
7405 * verification errors. This is better than filling the buffer with
7406 * some constant data such as zeros, which would result in the data
7407 * being protected with a reproducible, easily knowable key.
7408 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007409 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007410 *output_length = output_size;
7411 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007412
Ryan Everett1b70a072024-01-04 10:32:49 +00007413 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007414
Gilles Peskine449bd832023-01-11 14:50:10 +01007415 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007416}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007417
7418
Gilles Peskine30524eb2020-11-13 17:02:26 +01007419
Gilles Peskine86a440b2018-11-12 18:39:40 +01007420/****************************************************************/
7421/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007422/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007423
Gilles Peskine672a7712023-04-28 21:00:28 +02007424#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7425#include "entropy_poll.h"
7426#endif
7427
Gilles Peskine30524eb2020-11-13 17:02:26 +01007428/** Initialize the PSA random generator.
7429 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007430static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007431{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007432#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007433 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007434#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7435
Gilles Peskine30524eb2020-11-13 17:02:26 +01007436 /* Set default configuration if
7437 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007438 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007439 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007440 }
7441 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007442 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007443 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007444
Gilles Peskine449bd832023-01-11 14:50:10 +01007445 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007446#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7447 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7448 /* The PSA entropy injection feature depends on using NV seed as an entropy
7449 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007450 mbedtls_entropy_add_source(&rng->entropy,
7451 mbedtls_nv_seed_poll, NULL,
7452 MBEDTLS_ENTROPY_BLOCK_SIZE,
7453 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007454#endif
7455
Gilles Peskine449bd832023-01-11 14:50:10 +01007456 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007457#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007458}
7459
7460/** Deinitialize the PSA random generator.
7461 */
Valerio Setti83e0de82023-11-24 12:13:05 +01007462static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007463{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007464#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Valerio Setti83e0de82023-11-24 12:13:05 +01007465 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007466#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Valerio Setti83e0de82023-11-24 12:13:05 +01007467 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7468 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007469#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007470}
7471
7472/** Seed the PSA random generator.
7473 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007474static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007475{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007476#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7477 /* Do nothing: the external RNG seeds itself. */
7478 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007479 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007480#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007481 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007482 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7483 drbg_seed, sizeof(drbg_seed) - 1);
7484 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007485#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007486}
7487
Gilles Peskine449bd832023-01-11 14:50:10 +01007488psa_status_t psa_generate_random(uint8_t *output,
7489 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007490{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007491 GUARD_MODULE_INITIALIZED;
7492
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007493#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7494
7495 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007496 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7497 output, output_size,
7498 &output_length);
7499 if (status != PSA_SUCCESS) {
7500 return status;
7501 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007502 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007503 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 if (output_length != output_size) {
7505 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7506 }
7507 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007508
7509#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7510
Gilles Peskine449bd832023-01-11 14:50:10 +01007511 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007512 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007513 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7514 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7515 output_size);
7516 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7517 output, request_size);
7518 if (ret != 0) {
7519 return mbedtls_to_psa_error(ret);
7520 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007521 output_size -= request_size;
7522 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007523 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007524 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007525#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007526}
7527
Gilles Peskine8814fc42020-12-14 15:33:44 +01007528/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007529 *
7530 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7531 * `psa_generate_random(...)`. The state parameter is ignored since the
7532 * PSA API doesn't support passing an explicit state.
7533 *
7534 * In the non-external case, psa_generate_random() calls an
7535 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7536 * and semantics as mbedtls_psa_get_random(). As an optimization,
7537 * instead of doing this back-and-forth between the PSA API and the
7538 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7539 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007540 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007541#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7542int mbedtls_psa_get_random(void *p_rng,
7543 unsigned char *output,
7544 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007545{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007546 /* This function takes a pointer to the RNG state because that's what
7547 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7548 * its own state internally and doesn't let the caller access that state.
7549 * So we just ignore the state parameter, and in practice we'll pass
7550 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007551 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007552 psa_status_t status = psa_generate_random(output, output_size);
7553 if (status == PSA_SUCCESS) {
7554 return 0;
7555 } else {
7556 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7557 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007558}
7559#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7560
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007561#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007562psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7563 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007564{
Gilles Peskine449bd832023-01-11 14:50:10 +01007565 if (global_data.initialized) {
7566 return PSA_ERROR_NOT_PERMITTED;
7567 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007568
Gilles Peskine449bd832023-01-11 14:50:10 +01007569 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7570 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7571 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7572 return PSA_ERROR_INVALID_ARGUMENT;
7573 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007574
Gilles Peskine449bd832023-01-11 14:50:10 +01007575 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007576}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007577#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007578
Ronald Cron3772afe2021-02-08 16:10:05 +01007579/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007580 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007581 * \param type The key type
7582 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007583 *
7584 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007585 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007586 * \retval #PSA_ERROR_INVALID_ARGUMENT
7587 * The size in bits of the key is not valid.
7588 * \retval #PSA_ERROR_NOT_SUPPORTED
7589 * The type and/or the size in bits of the key or the combination of
7590 * the two is not supported.
7591 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007592static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007593 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007594{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007595 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007596
Gilles Peskine449bd832023-01-11 14:50:10 +01007597 if (key_type_is_raw_bytes(type)) {
7598 status = psa_validate_unstructured_key_bit_size(type, bits);
7599 if (status != PSA_SUCCESS) {
7600 return status;
7601 }
7602 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007603#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007604 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7605 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7606 return PSA_ERROR_NOT_SUPPORTED;
7607 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007608 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007609 return PSA_ERROR_NOT_SUPPORTED;
7610 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007611
Ronald Cron01b2aba2020-10-05 09:42:02 +02007612 /* Accept only byte-aligned keys, for the same reasons as
7613 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007614 if (bits % 8 != 0) {
7615 return PSA_ERROR_NOT_SUPPORTED;
7616 }
7617 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007618#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007619
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007620#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007622 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007623 return PSA_SUCCESS;
7624 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007625#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007626
Valerio Settia55f0422023-07-10 15:34:41 +02007627#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007628 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007629 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007630 return PSA_ERROR_NOT_SUPPORTED;
7631 }
7632 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007633#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007634 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007635 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007636 }
7637
Gilles Peskine449bd832023-01-11 14:50:10 +01007638 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007639}
7640
Ronald Cron55ed0592020-10-05 10:30:40 +02007641psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007642 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007643 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007644{
7645 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007646 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007647
Gilles Peskine449bd832023-01-11 14:50:10 +01007648 if ((attributes->domain_parameters == NULL) &&
7649 (attributes->domain_parameters_size != 0)) {
7650 return PSA_ERROR_INVALID_ARGUMENT;
7651 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007652
Gilles Peskine449bd832023-01-11 14:50:10 +01007653 if (key_type_is_raw_bytes(type)) {
7654 status = psa_generate_random(key_buffer, key_buffer_size);
7655 if (status != PSA_SUCCESS) {
7656 return status;
7657 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007658
David Brown12ca5032021-02-11 11:02:00 -07007659#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007660 if (type == PSA_KEY_TYPE_DES) {
7661 psa_des_set_key_parity(key_buffer, key_buffer_size);
7662 }
David Brown8107e312021-02-12 08:08:46 -07007663#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007664 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007665
Valerio Setti76df8c12023-07-11 14:11:28 +02007666#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007667 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7668 return mbedtls_psa_rsa_generate_key(attributes,
7669 key_buffer,
7670 key_buffer_size,
7671 key_buffer_length);
7672 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007673#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007674
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007675#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007676 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7677 return mbedtls_psa_ecp_generate_key(attributes,
7678 key_buffer,
7679 key_buffer_size,
7680 key_buffer_length);
7681 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007682#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007683
Valerio Settia55f0422023-07-10 15:34:41 +02007684#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007685 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7686 return mbedtls_psa_ffdh_generate_key(attributes,
7687 key_buffer,
7688 key_buffer_size,
7689 key_buffer_length);
7690 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007691#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007692 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007693 (void) key_buffer_length;
7694 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007695 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007696
Gilles Peskine449bd832023-01-11 14:50:10 +01007697 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007698}
Darryl Green0c6575a2018-11-07 16:05:30 +00007699
Gilles Peskine449bd832023-01-11 14:50:10 +01007700psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7701 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007702{
7703 psa_status_t status;
7704 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007705 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007706 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007707
Ronald Cron81709fc2020-11-14 12:10:32 +01007708 *key = MBEDTLS_SVC_KEY_ID_INIT;
7709
Gilles Peskine0f84d622019-09-12 19:03:13 +02007710 /* Reject any attempt to create a zero-length key so that we don't
7711 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007712 if (psa_get_key_bits(attributes) == 0) {
7713 return PSA_ERROR_INVALID_ARGUMENT;
7714 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007715
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007716 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007717 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7718 return PSA_ERROR_INVALID_ARGUMENT;
7719 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007720
Gilles Peskine449bd832023-01-11 14:50:10 +01007721 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7722 &slot, &driver);
7723 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007724 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007725 }
Gilles Peskine11792082019-08-06 18:36:36 +02007726
Ronald Cron977c2472020-10-13 08:32:21 +02007727 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307728 * storage ( thus not in the case of generating a key in a secure element
7729 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7730 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007731 if (slot->key.data == NULL) {
7732 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7733 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007734 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007735 attributes->core.type, attributes->core.bits);
7736 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007737 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007738 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007739
7740 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007741 attributes->core.type,
7742 attributes->core.bits);
7743 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007744 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007745 attributes, &key_buffer_size);
7746 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007747 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007748 }
Ronald Cron977c2472020-10-13 08:32:21 +02007749 }
Ronald Cron977c2472020-10-13 08:32:21 +02007750
Gilles Peskine449bd832023-01-11 14:50:10 +01007751 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7752 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007753 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007754 }
Ronald Cron977c2472020-10-13 08:32:21 +02007755 }
7756
Gilles Peskine449bd832023-01-11 14:50:10 +01007757 status = psa_driver_wrapper_generate_key(attributes,
7758 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007759
Gilles Peskine449bd832023-01-11 14:50:10 +01007760 if (status != PSA_SUCCESS) {
7761 psa_remove_key_data_from_memory(slot);
7762 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007763
Gilles Peskine11792082019-08-06 18:36:36 +02007764exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007765 if (status == PSA_SUCCESS) {
7766 status = psa_finish_key_creation(slot, driver, key);
7767 }
7768 if (status != PSA_SUCCESS) {
7769 psa_fail_key_creation(slot, driver);
7770 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007771
Gilles Peskine449bd832023-01-11 14:50:10 +01007772 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007773}
7774
Gilles Peskinee59236f2018-01-27 23:32:46 +01007775/****************************************************************/
7776/* Module setup */
7777/****************************************************************/
7778
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007779#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007780psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007781 void (* entropy_init)(mbedtls_entropy_context *ctx),
7782 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007783{
Gilles Peskine449bd832023-01-11 14:50:10 +01007784 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7785 return PSA_ERROR_BAD_STATE;
7786 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007787 global_data.rng.entropy_init = entropy_init;
7788 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007789 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007790}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007791#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007792
Gilles Peskine449bd832023-01-11 14:50:10 +01007793void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007794{
Gilles Peskine449bd832023-01-11 14:50:10 +01007795 psa_wipe_all_key_slots();
Valerio Setti83e0de82023-11-24 12:13:05 +01007796 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7797 mbedtls_psa_random_free(&global_data.rng);
7798 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007799 /* Wipe all remaining data, including configuration.
7800 * In particular, this sets all state indicator to the value
7801 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007802 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007803
7804 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007805 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007806}
7807
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007808#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7809/** Recover a transaction that was interrupted by a power failure.
7810 *
7811 * This function is called during initialization, before psa_crypto_init()
7812 * returns. If this function returns a failure status, the initialization
7813 * fails.
7814 */
7815static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007816 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007817{
Gilles Peskine449bd832023-01-11 14:50:10 +01007818 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007819 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7820 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007821 /* TODO - fall through to the failure case until this
7822 * is implemented.
7823 * https://github.com/ARMmbed/mbed-crypto/issues/218
7824 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007825 default:
7826 /* We found an unsupported transaction in the storage.
7827 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007828 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007829 }
7830}
7831#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7832
Gilles Peskine449bd832023-01-11 14:50:10 +01007833psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007834{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007835 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007836
Gilles Peskinec6b69072018-11-20 21:42:52 +01007837 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007838 if (global_data.initialized != 0) {
7839 return PSA_SUCCESS;
7840 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007841
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007842 /* Init drivers */
7843 status = psa_driver_wrapper_init();
7844 if (status != PSA_SUCCESS) {
7845 goto exit;
7846 }
7847 global_data.drivers_initialized = 1;
7848
Valerio Setti402cfba2023-11-13 10:24:32 +01007849 status = psa_initialize_key_slots();
7850 if (status != PSA_SUCCESS) {
7851 goto exit;
7852 }
7853
Gilles Peskine30524eb2020-11-13 17:02:26 +01007854 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007855 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007856 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007857 status = mbedtls_psa_random_seed(&global_data.rng);
7858 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007859 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007860 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007861 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007862
Gilles Peskine4b734222019-07-24 15:56:31 +02007863#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007864 status = psa_crypto_load_transaction();
7865 if (status == PSA_SUCCESS) {
7866 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7867 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007868 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007869 }
7870 status = psa_crypto_stop_transaction();
7871 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007872 /* There's no transaction to complete. It's all good. */
7873 status = PSA_SUCCESS;
7874 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007875#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007876
Gilles Peskinec6b69072018-11-20 21:42:52 +01007877 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007878 global_data.initialized = 1;
7879
7880exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007881 if (status != PSA_SUCCESS) {
7882 mbedtls_psa_crypto_free();
7883 }
7884 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007885}
7886
Yanray Wangffc3c482023-07-11 12:01:04 +08007887#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007888psa_status_t psa_crypto_driver_pake_get_password_len(
7889 const psa_crypto_driver_pake_inputs_t *inputs,
7890 size_t *password_len)
7891{
7892 if (inputs->password_len == 0) {
7893 return PSA_ERROR_BAD_STATE;
7894 }
7895
7896 *password_len = inputs->password_len;
7897
7898 return PSA_SUCCESS;
7899}
7900
7901psa_status_t psa_crypto_driver_pake_get_password(
7902 const psa_crypto_driver_pake_inputs_t *inputs,
7903 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7904{
7905 if (inputs->password_len == 0) {
7906 return PSA_ERROR_BAD_STATE;
7907 }
7908
7909 if (buffer_size < inputs->password_len) {
7910 return PSA_ERROR_BUFFER_TOO_SMALL;
7911 }
7912
7913 memcpy(buffer, inputs->password, inputs->password_len);
7914 *buffer_length = inputs->password_len;
7915
7916 return PSA_SUCCESS;
7917}
7918
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007919psa_status_t psa_crypto_driver_pake_get_user_len(
7920 const psa_crypto_driver_pake_inputs_t *inputs,
7921 size_t *user_len)
7922{
7923 if (inputs->user_len == 0) {
7924 return PSA_ERROR_BAD_STATE;
7925 }
7926
7927 *user_len = inputs->user_len;
7928
7929 return PSA_SUCCESS;
7930}
7931
7932psa_status_t psa_crypto_driver_pake_get_user(
7933 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007934 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007935{
7936 if (inputs->user_len == 0) {
7937 return PSA_ERROR_BAD_STATE;
7938 }
7939
Przemek Stekielc0e62502023-03-14 11:49:36 +01007940 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007941 return PSA_ERROR_BUFFER_TOO_SMALL;
7942 }
7943
Przemek Stekielc0e62502023-03-14 11:49:36 +01007944 memcpy(user_id, inputs->user, inputs->user_len);
7945 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007946
7947 return PSA_SUCCESS;
7948}
7949
7950psa_status_t psa_crypto_driver_pake_get_peer_len(
7951 const psa_crypto_driver_pake_inputs_t *inputs,
7952 size_t *peer_len)
7953{
7954 if (inputs->peer_len == 0) {
7955 return PSA_ERROR_BAD_STATE;
7956 }
7957
7958 *peer_len = inputs->peer_len;
7959
7960 return PSA_SUCCESS;
7961}
7962
7963psa_status_t psa_crypto_driver_pake_get_peer(
7964 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01007965 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007966{
7967 if (inputs->peer_len == 0) {
7968 return PSA_ERROR_BAD_STATE;
7969 }
7970
Przemek Stekielc0e62502023-03-14 11:49:36 +01007971 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007972 return PSA_ERROR_BUFFER_TOO_SMALL;
7973 }
7974
Przemek Stekielc0e62502023-03-14 11:49:36 +01007975 memcpy(peer_id, inputs->peer, inputs->peer_len);
7976 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007977
7978 return PSA_SUCCESS;
7979}
7980
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007981psa_status_t psa_crypto_driver_pake_get_cipher_suite(
7982 const psa_crypto_driver_pake_inputs_t *inputs,
7983 psa_pake_cipher_suite_t *cipher_suite)
7984{
7985 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
7986 return PSA_ERROR_BAD_STATE;
7987 }
7988
7989 *cipher_suite = inputs->cipher_suite;
7990
7991 return PSA_SUCCESS;
7992}
7993
Neil Armstronga7d08c32022-06-01 18:21:20 +02007994psa_status_t psa_pake_setup(
7995 psa_pake_operation_t *operation,
7996 const psa_pake_cipher_suite_t *cipher_suite)
7997{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007998 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01007999
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008000 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008001 status = PSA_ERROR_BAD_STATE;
8002 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008003 }
8004
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008005 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01008006 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008007 status = PSA_ERROR_INVALID_ARGUMENT;
8008 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008009 }
8010
Przemek Stekiel51eac532022-12-07 11:04:51 +01008011 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
8012
Przemek Stekiele12ed362022-12-21 12:54:46 +01008013 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01008014 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
8015 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008016 operation->data.inputs.cipher_suite = *cipher_suite;
8017
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008018#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008019 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008020 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01008021 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008022
David Horstmann16f01512023-06-14 17:21:07 +01008023 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01008024 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008025 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008026#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008027 {
8028 status = PSA_ERROR_NOT_SUPPORTED;
8029 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008030 }
8031
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008032 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
8033
Przemek Stekiel51eac532022-12-07 11:04:51 +01008034 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008035exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008036 psa_pake_abort(operation);
8037 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008038}
8039
8040psa_status_t psa_pake_set_password_key(
8041 psa_pake_operation_t *operation,
8042 mbedtls_svc_key_id_t password)
8043{
Neil Armstrong5ae60962022-09-15 11:29:46 +02008044 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01008045 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
8046 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008047 psa_key_attributes_t attributes;
8048 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008049
Przemek Stekiel51eac532022-12-07 11:04:51 +01008050 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008051 status = PSA_ERROR_BAD_STATE;
8052 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008053 }
8054
Przemek Stekiel6c764412022-11-22 14:05:12 +01008055 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
8056 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008057 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008058 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008059 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008060 }
8061
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008062 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01008063 .core = slot->attr
8064 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02008065
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008066 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008067
Przemek Stekiel51eac532022-12-07 11:04:51 +01008068 if (type != PSA_KEY_TYPE_PASSWORD &&
8069 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8070 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008071 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008072 }
8073
Przemek Stekiel51eac532022-12-07 11:04:51 +01008074 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8075 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008076 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008077 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008078 }
8079
8080 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8081 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01008082 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008083exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008084 if (status != PSA_SUCCESS) {
8085 psa_pake_abort(operation);
8086 }
Ryan Everett1b70a072024-01-04 10:32:49 +00008087 unlock_status = psa_unregister_read(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008088 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008089}
8090
8091psa_status_t psa_pake_set_user(
8092 psa_pake_operation_t *operation,
8093 const uint8_t *user_id,
8094 size_t user_id_len)
8095{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008096 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008097
8098 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008099 status = PSA_ERROR_BAD_STATE;
8100 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008101 }
8102
Przemek Stekiel51eac532022-12-07 11:04:51 +01008103 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008104 status = PSA_ERROR_INVALID_ARGUMENT;
8105 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008106 }
8107
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008108 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008109 status = PSA_ERROR_BAD_STATE;
8110 goto exit;
8111 }
8112
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008113 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8114 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008115 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8116 goto exit;
8117 }
8118
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008119 memcpy(operation->data.inputs.user, user_id, user_id_len);
8120 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008121
8122 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008123exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008124 psa_pake_abort(operation);
8125 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008126}
8127
8128psa_status_t psa_pake_set_peer(
8129 psa_pake_operation_t *operation,
8130 const uint8_t *peer_id,
8131 size_t peer_id_len)
8132{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008133 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008134
8135 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008136 status = PSA_ERROR_BAD_STATE;
8137 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008138 }
8139
Przemek Stekiel51eac532022-12-07 11:04:51 +01008140 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008141 status = PSA_ERROR_INVALID_ARGUMENT;
8142 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008143 }
8144
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008145 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008146 status = PSA_ERROR_BAD_STATE;
8147 goto exit;
8148 }
8149
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008150 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8151 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008152 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8153 goto exit;
8154 }
8155
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008156 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8157 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008158
8159 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008160exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008161 psa_pake_abort(operation);
8162 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008163}
8164
8165psa_status_t psa_pake_set_role(
8166 psa_pake_operation_t *operation,
8167 psa_pake_role_t role)
8168{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008169 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008170
Przemek Stekiel51eac532022-12-07 11:04:51 +01008171 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008172 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008173 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008174 }
8175
Przemek Stekiel09104b82023-03-06 14:11:51 +01008176 switch (operation->alg) {
8177#if defined(PSA_WANT_ALG_JPAKE)
8178 case PSA_ALG_JPAKE:
8179 if (role == PSA_PAKE_ROLE_NONE) {
8180 return PSA_SUCCESS;
8181 }
8182 status = PSA_ERROR_INVALID_ARGUMENT;
8183 break;
8184#endif
8185 default:
8186 (void) role;
8187 status = PSA_ERROR_NOT_SUPPORTED;
8188 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008189 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008190exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008191 psa_pake_abort(operation);
8192 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008193}
8194
David Horstmanne7f21e62023-05-12 18:17:21 +01008195/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008196#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008197static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008198 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008199{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008200 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008201 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008202 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008203
David Horstmann024e5c52023-06-14 15:48:21 +01008204 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008205 is_x1 = (stage->outputs < 1);
8206 } else {
8207 is_x1 = (stage->inputs < 1);
8208 }
8209
David Horstmann74a3d8c2023-06-14 18:28:19 +01008210 key_share_step = is_x1 ?
8211 PSA_JPAKE_X1_STEP_KEY_SHARE :
8212 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008213 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008214 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8215 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8216 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8217 } else {
8218 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008219 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008220 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008221}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008222#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008223
Przemek Stekiel2797d372022-12-22 11:19:22 +01008224static psa_status_t psa_pake_complete_inputs(
8225 psa_pake_operation_t *operation)
8226{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008227 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008228 /* Create copy of the inputs on stack as inputs share memory
8229 with the driver context which will be setup by the driver. */
8230 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008231
Przemek Stekielfde11282023-03-13 16:06:09 +01008232 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008233 return PSA_ERROR_BAD_STATE;
8234 }
8235
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008236 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008237 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8238 return PSA_ERROR_BAD_STATE;
8239 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008240 }
8241
Przemek Stekiel18620a32023-01-17 16:34:52 +01008242 /* Clear driver context */
8243 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8244
8245 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008246
8247 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008248 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008249
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008250 /* User and peer are translated to role. */
8251 mbedtls_free(inputs.user);
8252 mbedtls_free(inputs.peer);
8253
Przemek Stekiel2797d372022-12-22 11:19:22 +01008254 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008255#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008256 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008257 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008258 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008259#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008260 {
8261 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008262 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008263 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008264 return status;
8265}
8266
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008267#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008268static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008269 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008270 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008271 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008272{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008273 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8274 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8275 step != PSA_PAKE_STEP_ZK_PROOF) {
8276 return PSA_ERROR_INVALID_ARGUMENT;
8277 }
8278
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008279 psa_jpake_computation_stage_t *computation_stage =
8280 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008281
David Horstmann5da95602023-06-08 15:37:12 +01008282 if (computation_stage->round != PSA_JPAKE_FIRST &&
8283 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008284 return PSA_ERROR_BAD_STATE;
8285 }
8286
David Horstmanne7f21e62023-05-12 18:17:21 +01008287 /* Check that the step we are given is the one we were expecting */
8288 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008289 return PSA_ERROR_BAD_STATE;
8290 }
8291
David Horstmanne7f21e62023-05-12 18:17:21 +01008292 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8293 computation_stage->inputs == 0 &&
8294 computation_stage->outputs == 0) {
8295 /* Start of the round, so function decides whether we are inputting
8296 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008297 computation_stage->io_mode = io_mode;
8298 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008299 /* Middle of the round so the mode we are in must match the function
8300 * called by the user */
8301 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008302 }
8303
8304 return PSA_SUCCESS;
8305}
8306
David Horstmanne7f21e62023-05-12 18:17:21 +01008307static psa_status_t psa_jpake_epilogue(
8308 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008309 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008310{
David Horstmanne7f21e62023-05-12 18:17:21 +01008311 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008312 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008313
David Horstmanne7f21e62023-05-12 18:17:21 +01008314 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8315 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008316 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008317 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008318 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008319 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008320 }
8321 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008322 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008323 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008324 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008325 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008326 }
8327 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008328 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8329 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008330 /* End of a round, move to the next round */
8331 stage->inputs = 0;
8332 stage->outputs = 0;
8333 stage->round++;
8334 }
8335 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008336 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008337 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008338 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008339 return PSA_SUCCESS;
8340}
David Horstmanne7f21e62023-05-12 18:17:21 +01008341
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008342#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008343
Neil Armstronga7d08c32022-06-01 18:21:20 +02008344psa_status_t psa_pake_output(
8345 psa_pake_operation_t *operation,
8346 psa_pake_step_t step,
8347 uint8_t *output,
8348 size_t output_size,
8349 size_t *output_length)
8350{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008351 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008352 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008353 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008354
8355 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008356 status = psa_pake_complete_inputs(operation);
8357 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008358 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008359 }
8360 }
8361
8362 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008363 status = PSA_ERROR_BAD_STATE;
8364 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008365 }
8366
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008367 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008368 status = PSA_ERROR_INVALID_ARGUMENT;
8369 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008370 }
8371
Przemek Stekiele12ed362022-12-21 12:54:46 +01008372 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008373#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008374 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008375 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008376 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008377 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008378 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008379 driver_step = convert_jpake_computation_stage_to_driver_step(
8380 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008381 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008382#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008383 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008384 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008385 status = PSA_ERROR_NOT_SUPPORTED;
8386 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008387 }
8388
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008389 status = psa_driver_wrapper_pake_output(operation, driver_step,
8390 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008391
8392 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008393 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008394 }
8395
8396 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008397#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008398 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008399 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008400 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008401 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008402 }
8403 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008404#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008405 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008406 status = PSA_ERROR_NOT_SUPPORTED;
8407 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008408 }
8409
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008410 return PSA_SUCCESS;
8411exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008412 psa_pake_abort(operation);
8413 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008414}
8415
8416psa_status_t psa_pake_input(
8417 psa_pake_operation_t *operation,
8418 psa_pake_step_t step,
8419 const uint8_t *input,
8420 size_t input_length)
8421{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008422 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008423 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008424 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8425 operation->primitive,
8426 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008427
8428 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008429 status = psa_pake_complete_inputs(operation);
8430 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008431 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008432 }
8433 }
8434
8435 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008436 status = PSA_ERROR_BAD_STATE;
8437 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008438 }
8439
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008440 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008441 status = PSA_ERROR_INVALID_ARGUMENT;
8442 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008443 }
8444
Przemek Stekiele12ed362022-12-21 12:54:46 +01008445 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008446#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008447 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008448 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008449 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008450 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008451 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008452 driver_step = convert_jpake_computation_stage_to_driver_step(
8453 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008454 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008455#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008456 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008457 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008458 status = PSA_ERROR_NOT_SUPPORTED;
8459 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008460 }
8461
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008462 status = psa_driver_wrapper_pake_input(operation, driver_step,
8463 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008464
8465 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008466 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008467 }
8468
8469 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008470#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008471 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008472 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008473 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008474 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008475 }
8476 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008477#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008478 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008479 status = PSA_ERROR_NOT_SUPPORTED;
8480 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008481 }
8482
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008483 return PSA_SUCCESS;
8484exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008485 psa_pake_abort(operation);
8486 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008487}
8488
8489psa_status_t psa_pake_get_implicit_key(
8490 psa_pake_operation_t *operation,
8491 psa_key_derivation_operation_t *output)
8492{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008493 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008494 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008495 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008496 size_t shared_key_len = 0;
8497
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008498 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008499 status = PSA_ERROR_BAD_STATE;
8500 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008501 }
8502
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008503#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008504 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008505 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008506 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008507 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008508 status = PSA_ERROR_BAD_STATE;
8509 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008510 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008511 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008512#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008513 {
8514 status = PSA_ERROR_NOT_SUPPORTED;
8515 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008516 }
8517
Przemek Stekiel0c781802022-11-29 14:53:13 +01008518 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8519 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008520 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008521 &shared_key_len);
8522
8523 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008524 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008525 }
8526
8527 status = psa_key_derivation_input_bytes(output,
8528 PSA_KEY_DERIVATION_INPUT_SECRET,
8529 shared_key,
8530 shared_key_len);
8531
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008532 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008533exit:
8534 abort_status = psa_pake_abort(operation);
8535 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008536}
8537
8538psa_status_t psa_pake_abort(
8539 psa_pake_operation_t *operation)
8540{
Przemek Stekield69dca92023-01-31 19:59:20 +01008541 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008542
Przemek Stekield69dca92023-01-31 19:59:20 +01008543 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008544 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008545 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008546
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008547 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8548 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008549 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008550 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008551 }
8552 if (operation->data.inputs.user != NULL) {
8553 mbedtls_free(operation->data.inputs.user);
8554 }
8555 if (operation->data.inputs.peer != NULL) {
8556 mbedtls_free(operation->data.inputs.peer);
8557 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008558 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008559 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008560
Przemek Stekield69dca92023-01-31 19:59:20 +01008561 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008562}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008563#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008564
David Horstmann00d7a042023-12-07 18:39:17 +00008565/* Memory copying test hooks. These are called before input copy, after input
8566 * copy, before output copy and after output copy, respectively.
8567 * They are used by memory-poisoning tests to temporarily unpoison buffers
8568 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00008569#if defined(MBEDTLS_TEST_HOOKS)
8570void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8571void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8572void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8573void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8574#endif
David Horstmannfde97392023-10-30 20:29:43 +00008575
David Horstmann1b7279a2023-11-15 15:18:30 +00008576/** Copy from an input buffer to a local copy.
8577 *
8578 * \param[in] input Pointer to input buffer.
8579 * \param[in] input_len Length of the input buffer.
8580 * \param[out] input_copy Pointer to a local copy in which to store the input data.
8581 * \param[out] input_copy_len Length of the local copy buffer.
8582 * \return #PSA_SUCCESS, if the buffer was successfully
8583 * copied.
8584 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
8585 * copy is too small to hold contents of the
8586 * input buffer.
8587 */
8588MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00008589psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
8590 uint8_t *input_copy, size_t input_copy_len)
8591{
8592 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00008593 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00008594 }
8595
David Horstmann372b8bb2023-11-24 16:21:04 +00008596#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008597 if (psa_input_pre_copy_hook != NULL) {
8598 psa_input_pre_copy_hook(input, input_len);
8599 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008600#endif
8601
David Horstmann777e7412023-11-15 17:33:47 +00008602 if (input_len > 0) {
8603 memcpy(input_copy, input, input_len);
8604 }
David Horstmannfde97392023-10-30 20:29:43 +00008605
David Horstmann372b8bb2023-11-24 16:21:04 +00008606#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008607 if (psa_input_post_copy_hook != NULL) {
8608 psa_input_post_copy_hook(input, input_len);
8609 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008610#endif
8611
David Horstmannfde97392023-10-30 20:29:43 +00008612 return PSA_SUCCESS;
8613}
8614
David Horstmann1b7279a2023-11-15 15:18:30 +00008615/** Copy from a local output buffer into a user-supplied one.
8616 *
8617 * \param[in] output_copy Pointer to a local buffer containing the output.
8618 * \param[in] output_copy_len Length of the local buffer.
8619 * \param[out] output Pointer to user-supplied output buffer.
8620 * \param[out] output_len Length of the user-supplied output buffer.
8621 * \return #PSA_SUCCESS, if the buffer was successfully
8622 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00008623 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00008624 * user-supplied output buffer is too small to
8625 * hold the contents of the local buffer.
8626 */
8627MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00008628psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
8629 uint8_t *output, size_t output_len)
8630{
8631 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00008632 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00008633 }
David Horstmann777e7412023-11-15 17:33:47 +00008634
David Horstmann372b8bb2023-11-24 16:21:04 +00008635#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008636 if (psa_output_pre_copy_hook != NULL) {
8637 psa_output_pre_copy_hook(output, output_len);
8638 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008639#endif
8640
David Horstmann777e7412023-11-15 17:33:47 +00008641 if (output_copy_len > 0) {
8642 memcpy(output, output_copy, output_copy_len);
8643 }
8644
David Horstmann372b8bb2023-11-24 16:21:04 +00008645#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008646 if (psa_output_post_copy_hook != NULL) {
8647 psa_output_post_copy_hook(output, output_len);
8648 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008649#endif
8650
David Horstmann8978f5c2023-10-30 20:37:12 +00008651 return PSA_SUCCESS;
8652}
8653
David Horstmannf1734052023-11-20 17:15:32 +00008654psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
8655 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00008656{
8657 psa_status_t status;
8658
David Horstmann9db14482023-11-23 15:50:37 +00008659 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00008660
David Horstmannc5cc1c32023-11-15 18:11:26 +00008661 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00008662 return PSA_SUCCESS;
8663 }
8664
David Horstmannf1734052023-11-20 17:15:32 +00008665 local_input->buffer = mbedtls_calloc(input_len, 1);
8666 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00008667 /* Since we dealt with the zero-length case above, we know that
8668 * a NULL return value means a failure of allocation. */
8669 return PSA_ERROR_INSUFFICIENT_MEMORY;
8670 }
David Horstmannf1734052023-11-20 17:15:32 +00008671 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00008672
David Horstmannf1734052023-11-20 17:15:32 +00008673 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00008674
8675 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00008676 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00008677 if (status != PSA_SUCCESS) {
8678 goto error;
8679 }
8680
8681 return PSA_SUCCESS;
8682
8683error:
David Horstmannf1734052023-11-20 17:15:32 +00008684 mbedtls_free(local_input->buffer);
8685 local_input->buffer = NULL;
8686 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00008687 return status;
8688}
8689
David Horstmannf1734052023-11-20 17:15:32 +00008690void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00008691{
David Horstmannf1734052023-11-20 17:15:32 +00008692 mbedtls_free(local_input->buffer);
8693 local_input->buffer = NULL;
8694 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00008695}
8696
David Horstmann89875a42023-11-20 12:54:09 +00008697psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
8698 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00008699{
David Horstmann9db14482023-11-23 15:50:37 +00008700 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00008701
David Horstmannc5cc1c32023-11-15 18:11:26 +00008702 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008703 return PSA_SUCCESS;
8704 }
David Horstmann89875a42023-11-20 12:54:09 +00008705 local_output->buffer = mbedtls_calloc(output_len, 1);
8706 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008707 /* Since we dealt with the zero-length case above, we know that
8708 * a NULL return value means a failure of allocation. */
8709 return PSA_ERROR_INSUFFICIENT_MEMORY;
8710 }
David Horstmann89875a42023-11-20 12:54:09 +00008711 local_output->length = output_len;
8712 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00008713
8714 return PSA_SUCCESS;
8715}
8716
Gabor Mezei1882c512024-01-24 13:07:17 +01008717psa_status_t psa_crypto_local_output_alloc_with_copy(uint8_t *output, size_t output_len,
8718 psa_crypto_local_output_t *local_output)
8719{
8720 psa_status_t status;
8721 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
8722
8723 if (output_len == 0) {
8724 return PSA_SUCCESS;
8725 }
8726 local_output->buffer = mbedtls_calloc(output_len, 1);
8727 if (local_output->buffer == NULL) {
8728 /* Since we dealt with the zero-length case above, we know that
8729 * a NULL return value means a failure of allocation. */
8730 return PSA_ERROR_INSUFFICIENT_MEMORY;
8731 }
8732 local_output->length = output_len;
8733 local_output->original = output;
8734
8735 status = psa_crypto_copy_input(output, output_len,
8736 local_output->buffer, local_output->length);
8737 if (status != PSA_SUCCESS) {
8738 goto error;
8739 }
8740
8741 return PSA_SUCCESS;
8742
8743error:
8744 mbedtls_free(local_output->buffer);
8745 local_output->buffer = NULL;
8746 local_output->length = 0;
8747 return status;
8748}
8749
David Horstmann89875a42023-11-20 12:54:09 +00008750psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00008751{
David Horstmannc335a4e2023-11-15 15:57:32 +00008752 psa_status_t status;
8753
David Horstmann89875a42023-11-20 12:54:09 +00008754 if (local_output->buffer == NULL) {
8755 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008756 return PSA_SUCCESS;
8757 }
David Horstmann89875a42023-11-20 12:54:09 +00008758 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00008759 /* We have an internal copy but nothing to copy back to. */
8760 return PSA_ERROR_CORRUPTION_DETECTED;
8761 }
8762
David Horstmann89875a42023-11-20 12:54:09 +00008763 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
8764 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00008765 if (status != PSA_SUCCESS) {
8766 return status;
8767 }
David Horstmann9467ea32023-11-08 17:44:18 +00008768
David Horstmann89875a42023-11-20 12:54:09 +00008769 mbedtls_free(local_output->buffer);
8770 local_output->buffer = NULL;
8771 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008772
8773 return PSA_SUCCESS;
8774}
8775
Gilles Peskinee59236f2018-01-27 23:32:46 +01008776#endif /* MBEDTLS_PSA_CRYPTO_C */