blob: 29d42a323678bc2d8ac97ad273eac734f9b299d0 [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
David Horstmann62a56d92023-12-14 18:12:47 +0000189/* Free the local output copy allocated previously by LOCAL_OUTPUT_ALLOC()
David Horstmann3e72db42023-12-08 14:08:18 +0000190 * after first copying back its contents to the original buffer.
David Horstmann36df4b22023-12-13 15:55:25 +0000191 *
David Horstmann3e72db42023-12-08 14:08:18 +0000192 * Assumptions:
David Horstmann3e72db42023-12-08 14:08:18 +0000193 * - psa_status_t status exists
David Horstmann62a56d92023-12-14 18:12:47 +0000194 * - output_copy is the name of the output copy pointer set by LOCAL_OUTPUT_ALLOC()
195 * - output is the name of the original buffer that was copied
David Horstmann3e72db42023-12-08 14:08:18 +0000196 */
David Horstmann62a56d92023-12-14 18:12:47 +0000197#define LOCAL_OUTPUT_FREE(output, output_copy) \
198 output_copy = NULL; \
David Horstmann5a945f52023-12-13 14:09:08 +0000199 do { \
200 psa_status_t local_output_status; \
David Horstmann36df4b22023-12-13 15:55:25 +0000201 local_output_status = psa_crypto_local_output_free(&LOCAL_OUTPUT_COPY_OF_##output); \
David Horstmann5a945f52023-12-13 14:09:08 +0000202 if (local_output_status != PSA_SUCCESS) { \
203 /* Since this error case is an internal error, it's more serious than \
204 * any existing error code and so it's fine to overwrite the existing \
205 * status. */ \
206 status = local_output_status; \
207 } \
208 } while (0)
David Horstmann513101b2023-11-29 17:24:08 +0000209#else /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
David Horstmann62a56d92023-12-14 18:12:47 +0000210#define LOCAL_INPUT_DECLARE(input, input_copy_name) \
211 const uint8_t *input_copy_name = NULL;
212#define LOCAL_INPUT_ALLOC(input, length, input_copy) \
213 input_copy = input;
214#define LOCAL_INPUT_FREE(input, input_copy) \
215 input_copy = NULL;
216#define LOCAL_OUTPUT_DECLARE(output, output_copy_name) \
217 uint8_t *output_copy_name = NULL;
218#define LOCAL_OUTPUT_ALLOC(output, length, output_copy) \
219 output_copy = output;
Gabor Mezei4892d752024-01-29 17:27:44 +0100220#define LOCAL_OUTPUT_ALLOC_WITH_COPY(output, length, output_copy) \
221 output_copy = output;
David Horstmann62a56d92023-12-14 18:12:47 +0000222#define LOCAL_OUTPUT_FREE(output, output_copy) \
223 output_copy = NULL;
David Horstmann513101b2023-11-29 17:24:08 +0000224#endif /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
David Horstmanne9a88ab2023-11-29 17:07:13 +0000225
226
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100227int psa_can_do_hash(psa_algorithm_t hash_alg)
228{
229 (void) hash_alg;
230 return global_data.drivers_initialized;
231}
Valerio Settic6f004f2023-12-12 11:27:36 +0100232
Valerio Setti1fff4f22023-12-28 14:19:34 +0100233int psa_can_do_cipher(psa_key_type_t key_type, psa_algorithm_t cipher_alg)
Valerio Settic6f004f2023-12-12 11:27:36 +0100234{
Valerio Setti1fff4f22023-12-28 14:19:34 +0100235 (void) key_type;
Valerio Settic6f004f2023-12-12 11:27:36 +0100236 (void) cipher_alg;
237 return global_data.drivers_initialized;
238}
239
240
Valerio Settia55f0422023-07-10 15:34:41 +0200241#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel53410502023-04-28 13:18:43 +0200242 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) || \
Valerio Settia55f0422023-07-10 15:34:41 +0200243 defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekiel134cc2e2023-05-05 10:13:37 +0200244static int psa_is_dh_key_size_valid(size_t bits)
245{
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200246 if (bits != 2048 && bits != 3072 && bits != 4096 &&
247 bits != 6144 && bits != 8192) {
248 return 0;
249 }
250
251 return 1;
252}
Valerio Settia55f0422023-07-10 15:34:41 +0200253#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT ||
Przemek Stekiel53410502023-04-28 13:18:43 +0200254 MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY ||
Valerio Settia55f0422023-07-10 15:34:41 +0200255 PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE */
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100256
Gilles Peskine449bd832023-01-11 14:50:10 +0100257psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100258{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100259 /* Mbed TLS error codes can combine a high-level error code and a
260 * low-level error code. The low-level error usually reflects the
261 * root cause better, so dispatch on that preferably. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100262 int low_level_ret = -(-ret & 0x007f);
263 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100264 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100265 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100266
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100267#if defined(MBEDTLS_AES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100268 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
269 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100270 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman09a9e582023-08-31 11:05:22 +0100271 case MBEDTLS_ERR_AES_BAD_INPUT_DATA:
272 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100273#endif
274
275#if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_ASN1_WRITE_C)
Gilles Peskine9a944802018-06-21 09:35:35 +0200276 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
277 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
278 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
279 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
280 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100281 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200282 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100283 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200284 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100285 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100286#endif
Gilles Peskine9a944802018-06-21 09:35:35 +0200287
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100288#if defined(MBEDTLS_CAMELLIA_C)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000289 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Gilles Peskinea5905292018-02-07 20:59:33 +0100290 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100292#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100293
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100294#if defined(MBEDTLS_CCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100295 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100296 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100297 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100298 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100299#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100300
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100301#if defined(MBEDTLS_CHACHA20_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200302 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100303 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100304#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200305
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100306#if defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200307 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100308 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200309 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100310 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100311#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200312
Dave Rodgman509b5672023-08-16 19:26:23 +0100313#if defined(MBEDTLS_CIPHER_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100314 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100315 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100316 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100317 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100318 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100319 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100320 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100321 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100322 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100324 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100325 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100326 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100327 return PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100328#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100329
Gilles Peskine449bd832023-01-11 14:50:10 +0100330#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
331 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100332 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
333 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100334 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100335 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100336 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
337 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100338 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100339 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100340 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100341#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100342
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100343#if defined(MBEDTLS_DES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100344 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100345 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100346#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100347
Gilles Peskinee59236f2018-01-27 23:32:46 +0100348 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
349 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
350 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100352
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100353#if defined(MBEDTLS_GCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100354 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 return PSA_ERROR_INVALID_SIGNATURE;
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200356 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100358 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100359 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100360#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100361
Gilles Peskine82e57d12020-11-13 21:31:17 +0100362#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100363 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100364 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
365 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100366 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100367 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100368 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
369 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100370 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100371 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100372 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100373#endif
374
Dave Rodgmandea266f2023-08-31 11:52:43 +0100375#if defined(MBEDTLS_MD_LIGHT)
Gilles Peskinea5905292018-02-07 20:59:33 +0100376 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100377 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100378 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100379 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100380 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100381 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100382#if defined(MBEDTLS_FS_IO)
Gilles Peskinea5905292018-02-07 20:59:33 +0100383 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100384 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100385#endif
386#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100387
Dave Rodgman509b5672023-08-16 19:26:23 +0100388#if defined(MBEDTLS_BIGNUM_C)
389#if defined(MBEDTLS_FS_IO)
Gilles Peskinef76aa772018-10-29 19:24:33 +0100390 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100391 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100392#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100393 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100394 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100395 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
Gilles Peskine449bd832023-01-11 14:50:10 +0100396 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100397 case MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100398 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100399 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100400 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100401 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100402 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100403 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100405 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100407#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100408
Dave Rodgman509b5672023-08-16 19:26:23 +0100409#if defined(MBEDTLS_PK_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100410 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100411 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100412 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
413 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100414 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100415#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) || defined(MBEDTLS_FS_IO) || \
416 defined(MBEDTLS_PSA_ITS_FILE_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100417 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100418 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100419#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100420 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
421 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100422 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100423 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100424 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100425 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
426 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100427 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100428 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100429 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100430 case MBEDTLS_ERR_PK_INVALID_ALG:
431 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
432 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100433 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100434 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100435 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200436 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100437 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100438#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100439
Gilles Peskineff2d2002019-05-06 15:26:23 +0200440 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100441 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200442 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100443 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200444
Dave Rodgman509b5672023-08-16 19:26:23 +0100445#if defined(MBEDTLS_RSA_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100446 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100447 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100448 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100449 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100450 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100451 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100452 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100453 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100454 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
455 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100456 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100457 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100459 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100460 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100461 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100462 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100463#endif
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200464
Dave Rodgman1dab4452023-09-01 09:59:51 +0100465#if defined(MBEDTLS_ECP_LIGHT)
itayzafrir5c753392018-05-08 11:18:38 +0300466 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300467 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100468 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300469 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100470 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300471 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300473 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
474 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300476 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100477 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100478 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100479 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100480
Dave Rodgman509b5672023-08-16 19:26:23 +0100481#if defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +0000482 case MBEDTLS_ERR_ECP_IN_PROGRESS:
483 return PSA_OPERATION_INCOMPLETE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100484#endif
485#endif
Paul Elliott588f8ed2022-12-02 18:10:26 +0000486
Janos Follatha13b9052019-11-22 12:48:59 +0000487 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100488 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300489
Gilles Peskinee59236f2018-01-27 23:32:46 +0100490 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100491 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100492 }
493}
494
Paul Elliottdc42ca82023-02-24 18:11:59 +0000495/**
496 * \brief For output buffers which contain "tags"
497 * (outputs that may be checked for validity like
498 * hashes, MACs and signatures), fill the unused
499 * part of the output buffer (the whole buffer on
500 * error, the trailing part on success) with
501 * something that isn't a valid tag (barring an
502 * attack on the tag and deliberately-crafted
503 * input), in case the caller doesn't check the
504 * return status properly.
505 *
506 * \param output_buffer Pointer to buffer to wipe. May not be NULL
507 * unless \p output_buffer_size is zero.
508 * \param status Status of function called to generate
509 * output_buffer originally
510 * \param output_buffer_size Size of output buffer. If zero, \p output_buffer
511 * could be NULL.
512 * \param output_buffer_length Length of data written to output_buffer, must be
513 * less than \p output_buffer_size
514 */
515static void psa_wipe_tag_output_buffer(uint8_t *output_buffer, psa_status_t status,
Paul Elliott7118d172023-02-26 16:57:05 +0000516 size_t output_buffer_size, size_t output_buffer_length)
517{
Paul Elliottdc42ca82023-02-24 18:11:59 +0000518 size_t offset = 0;
519
520 if (output_buffer_size == 0) {
521 /* If output_buffer_size is 0 then we have nothing to do. We must not
522 call memset because output_buffer may be NULL in this case */
523 return;
524 }
525
526 if (status == PSA_SUCCESS) {
527 offset = output_buffer_length;
528 }
529
530 memset(output_buffer + offset, '!', output_buffer_size - offset);
531}
532
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200533
Gilles Peskine449bd832023-01-11 14:50:10 +0100534psa_status_t psa_validate_unstructured_key_bit_size(psa_key_type_t type,
535 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200536{
537 /* Check that the bit size is acceptable for the key type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100538 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200539 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200540 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200541 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200542 case PSA_KEY_TYPE_PASSWORD:
543 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200544 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100545#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200546 case PSA_KEY_TYPE_AES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 if (bits != 128 && bits != 192 && bits != 256) {
548 return PSA_ERROR_INVALID_ARGUMENT;
549 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200550 break;
551#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200552#if defined(PSA_WANT_KEY_TYPE_ARIA)
553 case PSA_KEY_TYPE_ARIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100554 if (bits != 128 && bits != 192 && bits != 256) {
555 return PSA_ERROR_INVALID_ARGUMENT;
556 }
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200557 break;
558#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100559#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200560 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 if (bits != 128 && bits != 192 && bits != 256) {
562 return PSA_ERROR_INVALID_ARGUMENT;
563 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200564 break;
565#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100566#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200567 case PSA_KEY_TYPE_DES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100568 if (bits != 64 && bits != 128 && bits != 192) {
569 return PSA_ERROR_INVALID_ARGUMENT;
570 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200571 break;
572#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100573#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200574 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine449bd832023-01-11 14:50:10 +0100575 if (bits != 256) {
576 return PSA_ERROR_INVALID_ARGUMENT;
577 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200578 break;
579#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200580 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100581 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200582 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100583 if (bits % 8 != 0) {
584 return PSA_ERROR_INVALID_ARGUMENT;
585 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200586
Gilles Peskine449bd832023-01-11 14:50:10 +0100587 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200588}
589
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100590/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100591 *
Steven Cooremancd640932021-03-08 12:00:27 +0100592 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
593 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100594 *
595 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100596 * \param[in] key_type The key type of the key to be used with the
597 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100598 *
599 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100600 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100601 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100602 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100603 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100604MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100605 psa_algorithm_t algorithm,
Gilles Peskine449bd832023-01-11 14:50:10 +0100606 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100607{
Gilles Peskine449bd832023-01-11 14:50:10 +0100608 if (PSA_ALG_IS_HMAC(algorithm)) {
609 if (key_type == PSA_KEY_TYPE_HMAC) {
610 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100611 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100612 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100613
Gilles Peskine449bd832023-01-11 14:50:10 +0100614 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
615 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
616 * key. */
617 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
618 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
619 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
620 * the block length (larger than 1) for block ciphers. */
621 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
622 return PSA_SUCCESS;
623 }
624 }
625 }
626
627 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100628}
629
Gilles Peskine449bd832023-01-11 14:50:10 +0100630psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
631 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200632{
Gilles Peskine449bd832023-01-11 14:50:10 +0100633 if (slot->key.data != NULL) {
634 return PSA_ERROR_ALREADY_EXISTS;
635 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200636
Gilles Peskine449bd832023-01-11 14:50:10 +0100637 slot->key.data = mbedtls_calloc(1, buffer_length);
638 if (slot->key.data == NULL) {
639 return PSA_ERROR_INSUFFICIENT_MEMORY;
640 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200641
Ronald Cronea0f8a62020-11-25 17:52:23 +0100642 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100643 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200644}
645
Gilles Peskine449bd832023-01-11 14:50:10 +0100646psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
647 const uint8_t *data,
648 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200649{
Gilles Peskine449bd832023-01-11 14:50:10 +0100650 psa_status_t status = psa_allocate_buffer_to_slot(slot,
651 data_length);
652 if (status != PSA_SUCCESS) {
653 return status;
654 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200655
Gilles Peskine449bd832023-01-11 14:50:10 +0100656 memcpy(slot->key.data, data, data_length);
657 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200658}
659
Ronald Crona0fe59f2020-11-29 11:14:53 +0100660psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100661 const psa_key_attributes_t *attributes,
662 const uint8_t *data, size_t data_length,
663 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100664 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100665{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100666 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
667 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100668
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200669 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100670 if (data_length == 0) {
671 return PSA_ERROR_NOT_SUPPORTED;
672 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200673
Gilles Peskine449bd832023-01-11 14:50:10 +0100674 if (key_type_is_raw_bytes(type)) {
675 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200676
Gilles Peskine449bd832023-01-11 14:50:10 +0100677 status = psa_validate_unstructured_key_bit_size(attributes->core.type,
678 *bits);
679 if (status != PSA_SUCCESS) {
680 return status;
681 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200682
Ronald Crondd04d422020-11-28 15:14:42 +0100683 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100685 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200687
Gilles Peskine449bd832023-01-11 14:50:10 +0100688 return PSA_SUCCESS;
689 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +0200690#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200691 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100692 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200693 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100694 return PSA_ERROR_INVALID_ARGUMENT;
695 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200696 return mbedtls_psa_ffdh_import_key(attributes,
697 data, data_length,
698 key_buffer, key_buffer_size,
699 key_buffer_length,
700 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100701 }
Valerio Settia55f0422023-07-10 15:34:41 +0200702#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200703 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti27c501a2023-06-27 16:58:52 +0200704#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
706 if (PSA_KEY_TYPE_IS_ECC(type)) {
707 return mbedtls_psa_ecp_import_key(attributes,
708 data, data_length,
709 key_buffer, key_buffer_size,
710 key_buffer_length,
711 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100712 }
Valerio Setti27c501a2023-06-27 16:58:52 +0200713#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800714 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settife478902023-07-25 12:27:19 +0200715#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
716 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
718 if (PSA_KEY_TYPE_IS_RSA(type)) {
719 return mbedtls_psa_rsa_import_key(attributes,
720 data, data_length,
721 key_buffer, key_buffer_size,
722 key_buffer_length,
723 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200724 }
Valerio Settife478902023-07-25 12:27:19 +0200725#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
726 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -0800727 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100728 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100729
Gilles Peskine449bd832023-01-11 14:50:10 +0100730 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100731}
732
Gilles Peskinef603c712019-01-19 13:40:11 +0100733/** Calculate the intersection of two algorithm usage policies.
734 *
735 * Return 0 (which allows no operation) on incompatibility.
736 */
737static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100738 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100739 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100740 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100741{
Gilles Peskine549ea862019-05-22 11:45:59 +0200742 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 if (alg1 == alg2) {
744 return alg1;
745 }
Steven Cooreman03488022021-02-18 12:07:20 +0100746 /* If the policies are from the same hash-and-sign family, check
747 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100748 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
749 PSA_ALG_IS_SIGN_HASH(alg2) &&
750 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
751 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
752 return alg2;
753 }
754 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
755 return alg1;
756 }
Steven Cooreman03488022021-02-18 12:07:20 +0100757 }
758 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100759 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100760 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100761 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
762 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
763 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
764 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
765 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100766 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100767
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100768 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100769 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
770 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
771 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
772 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100773 }
774 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100775 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
776 (alg1_len <= alg2_len)) {
777 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100778 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100779 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
780 (alg2_len <= alg1_len)) {
781 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100782 }
783 }
784 /* If the policies are from the same MAC family, check whether one
785 * of them is a minimum-MAC-length policy. Calculate the most
786 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
788 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
789 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100790 /* Validate the combination of key type and algorithm. Since the base
791 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100792 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
793 return 0;
794 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100795
Steven Cooreman31a876d2021-03-03 20:47:40 +0100796 /* Get the (exact or at-least) output lengths for both sides of the
797 * requested intersection. None of the currently supported algorithms
798 * have an output length dependent on the actual key size, so setting it
799 * to a bogus value of 0 is currently OK.
800 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100801 * Note that for at-least-this-length wildcard algorithms, the output
802 * length is set to the shortest allowed length, which allows us to
803 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100804 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
805 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100806 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100807
Steven Cooremana1d83222021-02-25 10:20:29 +0100808 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100809 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
810 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
811 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100812 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100813
814 /* If only one is an at-least-this-length policy, the intersection would
815 * be the other (fixed-length) policy as long as said fixed length is
816 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100817 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
818 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100819 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100820 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
821 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100822 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100823
Steven Cooremancd640932021-03-08 12:00:27 +0100824 /* If none of them are wildcards, check whether they define the same tag
825 * length. This is still possible here when one is default-length and
826 * the other specific-length. Ensure to always return the
827 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100828 if (alg1_len == alg2_len) {
829 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
830 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100831 }
832 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100833 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100834}
835
Gilles Peskine449bd832023-01-11 14:50:10 +0100836static int psa_key_algorithm_permits(psa_key_type_t key_type,
837 psa_algorithm_t policy_alg,
838 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200839{
Gilles Peskine549ea862019-05-22 11:45:59 +0200840 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100841 if (requested_alg == policy_alg) {
842 return 1;
843 }
Steven Cooreman03488022021-02-18 12:07:20 +0100844 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
845 * and requested_alg is the same hash-and-sign family with any hash,
846 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100847 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
848 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
849 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
850 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100851 }
852 /* If policy_alg is a wildcard AEAD algorithm of the same base as
853 * the requested algorithm, check the requested tag length to be
854 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100855 if (PSA_ALG_IS_AEAD(policy_alg) &&
856 PSA_ALG_IS_AEAD(requested_alg) &&
857 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
858 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
859 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
860 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
861 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100862 }
Steven Cooremancd640932021-03-08 12:00:27 +0100863 /* If policy_alg is a MAC algorithm of the same base as the requested
864 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100865 if (PSA_ALG_IS_MAC(policy_alg) &&
866 PSA_ALG_IS_MAC(requested_alg) &&
867 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
868 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100869 /* Validate the combination of key type and algorithm. Since the policy
870 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100871 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
872 return 0;
873 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100874
Steven Cooreman31a876d2021-03-03 20:47:40 +0100875 /* Get both the requested output length for the algorithm which is to be
876 * verified, and the default output length for the base algorithm.
877 * Note that none of the currently supported algorithms have an output
878 * length dependent on actual key size, so setting it to a bogus value
879 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100880 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100881 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100882 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100883 key_type, 0,
884 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100885
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100886 /* If the policy is default-length, only allow an algorithm with
887 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100888 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
889 return requested_output_length == default_output_length;
890 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100891
892 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100893 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100894 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
895 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
896 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100897 }
898
Steven Cooremancd640932021-03-08 12:00:27 +0100899 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
900 * check for the requested MAC length to be equal to or longer than the
901 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100902 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
903 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
904 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100905 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200906 }
Steven Cooremance48e852020-10-05 16:02:45 +0200907 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200908 * a key derivation with that key agreement should also be allowed. This
909 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100910 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
911 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
912 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
913 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +0200914 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100915 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100916 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200917}
918
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100919/** Test whether a policy permits an algorithm.
920 *
921 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100922 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100923 * \note This function requires providing the key type for which the policy is
924 * being validated, since some algorithm policy definitions (e.g. MAC)
925 * have different properties depending on what kind of cipher it is
926 * combined with.
927 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100928 * \retval PSA_SUCCESS When \p alg is a specific algorithm
929 * allowed by the \p policy.
930 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
931 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
932 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100933 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100934static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
935 psa_key_type_t key_type,
936 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100937{
Steven Cooremand788fab2021-02-25 11:29:17 +0100938 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +0100939 if (alg == 0) {
940 return PSA_ERROR_INVALID_ARGUMENT;
941 }
Steven Cooremand788fab2021-02-25 11:29:17 +0100942
Steven Cooreman7e39f052021-02-23 14:18:32 +0100943 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100944 if (PSA_ALG_IS_WILDCARD(alg)) {
945 return PSA_ERROR_INVALID_ARGUMENT;
946 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100947
Gilles Peskine449bd832023-01-11 14:50:10 +0100948 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
949 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
950 return PSA_SUCCESS;
951 } else {
952 return PSA_ERROR_NOT_PERMITTED;
953 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100954}
955
Gilles Peskinef603c712019-01-19 13:40:11 +0100956/** Restrict a key policy based on a constraint.
957 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100958 * \note This function requires providing the key type for which the policy is
959 * being restricted, since some algorithm policy definitions (e.g. MAC)
960 * have different properties depending on what kind of cipher it is
961 * combined with.
962 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100963 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100964 * \param[in,out] policy The policy to restrict.
965 * \param[in] constraint The policy constraint to apply.
966 *
967 * \retval #PSA_SUCCESS
968 * \c *policy contains the intersection of the original value of
969 * \c *policy and \c *constraint.
970 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100971 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100972 * \c *policy is unchanged.
973 */
974static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100975 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100976 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +0100977 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +0100978{
979 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +0100980 psa_key_policy_algorithm_intersection(key_type, policy->alg,
981 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +0200982 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +0100983 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
984 constraint->alg2);
985 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
986 return PSA_ERROR_INVALID_ARGUMENT;
987 }
988 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
989 return PSA_ERROR_INVALID_ARGUMENT;
990 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100991 policy->usage &= constraint->usage;
992 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200993 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100994 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +0100995}
996
Przemek Stekiel061f6942022-11-30 10:51:35 +0100997/** Get the description of a key given its identifier and policy constraints
998 * and lock it.
999 *
1000 * The key must have allow all the usage flags set in \p usage. If \p alg is
1001 * nonzero, the key must allow operations with this algorithm. If \p alg is
1002 * zero, the algorithm is not checked.
1003 *
1004 * In case of a persistent key, the function loads the description of the key
1005 * into a key slot if not already done.
1006 *
Ryan Everett098c6652024-01-03 13:03:36 +00001007 * On success, the returned key slot has been registered for reading.
1008 * It is the responsibility of the caller to call psa_unregister_read(slot)
1009 * when they have finished reading the contents of the slot.
Przemek Stekiel061f6942022-11-30 10:51:35 +01001010 */
1011static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01001012 mbedtls_svc_key_id_t key,
1013 psa_key_slot_t **p_slot,
1014 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001015 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +01001016{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001017 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01001018 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001019
Gilles Peskine449bd832023-01-11 14:50:10 +01001020 status = psa_get_and_lock_key_slot(key, p_slot);
1021 if (status != PSA_SUCCESS) {
1022 return status;
1023 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001024 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001025
1026 /* Enforce that usage policy for the key slot contains all the flags
1027 * required by the usage parameter. There is one exception: public
1028 * keys can always be exported, so we treat public key objects as
1029 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001030 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +01001031 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001032 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001033
Gilles Peskine449bd832023-01-11 14:50:10 +01001034 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +01001035 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001036 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001037 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001038
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001039 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001040 if (alg != 0) {
1041 status = psa_key_policy_permits(&slot->attr.policy,
1042 slot->attr.type,
1043 alg);
1044 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +01001045 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001046 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001047 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001048
Gilles Peskine449bd832023-01-11 14:50:10 +01001049 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001050
1051error:
1052 *p_slot = NULL;
Ryan Everett098c6652024-01-03 13:03:36 +00001053 psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001054
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +01001056}
Darryl Green940d72c2018-07-13 13:18:51 +01001057
Ronald Cron5c522922020-11-14 16:35:34 +01001058/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001059 *
1060 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +02001061 * available, as opposed to a key in a secure element and/or to be used
1062 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001063 *
Ronald Cronddae0f52021-08-24 15:39:44 +02001064 * This is a temporary function that may be used instead of
1065 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
1066 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001067 *
Ryan Everett098c6652024-01-03 13:03:36 +00001068 * On success, the returned key slot has been registered for reading.
1069 * It is the responsibility of the caller to call psa_unregister_read(slot)
1070 * when they have finished reading the contents of the slot.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001071 */
Ronald Cron5c522922020-11-14 16:35:34 +01001072static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1073 mbedtls_svc_key_id_t key,
1074 psa_key_slot_t **p_slot,
1075 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +02001077{
Gilles Peskine449bd832023-01-11 14:50:10 +01001078 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
1079 usage, alg);
1080 if (status != PSA_SUCCESS) {
1081 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001082 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001083
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
Ryan Everett098c6652024-01-03 13:03:36 +00001085 psa_unregister_read(*p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 *p_slot = NULL;
1087 return PSA_ERROR_NOT_SUPPORTED;
1088 }
1089
1090 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001091}
Gilles Peskine28f8f302019-07-24 13:30:31 +02001092
Gilles Peskine449bd832023-01-11 14:50:10 +01001093psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +00001094{
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +01001096 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001098
Ronald Cronea0f8a62020-11-25 17:52:23 +01001099 slot->key.data = NULL;
1100 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001101
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001103}
1104
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001105/** Completely wipe a slot in memory, including its policy.
1106 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001107psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001108{
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001110
Gilles Peskine449bd832023-01-11 14:50:10 +01001111 /*
1112 * As the return error code may not be handled in case of multiple errors,
Ryan Everett7ed542e2024-01-17 11:39:09 +00001113 * do our best to report an unexpected amount of registered readers or
1114 * an unexpected state.
1115 * Assert with MBEDTLS_TEST_HOOK_TEST_ASSERT that the slot is valid for
1116 * wiping.
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1118 * function is called as part of the execution of a test suite, the
1119 * execution of the test suite is stopped in error if the assertion fails.
1120 */
Ryan Everett7ed542e2024-01-17 11:39:09 +00001121 switch (slot->state) {
1122 case PSA_SLOT_FULL:
1123 /* In this state psa_wipe_key_slot() must only be called if the
1124 * caller is the last reader. */
1125 case PSA_SLOT_PENDING_DELETION:
1126 /* In this state psa_wipe_key_slot() must only be called if the
1127 * caller is the last reader. */
1128 if (slot->registered_readers != 1) {
1129 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 1);
1130 status = PSA_ERROR_CORRUPTION_DETECTED;
1131 }
1132 break;
1133 case PSA_SLOT_FILLING:
1134 /* In this state registered_readers must be 0. */
1135 if (slot->registered_readers != 0) {
1136 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 0);
1137 status = PSA_ERROR_CORRUPTION_DETECTED;
1138 }
1139 break;
1140 case PSA_SLOT_EMPTY:
1141 /* The slot is already empty, it cannot be wiped. */
1142 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->state != PSA_SLOT_EMPTY);
1143 status = PSA_ERROR_CORRUPTION_DETECTED;
1144 break;
1145 default:
1146 /* The slot's state is invalid. */
1147 status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronddd3d052020-10-30 14:07:07 +01001148 }
1149
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001150 /* Multipart operations may still be using the key. This is safe
1151 * because all multipart operation objects are independent from
1152 * the key slot: if they need to access the key after the setup
1153 * phase, they have a copy of the key. Note that this means that
1154 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001155 /* At this point, key material and other type-specific content has
1156 * been wiped. Clear remaining metadata. We can call memset and not
Ryan Everettaa33c512023-12-21 17:32:07 +00001157 * zeroize because the metadata is not particularly sensitive.
1158 * This memset also sets the slot's state to PSA_SLOT_EMPTY. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001159 memset(slot, 0, sizeof(*slot));
1160 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001161}
1162
Gilles Peskine449bd832023-01-11 14:50:10 +01001163psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001164{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001165 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001166 psa_status_t status; /* status of the last operation */
1167 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001168#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1169 psa_se_drv_table_entry_t *driver;
1170#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001171
Gilles Peskine449bd832023-01-11 14:50:10 +01001172 if (mbedtls_svc_key_id_is_null(key)) {
1173 return PSA_SUCCESS;
1174 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001175
Ronald Cronf2911112020-10-29 17:51:10 +01001176 /*
Ryan Everett7ed542e2024-01-17 11:39:09 +00001177 * Get the description of the key in a key slot, and register to read it.
1178 * In the case of a persistent key, this will load the key description
1179 * from persistent memory if not done yet.
1180 * We cannot avoid this loading as without it we don't know if
Ronald Cronf2911112020-10-29 17:51:10 +01001181 * the key is operated by an SE or not and this information is needed by
Ryan Everett7ed542e2024-01-17 11:39:09 +00001182 * the current implementation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001183 status = psa_get_and_lock_key_slot(key, &slot);
1184 if (status != PSA_SUCCESS) {
1185 return status;
1186 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001187
Ryan Everett7ed542e2024-01-17 11:39:09 +00001188 /* Set the key slot containing the key description's state to
1189 * PENDING_DELETION. This stops new operations from registering
1190 * to read the slot. Current readers can safely continue to access
1191 * the key within the slot; the last registered reader will
1192 * automatically wipe the slot when they call psa_unregister_read().
1193 * If the key is persistent, we can now delete the copy of the key
1194 * from memory. If the key is opaque, we require the driver to
1195 * deal with the deletion. */
Ryan Everettc70ce572024-01-03 16:04:33 +00001196 slot->state = PSA_SLOT_PENDING_DELETION;
Ronald Cronf2911112020-10-29 17:51:10 +01001197
Gilles Peskine449bd832023-01-11 14:50:10 +01001198 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001199 /* Refuse the destruction of a read-only key (which may or may not work
1200 * if we attempt it, depending on whether the key is merely read-only
1201 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001202 * Just do the best we can, which is to wipe the copy in memory
1203 * (done in this function's cleanup code). */
1204 overall_status = PSA_ERROR_NOT_PERMITTED;
1205 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001206 }
1207
Gilles Peskine354f7672019-07-12 23:46:38 +02001208#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001209 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1210 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001211 /* For a key in a secure element, we need to do three things:
1212 * remove the key file in internal storage, destroy the
1213 * key inside the secure element, and update the driver's
1214 * persistent data. Start a transaction that will encompass these
1215 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001217 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001218 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001219 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 status = psa_crypto_save_transaction();
1221 if (status != PSA_SUCCESS) {
1222 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001223 /* We should still try to destroy the key in the secure
1224 * element and the key metadata in storage. This is especially
1225 * important if the error is that the storage is full.
1226 * But how to do it exactly without risking an inconsistent
1227 * state after a reset?
1228 * https://github.com/ARMmbed/mbed-crypto/issues/215
1229 */
1230 overall_status = status;
1231 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001232 }
1233
Gilles Peskine449bd832023-01-11 14:50:10 +01001234 status = psa_destroy_se_key(driver,
1235 psa_key_slot_get_slot_number(slot));
1236 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001237 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001238 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001239 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001240#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1241
Darryl Greend49a4992018-06-18 17:27:26 +01001242#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001243 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ryan Everett4a0ba802024-01-17 14:12:33 +00001244 /* Destroy the copy of the persistent key from storage.
Ryan Everett7ed542e2024-01-17 11:39:09 +00001245 * The slot will still hold a copy of the key until the last reader
1246 * unregisters. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001247 status = psa_destroy_persistent_key(slot->attr.id);
1248 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001249 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001250 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001251
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001252 /* TODO: other slots may have a copy of the same key. We should
1253 * invalidate them.
1254 * https://github.com/ARMmbed/mbed-crypto/issues/214
1255 */
Darryl Greend49a4992018-06-18 17:27:26 +01001256 }
1257#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001258
Gilles Peskinefc762652019-07-22 19:30:34 +02001259#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001260 if (driver != NULL) {
1261 status = psa_save_se_persistent_data(driver);
1262 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001263 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001264 }
1265 status = psa_crypto_stop_transaction();
1266 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001267 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001268 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001269 }
1270#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1271
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001272exit:
Ryan Everett7ed542e2024-01-17 11:39:09 +00001273 /* Unregister from reading the slot. If we are the last active reader
1274 * then this will wipe the slot. */
1275 status = psa_unregister_read(slot);
1276 /* Prioritize CORRUPTION_DETECTED from unregistering over
1277 * a storage error. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001278 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001279 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001280 }
1281 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001282}
1283
Valerio Settib2bcedb2023-07-10 11:24:00 +02001284#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001285 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001286static psa_status_t psa_get_rsa_public_exponent(
1287 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001288 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001289{
1290 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001291 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001292 uint8_t *buffer = NULL;
1293 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001294 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001295
Gilles Peskine449bd832023-01-11 14:50:10 +01001296 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1297 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001298 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001299 }
1300 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001301 /* It's the default value, which is reported as an empty string,
1302 * so there's nothing to do. */
1303 goto exit;
1304 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001305
Gilles Peskine449bd832023-01-11 14:50:10 +01001306 buflen = mbedtls_mpi_size(&mpi);
1307 buffer = mbedtls_calloc(1, buflen);
1308 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001309 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1310 goto exit;
1311 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001312 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1313 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001314 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001315 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001316 attributes->domain_parameters = buffer;
1317 attributes->domain_parameters_size = buflen;
1318
1319exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001320 mbedtls_mpi_free(&mpi);
1321 if (ret != 0) {
1322 mbedtls_free(buffer);
1323 }
1324 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001325}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001326#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001327 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001328
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001329/** Retrieve all the publicly-accessible attributes of a key.
1330 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001331psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1332 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001333{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001334 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001335 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001336 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001337
Gilles Peskine449bd832023-01-11 14:50:10 +01001338 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001339
Gilles Peskine449bd832023-01-11 14:50:10 +01001340 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1341 if (status != PSA_SUCCESS) {
1342 return status;
1343 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001344
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001345 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001346 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1347 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001348
1349#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001350 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1351 psa_set_key_slot_number(attributes,
1352 psa_key_slot_get_slot_number(slot));
1353 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001354#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001355
Gilles Peskine449bd832023-01-11 14:50:10 +01001356 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001357#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1358 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001359 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001360 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001361 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Pengyu Lvf75893b2023-12-08 17:21:39 +08001362 /* TODO: This is a temporary situation where domain parameters are deprecated,
1363 * but we need it for namely generating an RSA key with a non-default exponent.
1364 * This would be improved after https://github.com/Mbed-TLS/mbedtls/issues/6494.
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001365 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001366 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001367 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001368
Ronald Cron90857082020-11-25 14:58:33 +01001369 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001370 slot->attr.type,
1371 slot->key.data,
1372 slot->key.bytes,
1373 &rsa);
1374 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001375 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001376 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001377
Gilles Peskine449bd832023-01-11 14:50:10 +01001378 status = psa_get_rsa_public_exponent(rsa,
1379 attributes);
1380 mbedtls_rsa_free(rsa);
1381 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001382 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001383 break;
Pengyu Lve9efbc22023-12-08 16:59:08 +08001384#else
1385 case PSA_KEY_TYPE_RSA_KEY_PAIR:
1386 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
1387 attributes->domain_parameters = NULL;
1388 attributes->domain_parameters_size = SIZE_MAX;
1389 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001390#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1391 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001392 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001393 default:
1394 /* Nothing else to do. */
1395 break;
1396 }
1397
Gilles Peskine449bd832023-01-11 14:50:10 +01001398 if (status != PSA_SUCCESS) {
1399 psa_reset_key_attributes(attributes);
1400 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001401
Ryan Everett1b70a072024-01-04 10:32:49 +00001402 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001403
Gilles Peskine449bd832023-01-11 14:50:10 +01001404 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001405}
1406
Gilles Peskinec8000c02019-08-02 20:15:51 +02001407#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1408psa_status_t psa_get_key_slot_number(
1409 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001410 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001411{
Gilles Peskine449bd832023-01-11 14:50:10 +01001412 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001413 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001414 return PSA_SUCCESS;
1415 } else {
1416 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001417 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001418}
1419#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1420
Gilles Peskine449bd832023-01-11 14:50:10 +01001421static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1422 size_t key_buffer_size,
1423 uint8_t *data,
1424 size_t data_size,
1425 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001426{
Gilles Peskine449bd832023-01-11 14:50:10 +01001427 if (key_buffer_size > data_size) {
1428 return PSA_ERROR_BUFFER_TOO_SMALL;
1429 }
1430 memcpy(data, key_buffer, key_buffer_size);
1431 memset(data + key_buffer_size, 0,
1432 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001433 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001434 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001435}
1436
Ronald Cron7285cda2020-11-26 14:46:37 +01001437psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001438 const psa_key_attributes_t *attributes,
1439 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001440 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001441{
Ronald Crond18b5f82020-11-25 16:46:05 +01001442 psa_key_type_t type = attributes->core.type;
1443
Gilles Peskine449bd832023-01-11 14:50:10 +01001444 if (key_type_is_raw_bytes(type) ||
1445 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001446 PSA_KEY_TYPE_IS_ECC(type) ||
1447 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001448 return psa_export_key_buffer_internal(
1449 key_buffer, key_buffer_size,
1450 data, data_size, data_length);
1451 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001452 /* This shouldn't happen in the reference implementation, but
1453 it is valid for a special-purpose implementation to omit
1454 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001455 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001456 }
1457}
1458
Gilles Peskine449bd832023-01-11 14:50:10 +01001459psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
Ryan Everett45ac5262024-01-08 17:15:19 +00001460 uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01001461 size_t data_size,
1462 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001463{
1464 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1465 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1466 psa_key_slot_t *slot;
Ryan Everett45ac5262024-01-08 17:15:19 +00001467 LOCAL_OUTPUT_DECLARE(data_external, data);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001468
Ronald Crone907e552021-01-18 13:22:38 +01001469 /* Reject a zero-length output buffer now, since this can never be a
1470 * valid key representation. This way we know that data must be a valid
1471 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001472 if (data_size == 0) {
1473 return PSA_ERROR_BUFFER_TOO_SMALL;
1474 }
Ronald Crone907e552021-01-18 13:22:38 +01001475
Ronald Cron9486f9d2020-11-26 13:36:23 +01001476 /* Set the key to empty now, so that even when there are errors, we always
1477 * set data_length to a value between 0 and data_size. On error, setting
1478 * the key to empty is a good choice because an empty key representation is
1479 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001480 *data_length = 0;
1481
Ronald Cron9486f9d2020-11-26 13:36:23 +01001482 /* Export requires the EXPORT flag. There is an exception for public keys,
1483 * which don't require any flag, but
1484 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1485 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001486 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1487 PSA_KEY_USAGE_EXPORT, 0);
1488 if (status != PSA_SUCCESS) {
1489 return status;
1490 }
mohammad160306e79202018-03-28 13:17:44 +03001491
Ryan Everett45ac5262024-01-08 17:15:19 +00001492 LOCAL_OUTPUT_ALLOC(data_external, data_size, data);
1493
Ronald Crond18b5f82020-11-25 16:46:05 +01001494 psa_key_attributes_t attributes = {
1495 .core = slot->attr
1496 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001497 status = psa_driver_wrapper_export_key(&attributes,
1498 slot->key.data, slot->key.bytes,
1499 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001500
Ryan Everett35f68532024-01-25 12:02:03 +00001501#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Ryan Everett45ac5262024-01-08 17:15:19 +00001502exit:
Ryan Everett35f68532024-01-25 12:02:03 +00001503#endif
Ryan Everett1b70a072024-01-04 10:32:49 +00001504 unlock_status = psa_unregister_read(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001505
Ryan Everett45ac5262024-01-08 17:15:19 +00001506 LOCAL_OUTPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01001507 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001508}
1509
Ronald Cron7285cda2020-11-26 14:46:37 +01001510psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001511 const psa_key_attributes_t *attributes,
1512 const uint8_t *key_buffer,
1513 size_t key_buffer_size,
1514 uint8_t *data,
1515 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001516 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001517{
Ronald Crond18b5f82020-11-25 16:46:05 +01001518 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001519
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001520 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001521 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1522 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001523 /* Exporting public -> public */
1524 return psa_export_key_buffer_internal(
1525 key_buffer, key_buffer_size,
1526 data, data_size, data_length);
1527 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001528#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001529 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1530 return mbedtls_psa_rsa_export_public_key(attributes,
1531 key_buffer,
1532 key_buffer_size,
1533 data,
1534 data_size,
1535 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001536#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001537 /* We don't know how to convert a private RSA key to public. */
1538 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001539#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001540 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001541 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001542#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001543 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1544 return mbedtls_psa_ecp_export_public_key(attributes,
1545 key_buffer,
1546 key_buffer_size,
1547 data,
1548 data_size,
1549 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001550#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001551 /* We don't know how to convert a private ECC key to public */
1552 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001553#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001554 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001555 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001556#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001557 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001558 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001559 key_buffer,
1560 key_buffer_size,
1561 data, data_size,
1562 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001563#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001564 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001565#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001566 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001567 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001568 (void) key_buffer;
1569 (void) key_buffer_size;
1570 (void) data;
1571 (void) data_size;
1572 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001573 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001574 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001575}
Ronald Crond18b5f82020-11-25 16:46:05 +01001576
Gilles Peskine449bd832023-01-11 14:50:10 +01001577psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
Ryan Everettb1d2c672024-01-08 17:19:30 +00001578 uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01001579 size_t data_size,
1580 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001581{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001582 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001583 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001584 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001585 psa_key_attributes_t attributes;
Ryan Everettb1d2c672024-01-08 17:19:30 +00001586 LOCAL_OUTPUT_DECLARE(data_external, data);
Darryl Greendd8fb772018-11-07 16:00:44 +00001587
Ronald Crone907e552021-01-18 13:22:38 +01001588 /* Reject a zero-length output buffer now, since this can never be a
1589 * valid key representation. This way we know that data must be a valid
1590 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001591 if (data_size == 0) {
1592 return PSA_ERROR_BUFFER_TOO_SMALL;
1593 }
Ronald Crone907e552021-01-18 13:22:38 +01001594
Darryl Greendd8fb772018-11-07 16:00:44 +00001595 /* Set the key to empty now, so that even when there are errors, we always
1596 * set data_length to a value between 0 and data_size. On error, setting
1597 * the key to empty is a good choice because an empty key representation is
1598 * unlikely to be accepted anywhere. */
1599 *data_length = 0;
1600
1601 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001602 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1603 if (status != PSA_SUCCESS) {
1604 return status;
1605 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001606
Ryan Everettb1d2c672024-01-08 17:19:30 +00001607 LOCAL_OUTPUT_ALLOC(data_external, data_size, data);
1608
Gilles Peskine449bd832023-01-11 14:50:10 +01001609 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1610 status = PSA_ERROR_INVALID_ARGUMENT;
1611 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001612 }
1613
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001614 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001615 .core = slot->attr
1616 };
Ronald Cron67227982020-11-26 15:16:05 +01001617 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001618 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001619 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001620
1621exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00001622 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001623
Ryan Everettb1d2c672024-01-08 17:19:30 +00001624 LOCAL_OUTPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01001625 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001626}
1627
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001628MBEDTLS_STATIC_ASSERT(
1629 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1630 "One or more key attribute flag is listed as both external-only and dual-use")
1631MBEDTLS_STATIC_ASSERT(
1632 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1633 "One or more key attribute flag is listed as both internal-only and dual-use")
1634MBEDTLS_STATIC_ASSERT(
1635 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1636 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001637
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001638/** Validate that a key policy is internally well-formed.
1639 *
1640 * This function only rejects invalid policies. It does not validate the
1641 * consistency of the policy with respect to other attributes of the key
1642 * such as the key type.
1643 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001644static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001645{
Gilles Peskine449bd832023-01-11 14:50:10 +01001646 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1647 PSA_KEY_USAGE_COPY |
1648 PSA_KEY_USAGE_ENCRYPT |
1649 PSA_KEY_USAGE_DECRYPT |
1650 PSA_KEY_USAGE_SIGN_MESSAGE |
1651 PSA_KEY_USAGE_VERIFY_MESSAGE |
1652 PSA_KEY_USAGE_SIGN_HASH |
1653 PSA_KEY_USAGE_VERIFY_HASH |
1654 PSA_KEY_USAGE_VERIFY_DERIVATION |
1655 PSA_KEY_USAGE_DERIVE)) != 0) {
1656 return PSA_ERROR_INVALID_ARGUMENT;
1657 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001658
Gilles Peskine449bd832023-01-11 14:50:10 +01001659 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001660}
1661
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001662/** Validate the internal consistency of key attributes.
1663 *
1664 * This function only rejects invalid attribute values. If does not
1665 * validate the consistency of the attributes with any key data that may
1666 * be involved in the creation of the key.
1667 *
1668 * Call this function early in the key creation process.
1669 *
1670 * \param[in] attributes Key attributes for the new key.
1671 * \param[out] p_drv On any return, the driver for the key, if any.
1672 * NULL for a transparent key.
1673 *
1674 */
1675static psa_status_t psa_validate_key_attributes(
1676 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001677 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001678{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001679 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001680 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1681 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001682
Gilles Peskine449bd832023-01-11 14:50:10 +01001683 status = psa_validate_key_location(lifetime, p_drv);
1684 if (status != PSA_SUCCESS) {
1685 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001686 }
1687
Gilles Peskine449bd832023-01-11 14:50:10 +01001688 status = psa_validate_key_persistence(lifetime);
1689 if (status != PSA_SUCCESS) {
1690 return status;
1691 }
1692
1693 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1694 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1695 return PSA_ERROR_INVALID_ARGUMENT;
1696 }
1697 } else {
1698 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1699 return PSA_ERROR_INVALID_ARGUMENT;
1700 }
1701 }
1702
1703 status = psa_validate_key_policy(&attributes->core.policy);
1704 if (status != PSA_SUCCESS) {
1705 return status;
1706 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001707
1708 /* Refuse to create overly large keys.
1709 * Note that this doesn't trigger on import if the attributes don't
1710 * explicitly specify a size (so psa_get_key_bits returns 0), so
1711 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001712 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1713 return PSA_ERROR_NOT_SUPPORTED;
1714 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001715
Gilles Peskine91e8c332019-08-02 19:19:39 +02001716 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001717 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1718 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1719 return PSA_ERROR_INVALID_ARGUMENT;
1720 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001721
Gilles Peskine449bd832023-01-11 14:50:10 +01001722 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001723}
1724
Gilles Peskine4747d192019-04-17 15:05:45 +02001725/** Prepare a key slot to receive key material.
1726 *
1727 * This function allocates a key slot and sets its metadata.
1728 *
1729 * If this function fails, call psa_fail_key_creation().
1730 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001731 * This function is intended to be used as follows:
1732 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001733 * it with the specified attributes, and in case of a volatile key assign it
1734 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001735 * -# Populate the slot with the key material.
1736 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1737 * In case of failure at any step, stop the sequence and call
1738 * psa_fail_key_creation().
1739 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001740 * On success, the key slot's state is PSA_SLOT_FILLING.
1741 * It is the responsibility of the caller to change the slot's state to
1742 * PSA_SLOT_EMPTY/FULL once key creation has finished.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001743 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001744 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001745 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001746 * \param[out] p_slot On success, a pointer to the prepared slot.
1747 * \param[out] p_drv On any return, the driver for the key, if any.
1748 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001749 *
1750 * \retval #PSA_SUCCESS
1751 * The key slot is ready to receive key material.
1752 * \return If this function fails, the key slot is an invalid state.
1753 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001754 */
1755static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001756 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001757 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001758 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001759 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001760{
1761 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001762 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001763 psa_key_slot_t *slot;
1764
Gilles Peskinedf179142019-07-15 22:02:14 +02001765 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001766 *p_drv = NULL;
1767
Gilles Peskine449bd832023-01-11 14:50:10 +01001768 status = psa_validate_key_attributes(attributes, p_drv);
1769 if (status != PSA_SUCCESS) {
1770 return status;
1771 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001772
Ryan Everettb69118e2024-01-02 15:54:32 +00001773 status = psa_reserve_free_key_slot(&volatile_key_id, p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001774 if (status != PSA_SUCCESS) {
1775 return status;
1776 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001777 slot = *p_slot;
1778
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001779 /* We're storing the declared bit-size of the key. It's up to each
1780 * creation mechanism to verify that this information is correct.
1781 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001782 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001783 * is optional (import, copy). In case of a volatile key, assign it the
1784 * volatile key identifier associated to the slot returned to contain its
1785 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001786
1787 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001788 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001789#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1790 slot->attr.id = volatile_key_id;
1791#else
1792 slot->attr.id.key_id = volatile_key_id;
1793#endif
1794 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001795
Gilles Peskine91e8c332019-08-02 19:19:39 +02001796 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001797 * external-only flags, query `attributes`. Thanks to the check
1798 * in psa_validate_key_attributes(), this leaves the dual-use
Ryan Everettb69118e2024-01-02 15:54:32 +00001799 * flags and any internal flag that psa_reserve_free_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001800 * may have set. */
1801 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001802
Gilles Peskinecbaff462019-07-12 23:46:04 +02001803#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001804 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001805 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001806 * create the key file in internal storage, create the
1807 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001808 * persistent data. This is done by starting a transaction that will
1809 * encompass these three actions.
1810 * For registering a volatile key, we just need to find an appropriate
1811 * slot number inside the SE. Since the key is designated volatile, creating
1812 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001813 /* The first thing to do is to find a slot number for the new key.
1814 * We save the slot number in persistent storage as part of the
1815 * transaction data. It will be needed to recover if the power
1816 * fails during the key creation process, to clean up on the secure
1817 * element side after restarting. Obtaining a slot number from the
1818 * secure element driver updates its persistent state, but we do not yet
1819 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001820 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001821 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001822 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001823 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1824 &slot_number);
1825 if (status != PSA_SUCCESS) {
1826 return status;
1827 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001828
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1830 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001831 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001832 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001833 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001834 status = psa_crypto_save_transaction();
1835 if (status != PSA_SUCCESS) {
1836 (void) psa_crypto_stop_transaction();
1837 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001838 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001839 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001840
1841 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001842 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001843 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001844
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001846 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001848 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001849#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1850
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001852}
Gilles Peskine4747d192019-04-17 15:05:45 +02001853
1854/** Finalize the creation of a key once its key material has been set.
1855 *
1856 * This entails writing the key to persistent storage.
1857 *
1858 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001859 * See the documentation of psa_start_key_creation() for the intended use
1860 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001861 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001862 * If the finalization succeeds, the function sets the key slot's state to
1863 * PSA_SLOT_FULL, and the key slot can no longer be accessed as part of the
1864 * key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001865 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001866 * \param[in,out] slot Pointer to the slot with key material.
1867 * \param[in] driver The secure element driver for the key,
1868 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001869 * \param[out] key On success, identifier of the key. Note that the
1870 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001871 *
1872 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001873 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001874 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1875 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1876 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1877 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1878 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1879 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001880 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001881 * \return If this function fails, the key slot is an invalid state.
1882 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001883 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001884static psa_status_t psa_finish_key_creation(
1885 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001886 psa_se_drv_table_entry_t *driver,
1887 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001888{
1889 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001890 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001891 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001892
1893#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001894 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001895#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001896 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001897 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001898 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001899 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001900
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001901 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1902 sizeof(data.slot_number),
1903 "Slot number size does not match psa_se_key_data_storage_t");
1904
Gilles Peskine449bd832023-01-11 14:50:10 +01001905 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1906 status = psa_save_persistent_key(&slot->attr,
1907 (uint8_t *) &data,
1908 sizeof(data));
1909 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001910#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1911 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001912 /* Key material is saved in export representation in the slot, so
1913 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001914 status = psa_save_persistent_key(&slot->attr,
1915 slot->key.data,
1916 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001917 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001918 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001919#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1920
Gilles Peskinecbaff462019-07-12 23:46:04 +02001921#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001922 /* Finish the transaction for a key creation. This does not
1923 * happen when registering an existing key. Detect this case
1924 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001925 * creation of a persistent key in a secure element requires a transaction,
1926 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001927 if (driver != NULL &&
1928 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1929 status = psa_save_se_persistent_data(driver);
1930 if (status != PSA_SUCCESS) {
1931 psa_destroy_persistent_key(slot->attr.id);
1932 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001933 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001934 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001935 }
1936#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1937
Gilles Peskine449bd832023-01-11 14:50:10 +01001938 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001939 *key = slot->attr.id;
Ryan Everettb69118e2024-01-02 15:54:32 +00001940 status = psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1941 PSA_SLOT_FULL);
Gilles Peskine449bd832023-01-11 14:50:10 +01001942 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001943 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001944 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001945 }
Ronald Cron50972942020-11-14 11:28:25 +01001946
Gilles Peskine449bd832023-01-11 14:50:10 +01001947 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001948}
1949
1950/** Abort the creation of a key.
1951 *
1952 * You may call this function after calling psa_start_key_creation(),
1953 * or after psa_finish_key_creation() fails. In other circumstances, this
1954 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001955 * See the documentation of psa_start_key_creation() for the intended use
Ryan Everettb69118e2024-01-02 15:54:32 +00001956 * of this function. Sets the slot's state to PSA_SLOT_EMPTY.
Gilles Peskine4747d192019-04-17 15:05:45 +02001957 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001958 * \param[in,out] slot Pointer to the slot with key material.
1959 * \param[in] driver The secure element driver for the key,
1960 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001961 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001962static void psa_fail_key_creation(psa_key_slot_t *slot,
1963 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001964{
Gilles Peskine011e4282019-06-26 18:34:38 +02001965 (void) driver;
1966
Gilles Peskine449bd832023-01-11 14:50:10 +01001967 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001968 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001969 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001970
1971#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001972 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001973 * element, and the failure happened later (when saving metadata
1974 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001975 * element.
1976 * https://github.com/ARMmbed/mbed-crypto/issues/217
1977 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001978
Gilles Peskined7729582019-08-05 15:55:54 +02001979 /* Abort the ongoing transaction if any (there may not be one if
1980 * the creation process failed before starting one, or if the
1981 * key creation is a registration of a key in a secure element).
1982 * Earlier functions must already have done what it takes to undo any
1983 * partial creation. All that's left is to update the transaction data
1984 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001985 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001986#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1987
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02001989}
1990
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001991/** Validate optional attributes during key creation.
1992 *
1993 * Some key attributes are optional during key creation. If they are
1994 * specified in the attributes structure, check that they are consistent
1995 * with the data in the slot.
1996 *
1997 * This function should be called near the end of key creation, after
1998 * the slot in memory is fully populated but before saving persistent data.
1999 */
2000static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002001 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002003{
Gilles Peskine449bd832023-01-11 14:50:10 +01002004 if (attributes->core.type != 0) {
2005 if (attributes->core.type != slot->attr.type) {
2006 return PSA_ERROR_INVALID_ARGUMENT;
2007 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002008 }
2009
Gilles Peskine449bd832023-01-11 14:50:10 +01002010 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02002011#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
2012 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
2014 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02002015 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002016 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002017 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002018
Ronald Cron90857082020-11-25 14:58:33 +01002019 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01002020 slot->attr.type,
2021 slot->key.data,
2022 slot->key.bytes,
2023 &rsa);
2024 if (status != PSA_SUCCESS) {
2025 return status;
2026 }
Steven Cooreman75b74362020-07-28 14:30:13 +02002027
Gilles Peskine449bd832023-01-11 14:50:10 +01002028 mbedtls_mpi_init(&actual);
2029 mbedtls_mpi_init(&required);
2030 ret = mbedtls_rsa_export(rsa,
2031 NULL, NULL, NULL, NULL, &actual);
2032 mbedtls_rsa_free(rsa);
2033 mbedtls_free(rsa);
2034 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002035 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 }
2037 ret = mbedtls_mpi_read_binary(&required,
2038 attributes->domain_parameters,
2039 attributes->domain_parameters_size);
2040 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002041 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002042 }
2043 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002044 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01002045 }
2046rsa_exit:
2047 mbedtls_mpi_free(&actual);
2048 mbedtls_mpi_free(&required);
2049 if (ret != 0) {
2050 return mbedtls_to_psa_error(ret);
2051 }
2052 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02002053#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
2054 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08002055 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002056 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002057 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002058 }
2059 }
2060
Gilles Peskine449bd832023-01-11 14:50:10 +01002061 if (attributes->core.bits != 0) {
2062 if (attributes->core.bits != slot->attr.bits) {
2063 return PSA_ERROR_INVALID_ARGUMENT;
2064 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002065 }
2066
Gilles Peskine449bd832023-01-11 14:50:10 +01002067 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002068}
2069
Gilles Peskine449bd832023-01-11 14:50:10 +01002070psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
Ryan Everettf028fe12024-01-08 17:14:44 +00002071 const uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 size_t data_length,
2073 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002074{
2075 psa_status_t status;
Ryan Everettf028fe12024-01-08 17:14:44 +00002076 LOCAL_INPUT_DECLARE(data_external, data);
Gilles Peskine4747d192019-04-17 15:05:45 +02002077 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002078 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002079 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302080 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002081
Ronald Cron81709fc2020-11-14 12:10:32 +01002082 *key = MBEDTLS_SVC_KEY_ID_INIT;
2083
Gilles Peskine0f84d622019-09-12 19:03:13 +02002084 /* Reject zero-length symmetric keys (including raw data key objects).
2085 * This also rejects any key which might be encoded as an empty string,
2086 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002087 if (data_length == 0) {
2088 return PSA_ERROR_INVALID_ARGUMENT;
2089 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002090
Archana449608b2021-09-08 15:36:05 +05302091 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002092 if (data_length > SIZE_MAX / 8) {
2093 return PSA_ERROR_NOT_SUPPORTED;
2094 }
Archana6ed4bda2021-08-04 10:47:15 +05302095
Ryan Everettf028fe12024-01-08 17:14:44 +00002096 LOCAL_INPUT_ALLOC(data_external, data_length, data);
2097
Gilles Peskine449bd832023-01-11 14:50:10 +01002098 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2099 &slot, &driver);
2100 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002101 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002102 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002103
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002104 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302105 * storage ( thus not in the case of importing a key in a secure element
2106 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2107 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 if (slot->key.data == NULL) {
2109 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302110 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002111 attributes, data, data_length, &storage_size);
2112 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302113 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002114 }
Archanad8a83dc2021-06-14 10:04:16 +05302115 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002116 status = psa_allocate_buffer_to_slot(slot, storage_size);
2117 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002118 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002120 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002121
2122 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 status = psa_driver_wrapper_import_key(attributes,
2124 data, data_length,
2125 slot->key.data,
2126 slot->key.bytes,
2127 &slot->key.bytes, &bits);
2128 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002129 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002130 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002131
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002133 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002135 status = PSA_ERROR_INVALID_ARGUMENT;
2136 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002137 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002138
Archana6ed4bda2021-08-04 10:47:15 +05302139 /* Enforce a size limit, and in particular ensure that the bit
2140 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002141 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302142 status = PSA_ERROR_NOT_SUPPORTED;
2143 goto exit;
2144 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002145 status = psa_validate_optional_attributes(slot, attributes);
2146 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002147 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002148 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002149
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002151exit:
Ryan Everettf028fe12024-01-08 17:14:44 +00002152 LOCAL_INPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 if (status != PSA_SUCCESS) {
2154 psa_fail_key_creation(slot, driver);
2155 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002156
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002158}
2159
Gilles Peskined7729582019-08-05 15:55:54 +02002160#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2161psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002163{
2164 psa_status_t status;
2165 psa_key_slot_t *slot = NULL;
2166 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002167 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002168
2169 /* Leaving attributes unspecified is not currently supported.
2170 * It could make sense to query the key type and size from the
2171 * secure element, but not all secure elements support this
2172 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002173 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2174 return PSA_ERROR_NOT_SUPPORTED;
2175 }
2176 if (psa_get_key_bits(attributes) == 0) {
2177 return PSA_ERROR_NOT_SUPPORTED;
2178 }
Gilles Peskined7729582019-08-05 15:55:54 +02002179
Gilles Peskine449bd832023-01-11 14:50:10 +01002180 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2181 &slot, &driver);
2182 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002183 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 }
Gilles Peskined7729582019-08-05 15:55:54 +02002185
Gilles Peskine449bd832023-01-11 14:50:10 +01002186 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002187
2188exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 if (status != PSA_SUCCESS) {
2190 psa_fail_key_creation(slot, driver);
2191 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002192
Gilles Peskined7729582019-08-05 15:55:54 +02002193 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002194 psa_close_key(key);
2195 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002196}
2197#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2198
Gilles Peskine449bd832023-01-11 14:50:10 +01002199psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2200 const psa_key_attributes_t *specified_attributes,
2201 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002202{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002203 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002204 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002205 psa_key_slot_t *source_slot = NULL;
2206 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002207 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002208 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302209 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002210
Ronald Cron81709fc2020-11-14 12:10:32 +01002211 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2212
Archana8a180362021-07-05 02:18:48 +05302213 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2215 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002216 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002218
Gilles Peskine449bd832023-01-11 14:50:10 +01002219 status = psa_validate_optional_attributes(source_slot,
2220 specified_attributes);
2221 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002222 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002223 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002224
Archana9d17bf42021-09-10 06:22:44 +05302225 /* The target key type and number of bits have been validated by
2226 * psa_validate_optional_attributes() to be either equal to zero or
2227 * equal to the ones of the source key. So it is safe to inherit
2228 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302229 * */
Archana9d17bf42021-09-10 06:22:44 +05302230 actual_attributes.core.bits = source_slot->attr.bits;
2231 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302232
2233
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 status = psa_restrict_key_policy(source_slot->attr.type,
2235 &actual_attributes.core.policy,
2236 &source_slot->attr.policy);
2237 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002238 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002240
Gilles Peskine449bd832023-01-11 14:50:10 +01002241 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2242 &target_slot, &driver);
2243 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002244 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002245 }
2246 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2247 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302248 /*
Archana9d17bf42021-09-10 06:22:44 +05302249 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302250 * the source key would need to be exported as plaintext and re-imported
2251 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302252 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302253 * appropriate API invocations from the application, if needed.
2254 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002255 status = PSA_ERROR_NOT_SUPPORTED;
2256 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002257 }
Archana8a180362021-07-05 02:18:48 +05302258 /*
2259 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302260 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302261 * - For opaque keys this translates to an invocation of the drivers'
2262 * copy_key entry point through the dispatch layer.
2263 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002264 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2265 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2266 &storage_size);
2267 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302268 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 }
Archana374fe5b2021-09-08 15:50:28 +05302270
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2272 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302273 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002274 }
Archana374fe5b2021-09-08 15:50:28 +05302275
Gilles Peskine449bd832023-01-11 14:50:10 +01002276 status = psa_driver_wrapper_copy_key(&actual_attributes,
2277 source_slot->key.data,
2278 source_slot->key.bytes,
2279 target_slot->key.data,
2280 target_slot->key.bytes,
2281 &target_slot->key.bytes);
2282 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302283 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 }
2285 } else {
2286 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302287 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002288 source_slot->key.bytes);
2289 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302290 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 }
Archana8a180362021-07-05 02:18:48 +05302292 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002293 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002294exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002295 if (status != PSA_SUCCESS) {
2296 psa_fail_key_creation(target_slot, driver);
2297 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002298
Ryan Everett1b70a072024-01-04 10:32:49 +00002299 unlock_status = psa_unregister_read(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002300
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002302}
2303
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002304
2305
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002306/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002307/* Message digests */
2308/****************************************************************/
2309
Gilles Peskine449bd832023-01-11 14:50:10 +01002310psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002311{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002312 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 if (operation->id == 0) {
2314 return PSA_SUCCESS;
2315 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002316
Gilles Peskine449bd832023-01-11 14:50:10 +01002317 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002318 operation->id = 0;
2319
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002321}
2322
Gilles Peskine449bd832023-01-11 14:50:10 +01002323psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2324 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002325{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002326 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002327
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002328 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002329 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002330 status = PSA_ERROR_BAD_STATE;
2331 goto exit;
2332 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002333
Gilles Peskine449bd832023-01-11 14:50:10 +01002334 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002335 status = PSA_ERROR_INVALID_ARGUMENT;
2336 goto exit;
2337 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002338
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002339 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2340 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002341 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002342
Gilles Peskine449bd832023-01-11 14:50:10 +01002343 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002344
2345exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 if (status != PSA_SUCCESS) {
2347 psa_hash_abort(operation);
2348 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002349
2350 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002351}
2352
Gilles Peskine449bd832023-01-11 14:50:10 +01002353psa_status_t psa_hash_update(psa_hash_operation_t *operation,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002354 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002355 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002356{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002357 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002358 LOCAL_INPUT_DECLARE(input_external, input);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002359
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002361 status = PSA_ERROR_BAD_STATE;
2362 goto exit;
2363 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002364
Steven Cooremanc8288352021-03-04 14:02:19 +01002365 /* Don't require hash implementations to behave correctly on a
2366 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002367 if (input_length == 0) {
2368 return PSA_SUCCESS;
2369 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002370
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002371 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002372 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002373
2374exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 if (status != PSA_SUCCESS) {
2376 psa_hash_abort(operation);
2377 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002378
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002379 LOCAL_INPUT_FREE(input_external, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002381}
2382
Thomas Daubney31d8c0b2024-01-18 15:26:59 +00002383static psa_status_t psa_hash_finish_internal(psa_hash_operation_t *operation,
Thomas Daubneyd2411562024-01-25 17:25:07 +00002384 uint8_t *hash,
2385 size_t hash_size,
2386 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002387{
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002388 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2389
Steven Cooremanfbe09282021-03-08 18:41:12 +01002390 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002391 if (operation->id == 0) {
2392 return PSA_ERROR_BAD_STATE;
2393 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002394
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002395 status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 operation, hash, hash_size, hash_length);
2397 psa_hash_abort(operation);
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002398
2399 return status;
2400}
2401
2402psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2403 uint8_t *hash_external,
2404 size_t hash_size,
2405 size_t *hash_length)
2406{
2407 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2408 LOCAL_OUTPUT_DECLARE(hash_external, hash);
2409
2410 LOCAL_OUTPUT_ALLOC(hash_external, hash_size, hash);
2411 status = psa_hash_finish_internal(operation, hash, hash_size, hash_length);
2412
Thomas Daubneydedd1002024-01-25 16:52:50 +00002413#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002414exit:
Thomas Daubneydedd1002024-01-25 16:52:50 +00002415#endif
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002416 LOCAL_OUTPUT_FREE(hash_external, hash);
Gilles Peskine449bd832023-01-11 14:50:10 +01002417 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002418}
2419
Gilles Peskine449bd832023-01-11 14:50:10 +01002420psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002421 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002423{
Ronald Cron69a63422021-10-18 09:47:58 +02002424 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002425 size_t actual_hash_length;
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002426 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2427 LOCAL_INPUT_DECLARE(hash_external, hash);
2428
2429 status = psa_hash_finish_internal(
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 operation,
2431 actual_hash, sizeof(actual_hash),
2432 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002433
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002435 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002437
Gilles Peskine449bd832023-01-11 14:50:10 +01002438 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002439 status = PSA_ERROR_INVALID_SIGNATURE;
2440 goto exit;
2441 }
2442
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002443 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
Dave Rodgman78701152023-08-29 14:20:18 +01002444 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002445 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002446 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002447
2448exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002449 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2450 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002451 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 }
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002453 LOCAL_INPUT_FREE(hash_external, hash);
Gilles Peskine449bd832023-01-11 14:50:10 +01002454 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002455}
2456
Gilles Peskine449bd832023-01-11 14:50:10 +01002457psa_status_t psa_hash_compute(psa_algorithm_t alg,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002458 const uint8_t *input_external, size_t input_length,
2459 uint8_t *hash_external, size_t hash_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002460 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002461{
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002462 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2463 LOCAL_INPUT_DECLARE(input_external, input);
2464 LOCAL_OUTPUT_DECLARE(hash_external, hash);
2465
Steven Cooremanfbe09282021-03-08 18:41:12 +01002466 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002467 if (!PSA_ALG_IS_HASH(alg)) {
2468 return PSA_ERROR_INVALID_ARGUMENT;
2469 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002470
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002471 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2472 LOCAL_OUTPUT_ALLOC(hash_external, hash_size, hash);
2473 status = psa_driver_wrapper_hash_compute(alg, input, input_length,
Thomas Daubneyd2411562024-01-25 17:25:07 +00002474 hash, hash_size, hash_length);
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002475
Thomas Daubneydedd1002024-01-25 16:52:50 +00002476#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002477exit:
Thomas Daubneydedd1002024-01-25 16:52:50 +00002478#endif
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002479 LOCAL_INPUT_FREE(input_external, input);
2480 LOCAL_OUTPUT_FREE(hash_external, hash);
2481 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002482}
2483
Gilles Peskine449bd832023-01-11 14:50:10 +01002484psa_status_t psa_hash_compare(psa_algorithm_t alg,
Thomas Daubney51ffac92024-01-18 15:46:26 +00002485 const uint8_t *input_external, size_t input_length,
2486 const uint8_t *hash_external, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002487{
Ronald Cron69a63422021-10-18 09:47:58 +02002488 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002489 size_t actual_hash_length;
Thomas Daubney51ffac92024-01-18 15:46:26 +00002490 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2491
2492 LOCAL_INPUT_DECLARE(input_external, input);
2493 LOCAL_INPUT_DECLARE(hash_external, hash);
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002494
Gilles Peskine449bd832023-01-11 14:50:10 +01002495 if (!PSA_ALG_IS_HASH(alg)) {
Thomas Daubney51ffac92024-01-18 15:46:26 +00002496 status = PSA_ERROR_INVALID_ARGUMENT;
2497 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002498 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002499
Thomas Daubney51ffac92024-01-18 15:46:26 +00002500 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2501 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002502 alg, input, input_length,
2503 actual_hash, sizeof(actual_hash),
2504 &actual_hash_length);
2505 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002506 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002507 }
2508 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002509 status = PSA_ERROR_INVALID_SIGNATURE;
2510 goto exit;
2511 }
Thomas Daubney51ffac92024-01-18 15:46:26 +00002512
2513 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
Dave Rodgman78701152023-08-29 14:20:18 +01002514 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002515 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002517
2518exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002519 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
Thomas Daubney51ffac92024-01-18 15:46:26 +00002520
2521 LOCAL_INPUT_FREE(input_external, input);
2522 LOCAL_INPUT_FREE(hash_external, hash);
2523
Gilles Peskine449bd832023-01-11 14:50:10 +01002524 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002525}
2526
Gilles Peskine449bd832023-01-11 14:50:10 +01002527psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2528 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002529{
Gilles Peskine449bd832023-01-11 14:50:10 +01002530 if (source_operation->id == 0 ||
2531 target_operation->id != 0) {
2532 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002533 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002534
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2536 target_operation);
2537 if (status != PSA_SUCCESS) {
2538 psa_hash_abort(target_operation);
2539 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002540
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002542}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002543
2544
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002545/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002546/* MAC */
2547/****************************************************************/
2548
Gilles Peskine449bd832023-01-11 14:50:10 +01002549psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002550{
Steven Cooremane6804192021-03-19 18:28:56 +01002551 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 if (operation->id == 0) {
2553 return PSA_SUCCESS;
2554 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002555
Gilles Peskine449bd832023-01-11 14:50:10 +01002556 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002557 operation->mac_size = 0;
2558 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002559 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002560
Gilles Peskine449bd832023-01-11 14:50:10 +01002561 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002562}
2563
Ronald Cron2dff3b22021-06-17 16:33:22 +02002564static psa_status_t psa_mac_finalize_alg_and_key_validation(
2565 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002566 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002568{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002569 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 psa_key_type_t key_type = psa_get_key_type(attributes);
2571 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002572
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 if (!PSA_ALG_IS_MAC(alg)) {
2574 return PSA_ERROR_INVALID_ARGUMENT;
2575 }
Steven Cooremane6804192021-03-19 18:28:56 +01002576
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002577 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 status = psa_mac_key_can_do(alg, key_type);
2579 if (status != PSA_SUCCESS) {
2580 return status;
2581 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002582
Steven Cooremand1a68f12021-05-10 11:13:41 +02002583 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002585
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002587 /* A very short MAC is too short for security since it can be
2588 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2589 * so we make this our minimum, even though 32 bits is still
2590 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002591 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002592 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002593
Gilles Peskine449bd832023-01-11 14:50:10 +01002594 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2595 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002596 /* It's impossible to "truncate" to a larger length than the full length
2597 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002598 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002599 }
2600
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002602 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2603 * that is disabled in the compile-time configuration. The result can
2604 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2605 * configuration into account. In this case, force a return of
2606 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2607 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2608 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2609 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2610 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002611 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002612 }
2613
Gilles Peskine449bd832023-01-11 14:50:10 +01002614 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002615}
2616
Gilles Peskine449bd832023-01-11 14:50:10 +01002617static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2618 mbedtls_svc_key_id_t key,
2619 psa_algorithm_t alg,
2620 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002621{
2622 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2623 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002624 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002625 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002626
2627 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002628 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002629 status = PSA_ERROR_BAD_STATE;
2630 goto exit;
2631 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002632
2633 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002634 key,
2635 &slot,
2636 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2637 alg);
2638 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002639 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002640 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002641
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002642 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002643 .core = slot->attr
2644 };
2645
Gilles Peskine449bd832023-01-11 14:50:10 +01002646 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2647 &operation->mac_size);
2648 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002649 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002650 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002651
2652 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002653 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002654 if (is_sign) {
2655 status = psa_driver_wrapper_mac_sign_setup(operation,
2656 &attributes,
2657 slot->key.data,
2658 slot->key.bytes,
2659 alg);
2660 } else {
2661 status = psa_driver_wrapper_mac_verify_setup(operation,
2662 &attributes,
2663 slot->key.data,
2664 slot->key.bytes,
2665 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002666 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002667
Gilles Peskinefbfac682018-07-08 20:51:54 +02002668exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002669 if (status != PSA_SUCCESS) {
2670 psa_mac_abort(operation);
2671 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002672
Ryan Everett1b70a072024-01-04 10:32:49 +00002673 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002674
Gilles Peskine449bd832023-01-11 14:50:10 +01002675 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002676}
2677
Gilles Peskine449bd832023-01-11 14:50:10 +01002678psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2679 mbedtls_svc_key_id_t key,
2680 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002681{
Gilles Peskine449bd832023-01-11 14:50:10 +01002682 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002683}
2684
Gilles Peskine449bd832023-01-11 14:50:10 +01002685psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2686 mbedtls_svc_key_id_t key,
2687 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002688{
Gilles Peskine449bd832023-01-11 14:50:10 +01002689 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002690}
2691
Gilles Peskine449bd832023-01-11 14:50:10 +01002692psa_status_t psa_mac_update(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002693 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002694 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002695{
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002696 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2697 LOCAL_INPUT_DECLARE(input_external, input);
2698
Gilles Peskine449bd832023-01-11 14:50:10 +01002699 if (operation->id == 0) {
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002700 status = PSA_ERROR_BAD_STATE;
2701 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002702 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002703
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002704 /* Don't require hash implementations to behave correctly on a
2705 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002706 if (input_length == 0) {
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002707 status = PSA_SUCCESS;
2708 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002709 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002710
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002711 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2712 status = psa_driver_wrapper_mac_update(operation, input, input_length);
2713
Gilles Peskine449bd832023-01-11 14:50:10 +01002714 if (status != PSA_SUCCESS) {
2715 psa_mac_abort(operation);
2716 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002717
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002718#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002719exit:
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002720#endif
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002721 LOCAL_INPUT_FREE(input_external, input);
2722
Gilles Peskine449bd832023-01-11 14:50:10 +01002723 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002724}
2725
Gilles Peskine449bd832023-01-11 14:50:10 +01002726psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002727 uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002728 size_t mac_size,
2729 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002730{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002731 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2732 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002733 LOCAL_OUTPUT_DECLARE(mac_external, mac);
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002734 LOCAL_OUTPUT_ALLOC(mac_external, mac_size, mac);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002735
Gilles Peskine449bd832023-01-11 14:50:10 +01002736 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002737 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002738 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002739 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002740
Gilles Peskine449bd832023-01-11 14:50:10 +01002741 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002742 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002743 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002744 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002745
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002746 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2747 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002748 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002749 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002750 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002751 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002752
Gilles Peskine449bd832023-01-11 14:50:10 +01002753 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002754 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002755 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002756 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002757
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002758
Gilles Peskine449bd832023-01-11 14:50:10 +01002759 status = psa_driver_wrapper_mac_sign_finish(operation,
2760 mac, operation->mac_size,
2761 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002762
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002763exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002764 /* In case of success, set the potential excess room in the output buffer
2765 * to an invalid value, to avoid potentially leaking a longer MAC.
2766 * In case of error, set the output length and content to a safe default,
2767 * such that in case the caller misses an error check, the output would be
2768 * an unachievable MAC.
2769 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002771 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002772 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002773 }
mohammad16036df908f2018-04-02 08:34:15 -07002774
Thomas Daubney03f1ea32024-02-01 16:16:27 +00002775 if (mac != NULL) {
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002776 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
2777 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002778
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 abort_status = psa_mac_abort(operation);
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002780 LOCAL_OUTPUT_FREE(mac_external, mac);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002781
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002783}
2784
Gilles Peskine449bd832023-01-11 14:50:10 +01002785psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002786 const uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002787 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002788{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002789 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2790 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002791 LOCAL_INPUT_DECLARE(mac_external, mac);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002792
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002794 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002795 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002796 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002797
Gilles Peskine449bd832023-01-11 14:50:10 +01002798 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002799 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002800 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002801 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002802
Gilles Peskine449bd832023-01-11 14:50:10 +01002803 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002804 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002805 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002806 }
2807
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002808 LOCAL_INPUT_ALLOC(mac_external, mac_length, mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 status = psa_driver_wrapper_mac_verify_finish(operation,
2810 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002811
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002812exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 abort_status = psa_mac_abort(operation);
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002814 LOCAL_INPUT_FREE(mac_external, mac);
mohammad16036df908f2018-04-02 08:34:15 -07002815
Gilles Peskine449bd832023-01-11 14:50:10 +01002816 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002817}
2818
Gilles Peskine449bd832023-01-11 14:50:10 +01002819static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2820 psa_algorithm_t alg,
2821 const uint8_t *input,
2822 size_t input_length,
2823 uint8_t *mac,
2824 size_t mac_size,
2825 size_t *mac_length,
2826 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002827{
2828 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002829 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2830 psa_key_slot_t *slot;
2831 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002832 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002833
Ronald Cron51131b52021-06-17 17:17:20 +02002834 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002835 key,
2836 &slot,
2837 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2838 alg);
2839 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002840 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002841 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002842
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002843 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002844 .core = slot->attr
2845 };
2846
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2848 &operation_mac_size);
2849 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002850 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002852
Gilles Peskine449bd832023-01-11 14:50:10 +01002853 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002854 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002855 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002856 }
2857
2858 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002859 &attributes,
2860 slot->key.data, slot->key.bytes,
2861 alg,
2862 input, input_length,
2863 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002864
2865exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002866 /* In case of success, set the potential excess room in the output buffer
2867 * to an invalid value, to avoid potentially leaking a longer MAC.
2868 * In case of error, set the output length and content to a safe default,
2869 * such that in case the caller misses an error check, the output would be
2870 * an unachievable MAC.
2871 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002873 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002874 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002875 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002876
2877 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002878
Ryan Everett1b70a072024-01-04 10:32:49 +00002879 unlock_status = psa_unregister_read(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002880
Gilles Peskine449bd832023-01-11 14:50:10 +01002881 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002882}
2883
Gilles Peskine449bd832023-01-11 14:50:10 +01002884psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002885 psa_algorithm_t alg,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002886 const uint8_t *input_external,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002887 size_t input_length,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002888 uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002889 size_t mac_size,
2890 size_t *mac_length)
2891{
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002892 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2893 LOCAL_INPUT_DECLARE(input_external, input);
2894 LOCAL_OUTPUT_DECLARE(mac_external, mac);
2895
2896 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2897 LOCAL_OUTPUT_ALLOC(mac_external, mac_size, mac);
2898 status = psa_mac_compute_internal(key, alg,
Thomas Daubney7480a742024-01-30 11:29:47 +00002899 input, input_length,
2900 mac, mac_size, mac_length, 1);
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002901
2902#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002903exit:
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002904#endif
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002905 LOCAL_INPUT_FREE(input_external, input);
2906 LOCAL_OUTPUT_FREE(mac_external, mac);
2907
2908 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002909}
2910
2911psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2912 psa_algorithm_t alg,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002913 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002914 size_t input_length,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002915 const uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002916 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002917{
2918 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002919 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2920 size_t actual_mac_length;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002921 LOCAL_INPUT_DECLARE(input_external, input);
2922 LOCAL_INPUT_DECLARE(mac_external, mac);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002923
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002924 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002925 status = psa_mac_compute_internal(key, alg,
2926 input, input_length,
2927 actual_mac, sizeof(actual_mac),
2928 &actual_mac_length, 0);
2929 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002930 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002932
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002934 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002935 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002936 }
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002937
2938 LOCAL_INPUT_ALLOC(mac_external, mac_length, mac);
Dave Rodgman78701152023-08-29 14:20:18 +01002939 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002940 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002941 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002942 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002943
2944exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002945 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002946 LOCAL_INPUT_FREE(input_external, input);
2947 LOCAL_INPUT_FREE(mac_external, mac);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002948
Gilles Peskine449bd832023-01-11 14:50:10 +01002949 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002950}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002951
Gilles Peskinee59236f2018-01-27 23:32:46 +01002952/****************************************************************/
2953/* Asymmetric cryptography */
2954/****************************************************************/
2955
Gilles Peskine449bd832023-01-11 14:50:10 +01002956static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2957 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002958{
Gilles Peskine449bd832023-01-11 14:50:10 +01002959 if (input_is_message) {
2960 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2961 return PSA_ERROR_INVALID_ARGUMENT;
2962 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002963
Gilles Peskine449bd832023-01-11 14:50:10 +01002964 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2965 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2966 return PSA_ERROR_INVALID_ARGUMENT;
2967 }
2968 }
2969 } else {
2970 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2971 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002972 }
2973 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002974
Gilles Peskine449bd832023-01-11 14:50:10 +01002975 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002976}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002977
Gilles Peskine449bd832023-01-11 14:50:10 +01002978static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2979 int input_is_message,
2980 psa_algorithm_t alg,
2981 const uint8_t *input,
2982 size_t input_length,
2983 uint8_t *signature,
2984 size_t signature_size,
2985 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002986{
2987 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2988 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2989 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002990 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002991
2992 *signature_length = 0;
2993
Gilles Peskine449bd832023-01-11 14:50:10 +01002994 status = psa_sign_verify_check_alg(input_is_message, alg);
2995 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002996 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002998
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002999 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02003000 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003001 * buffer can in principle be empty since it doesn't actually have
3002 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003003 if (signature_size == 0) {
3004 return PSA_ERROR_BUFFER_TOO_SMALL;
3005 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003006
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003007 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003008 key, &slot,
3009 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
3010 PSA_KEY_USAGE_SIGN_HASH,
3011 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003012
Gilles Peskine449bd832023-01-11 14:50:10 +01003013 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003014 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003015 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003016
Gilles Peskine449bd832023-01-11 14:50:10 +01003017 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003018 status = PSA_ERROR_INVALID_ARGUMENT;
3019 goto exit;
3020 }
3021
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003022 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003024 };
3025
Gilles Peskine449bd832023-01-11 14:50:10 +01003026 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003027 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003028 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003029 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003030 signature, signature_size, signature_length);
3031 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003032
3033 status = psa_driver_wrapper_sign_hash(
3034 &attributes, slot->key.data, slot->key.bytes,
3035 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003036 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003037 }
3038
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003039
3040exit:
Paul Elliott59200a22023-02-21 15:07:40 +00003041 psa_wipe_tag_output_buffer(signature, status, signature_size,
3042 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003043
Ryan Everett1b70a072024-01-04 10:32:49 +00003044 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003045
Gilles Peskine449bd832023-01-11 14:50:10 +01003046 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003047}
3048
Gilles Peskine449bd832023-01-11 14:50:10 +01003049static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
3050 int input_is_message,
3051 psa_algorithm_t alg,
3052 const uint8_t *input,
3053 size_t input_length,
3054 const uint8_t *signature,
3055 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003056{
3057 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3058 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3059 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003060
Gilles Peskine449bd832023-01-11 14:50:10 +01003061 status = psa_sign_verify_check_alg(input_is_message, alg);
3062 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003063 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003065
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003066 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003067 key, &slot,
3068 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
3069 PSA_KEY_USAGE_VERIFY_HASH,
3070 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003071
Gilles Peskine449bd832023-01-11 14:50:10 +01003072 if (status != PSA_SUCCESS) {
3073 return status;
3074 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003075
3076 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01003077 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003078 };
3079
Gilles Peskine449bd832023-01-11 14:50:10 +01003080 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003081 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003082 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003083 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003084 signature, signature_length);
3085 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003086 status = psa_driver_wrapper_verify_hash(
3087 &attributes, slot->key.data, slot->key.bytes,
3088 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003089 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003090 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003091
Ryan Everett1b70a072024-01-04 10:32:49 +00003092 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003093
Gilles Peskine449bd832023-01-11 14:50:10 +01003094 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003095
3096}
3097
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003098psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003099 const psa_key_attributes_t *attributes,
3100 const uint8_t *key_buffer,
3101 size_t key_buffer_size,
3102 psa_algorithm_t alg,
3103 const uint8_t *input,
3104 size_t input_length,
3105 uint8_t *signature,
3106 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01003107 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003108{
3109 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003110
Gilles Peskine449bd832023-01-11 14:50:10 +01003111 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003112 size_t hash_length;
3113 uint8_t hash[PSA_HASH_MAX_SIZE];
3114
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003115 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003116 PSA_ALG_SIGN_GET_HASH(alg),
3117 input, input_length,
3118 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003119
Gilles Peskine449bd832023-01-11 14:50:10 +01003120 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003121 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003122 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003123
3124 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003125 attributes, key_buffer, key_buffer_size,
3126 alg, hash, hash_length,
3127 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003128 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003129
Gilles Peskine449bd832023-01-11 14:50:10 +01003130 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003131}
3132
Gilles Peskine449bd832023-01-11 14:50:10 +01003133psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3134 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003135 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003136 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003137 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003138 size_t signature_size,
3139 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003140{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003141 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3142 LOCAL_INPUT_DECLARE(input_external, input);
3143 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3144
3145 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3146 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3147 status = psa_sign_internal(key, 1, alg, input, input_length, signature,
3148 signature_size, signature_length);
3149
Thomas Daubney3e65f522024-01-30 12:37:25 +00003150#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003151exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003152#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003153 LOCAL_INPUT_FREE(input_external, input);
3154 LOCAL_OUTPUT_FREE(signature_external, signature);
3155 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003156}
3157
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003158psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003159 const psa_key_attributes_t *attributes,
3160 const uint8_t *key_buffer,
3161 size_t key_buffer_size,
3162 psa_algorithm_t alg,
3163 const uint8_t *input,
3164 size_t input_length,
3165 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003166 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003167{
3168 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003169
Gilles Peskine449bd832023-01-11 14:50:10 +01003170 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003171 size_t hash_length;
3172 uint8_t hash[PSA_HASH_MAX_SIZE];
3173
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003174 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003175 PSA_ALG_SIGN_GET_HASH(alg),
3176 input, input_length,
3177 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003178
Gilles Peskine449bd832023-01-11 14:50:10 +01003179 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003180 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003181 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003182
3183 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003184 attributes, key_buffer, key_buffer_size,
3185 alg, hash, hash_length,
3186 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003187 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003188
Gilles Peskine449bd832023-01-11 14:50:10 +01003189 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003190}
3191
Gilles Peskine449bd832023-01-11 14:50:10 +01003192psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3193 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003194 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003195 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003196 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003197 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003198{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003199 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3200 LOCAL_INPUT_DECLARE(input_external, input);
3201 LOCAL_INPUT_DECLARE(signature_external, signature);
3202
3203 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3204 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3205 status = psa_verify_internal(key, 1, alg, input, input_length, signature,
3206 signature_length);
3207
Thomas Daubney3e65f522024-01-30 12:37:25 +00003208#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003209exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003210#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003211 LOCAL_INPUT_FREE(input_external, input);
3212 LOCAL_INPUT_FREE(signature_external, signature);
3213
3214 return status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003215}
3216
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003217psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003218 const psa_key_attributes_t *attributes,
3219 const uint8_t *key_buffer, size_t key_buffer_size,
3220 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003221 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003222{
Gilles Peskine449bd832023-01-11 14:50:10 +01003223 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3224 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3225 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003226#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003227 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3228 return mbedtls_psa_rsa_sign_hash(
3229 attributes,
3230 key_buffer, key_buffer_size,
3231 alg, hash, hash_length,
3232 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003233#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3234 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003235 } else {
3236 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003237 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003238 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3239 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003240#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003241 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3242 return mbedtls_psa_ecdsa_sign_hash(
3243 attributes,
3244 key_buffer, key_buffer_size,
3245 alg, hash, hash_length,
3246 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003247#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3248 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003249 } else {
3250 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003251 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003252 }
Ronald Cron4501c982021-03-19 20:09:32 +01003253
Gilles Peskine449bd832023-01-11 14:50:10 +01003254 (void) key_buffer;
3255 (void) key_buffer_size;
3256 (void) hash;
3257 (void) hash_length;
3258 (void) signature;
3259 (void) signature_size;
3260 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003261
Gilles Peskine449bd832023-01-11 14:50:10 +01003262 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003263}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003264
Gilles Peskine449bd832023-01-11 14:50:10 +01003265psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3266 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003267 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003268 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003269 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003270 size_t signature_size,
3271 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003272{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003273 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3274 LOCAL_INPUT_DECLARE(hash_external, hash);
3275 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3276
3277 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3278 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3279 status = psa_sign_internal(key, 0, alg, hash, hash_length, signature,
3280 signature_size, signature_length);
3281
Thomas Daubney3e65f522024-01-30 12:37:25 +00003282#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003283exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003284#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003285 LOCAL_INPUT_FREE(hash_external, hash);
3286 LOCAL_OUTPUT_FREE(signature_external, signature);
3287
3288 return status;
itayzafrir5c753392018-05-08 11:18:38 +03003289}
3290
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003291psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003292 const psa_key_attributes_t *attributes,
3293 const uint8_t *key_buffer, size_t key_buffer_size,
3294 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003295 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003296{
Gilles Peskine449bd832023-01-11 14:50:10 +01003297 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3298 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3299 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003300#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003301 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3302 return mbedtls_psa_rsa_verify_hash(
3303 attributes,
3304 key_buffer, key_buffer_size,
3305 alg, hash, hash_length,
3306 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003307#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3308 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003309 } else {
3310 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003311 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003312 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3313 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003314#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003315 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3316 return mbedtls_psa_ecdsa_verify_hash(
3317 attributes,
3318 key_buffer, key_buffer_size,
3319 alg, hash, hash_length,
3320 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003321#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3322 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003323 } else {
3324 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003325 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003326 }
Ronald Cron4501c982021-03-19 20:09:32 +01003327
Gilles Peskine449bd832023-01-11 14:50:10 +01003328 (void) key_buffer;
3329 (void) key_buffer_size;
3330 (void) hash;
3331 (void) hash_length;
3332 (void) signature;
3333 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003334
Gilles Peskine449bd832023-01-11 14:50:10 +01003335 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003336}
3337
Gilles Peskine449bd832023-01-11 14:50:10 +01003338psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3339 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003340 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003341 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003342 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003343 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003344{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003345 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3346 LOCAL_INPUT_DECLARE(hash_external, hash);
3347 LOCAL_INPUT_DECLARE(signature_external, signature);
3348
3349 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3350 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3351 status = psa_verify_internal(key, 0, alg, hash, hash_length, signature,
3352 signature_length);
3353
Thomas Daubney3e65f522024-01-30 12:37:25 +00003354#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003355exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003356#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003357 LOCAL_INPUT_FREE(hash_external, hash);
3358 LOCAL_INPUT_FREE(signature_external, signature);
3359
3360 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01003361}
3362
Gilles Peskine449bd832023-01-11 14:50:10 +01003363psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3364 psa_algorithm_t alg,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003365 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003366 size_t input_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003367 const uint8_t *salt_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003368 size_t salt_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003369 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003370 size_t output_size,
3371 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003372{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003373 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003374 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003375 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003376 psa_key_attributes_t attributes;
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003377 LOCAL_INPUT_DECLARE(input_external, input);
3378 LOCAL_INPUT_DECLARE(salt_external, salt);
3379 LOCAL_OUTPUT_DECLARE(output_external, output);
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003380
Darryl Green5cc689a2018-07-24 15:34:10 +01003381 (void) input;
3382 (void) input_length;
3383 (void) salt;
3384 (void) output;
3385 (void) output_size;
3386
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003387 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003388
Gilles Peskine449bd832023-01-11 14:50:10 +01003389 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3390 return PSA_ERROR_INVALID_ARGUMENT;
3391 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003392
Valerio Setti5bb454a2024-01-15 10:43:16 +01003393 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003394 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3395 if (status != PSA_SUCCESS) {
3396 return status;
3397 }
3398 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3399 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003400 status = PSA_ERROR_INVALID_ARGUMENT;
3401 goto exit;
3402 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003403
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003404 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003405 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003406 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003407
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003408 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3409 LOCAL_INPUT_ALLOC(salt_external, salt_length, salt);
3410 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003411 status = psa_driver_wrapper_asymmetric_encrypt(
3412 &attributes, slot->key.data, slot->key.bytes,
3413 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003414 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003415exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003416 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003417
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003418 LOCAL_INPUT_FREE(input_external, input);
3419 LOCAL_INPUT_FREE(salt_external, salt);
3420 LOCAL_OUTPUT_FREE(output_external, output);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003421
Gilles Peskine449bd832023-01-11 14:50:10 +01003422 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003423}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003424
Gilles Peskine449bd832023-01-11 14:50:10 +01003425psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3426 psa_algorithm_t alg,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003427 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003428 size_t input_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003429 const uint8_t *salt_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003430 size_t salt_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003431 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003432 size_t output_size,
3433 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003434{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003435 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003436 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003437 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003438 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003439
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003440 LOCAL_INPUT_DECLARE(input_external, input);
3441 LOCAL_INPUT_DECLARE(salt_external, salt);
3442 LOCAL_OUTPUT_DECLARE(output_external, output);
3443
Darryl Green5cc689a2018-07-24 15:34:10 +01003444 (void) input;
3445 (void) input_length;
3446 (void) salt;
3447 (void) output;
3448 (void) output_size;
3449
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003450 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003451
Gilles Peskine449bd832023-01-11 14:50:10 +01003452 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3453 return PSA_ERROR_INVALID_ARGUMENT;
3454 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003455
Valerio Setti5bb454a2024-01-15 10:43:16 +01003456 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003457 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3458 if (status != PSA_SUCCESS) {
3459 return status;
3460 }
3461 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003462 status = PSA_ERROR_INVALID_ARGUMENT;
3463 goto exit;
3464 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003465
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003466 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003467 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003468 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003469
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003470 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3471 LOCAL_INPUT_ALLOC(salt_external, salt_length, salt);
3472 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003473 status = psa_driver_wrapper_asymmetric_decrypt(
3474 &attributes, slot->key.data, slot->key.bytes,
3475 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003476 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003477
3478exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003479 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003480
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003481 LOCAL_INPUT_FREE(input_external, input);
3482 LOCAL_INPUT_FREE(salt_external, salt);
3483 LOCAL_OUTPUT_FREE(output_external, output);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003484
Gilles Peskine449bd832023-01-11 14:50:10 +01003485 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003486}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003487
Paul Elliott9fe12f62022-11-30 19:16:02 +00003488/****************************************************************/
3489/* Asymmetric interruptible cryptography */
3490/****************************************************************/
3491
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003492static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3493
Paul Elliott9fe12f62022-11-30 19:16:02 +00003494void psa_interruptible_set_max_ops(uint32_t max_ops)
3495{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003496 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003497}
3498
3499uint32_t psa_interruptible_get_max_ops(void)
3500{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003501 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003502}
3503
Paul Elliott9fe12f62022-11-30 19:16:02 +00003504uint32_t psa_sign_hash_get_num_ops(
3505 const psa_sign_hash_interruptible_operation_t *operation)
3506{
Paul Elliott296ede92022-12-15 17:00:30 +00003507 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003508}
3509
3510uint32_t psa_verify_hash_get_num_ops(
3511 const psa_verify_hash_interruptible_operation_t *operation)
3512{
Paul Elliott296ede92022-12-15 17:00:30 +00003513 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003514}
3515
Paul Elliott59ad9452022-12-18 15:09:02 +00003516static psa_status_t psa_sign_hash_abort_internal(
3517 psa_sign_hash_interruptible_operation_t *operation)
3518{
3519 if (operation->id == 0) {
3520 /* The object has (apparently) been initialized but it is not (yet)
3521 * in use. It's ok to call abort on such an object, and there's
3522 * nothing to do. */
3523 return PSA_SUCCESS;
3524 }
3525
3526 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3527
3528 status = psa_driver_wrapper_sign_hash_abort(operation);
3529
3530 operation->id = 0;
3531
Paul Elliotte6145dc2023-02-07 12:51:21 +00003532 /* Do not clear either the error_occurred or num_ops elements here as they
3533 * only want to be cleared by the application calling abort, not by abort
3534 * being called at completion of an operation. */
3535
Paul Elliott59ad9452022-12-18 15:09:02 +00003536 return status;
3537}
3538
Paul Elliott9fe12f62022-11-30 19:16:02 +00003539psa_status_t psa_sign_hash_start(
3540 psa_sign_hash_interruptible_operation_t *operation,
3541 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
David Horstmann4a523a62024-03-11 13:32:16 +00003542 const uint8_t *hash_external, size_t hash_length)
Paul Elliott9fe12f62022-11-30 19:16:02 +00003543{
3544 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3545 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3546 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003547 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003548
David Horstmann4a523a62024-03-11 13:32:16 +00003549 LOCAL_INPUT_DECLARE(hash_external, hash);
3550
Paul Elliottc9774412023-02-06 15:14:07 +00003551 /* Check that start has not been previously called, or operation has not
3552 * previously errored. */
3553 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003554 return PSA_ERROR_BAD_STATE;
3555 }
3556
Paul Elliott9fe12f62022-11-30 19:16:02 +00003557 status = psa_sign_verify_check_alg(0, alg);
3558 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003559 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003560 return status;
3561 }
3562
3563 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3564 PSA_KEY_USAGE_SIGN_HASH,
3565 alg);
3566
3567 if (status != PSA_SUCCESS) {
3568 goto exit;
3569 }
3570
3571 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3572 status = PSA_ERROR_INVALID_ARGUMENT;
3573 goto exit;
3574 }
3575
David Horstmann4a523a62024-03-11 13:32:16 +00003576 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3577
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003578 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003579 .core = slot->attr
3580 };
3581
Paul Elliott296ede92022-12-15 17:00:30 +00003582 /* Ensure ops count gets reset, in case of operation re-use. */
3583 operation->num_ops = 0;
3584
Paul Elliott9fe12f62022-11-30 19:16:02 +00003585 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3586 slot->key.data,
3587 slot->key.bytes, alg,
3588 hash, hash_length);
3589exit:
3590
3591 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003592 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003593 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003594 }
3595
Ryan Everett1b70a072024-01-04 10:32:49 +00003596 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003597
Paul Elliottc9774412023-02-06 15:14:07 +00003598 if (unlock_status != PSA_SUCCESS) {
3599 operation->error_occurred = 1;
3600 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003601
David Horstmann4a523a62024-03-11 13:32:16 +00003602 LOCAL_INPUT_FREE(hash_external, hash);
3603
Paul Elliottc9774412023-02-06 15:14:07 +00003604 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003605}
3606
3607
3608psa_status_t psa_sign_hash_complete(
3609 psa_sign_hash_interruptible_operation_t *operation,
David Horstmann4a523a62024-03-11 13:32:16 +00003610 uint8_t *signature_external, size_t signature_size,
Paul Elliott9fe12f62022-11-30 19:16:02 +00003611 size_t *signature_length)
3612{
3613 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3614
David Horstmann4a523a62024-03-11 13:32:16 +00003615 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3616
Paul Elliott9fe12f62022-11-30 19:16:02 +00003617 *signature_length = 0;
3618
Paul Elliottc9774412023-02-06 15:14:07 +00003619 /* Check that start has been called first, and that operation has not
3620 * previously errored. */
3621 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003622 status = PSA_ERROR_BAD_STATE;
3623 goto exit;
3624 }
3625
Paul Elliott096abc42023-02-03 18:33:23 +00003626 /* Immediately reject a zero-length signature buffer. This guarantees that
3627 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003628 if (signature_size == 0) {
3629 status = PSA_ERROR_BUFFER_TOO_SMALL;
3630 goto exit;
3631 }
3632
David Horstmann4a523a62024-03-11 13:32:16 +00003633 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3634
Paul Elliott9fe12f62022-11-30 19:16:02 +00003635 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3636 signature_size,
3637 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003638
Paul Elliott296ede92022-12-15 17:00:30 +00003639 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003640 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003641
Paul Elliottebe225c2023-02-10 14:32:53 +00003642exit:
3643
David Horstmannc5064c82024-03-11 17:02:03 +00003644 if (signature != NULL) {
3645 psa_wipe_tag_output_buffer(signature, status, signature_size,
3646 *signature_length);
3647 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003648
Paul Elliott53bb3122023-02-10 14:22:22 +00003649 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003650 if (status != PSA_SUCCESS) {
3651 operation->error_occurred = 1;
3652 }
3653
Paul Elliott59ad9452022-12-18 15:09:02 +00003654 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003655 }
3656
David Horstmann4a523a62024-03-11 13:32:16 +00003657 LOCAL_OUTPUT_FREE(signature_external, signature);
3658
Paul Elliott9fe12f62022-11-30 19:16:02 +00003659 return status;
3660}
3661
3662psa_status_t psa_sign_hash_abort(
3663 psa_sign_hash_interruptible_operation_t *operation)
3664{
Paul Elliott59ad9452022-12-18 15:09:02 +00003665 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3666
3667 status = psa_sign_hash_abort_internal(operation);
3668
3669 /* We clear the number of ops done here, so that it is not cleared when
3670 * the operation fails or succeeds, only on manual abort. */
3671 operation->num_ops = 0;
3672
Paul Elliottc9774412023-02-06 15:14:07 +00003673 /* Likewise, failure state. */
3674 operation->error_occurred = 0;
3675
Paul Elliott59ad9452022-12-18 15:09:02 +00003676 return status;
3677}
3678
3679static psa_status_t psa_verify_hash_abort_internal(
3680 psa_verify_hash_interruptible_operation_t *operation)
3681{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003682 if (operation->id == 0) {
3683 /* The object has (apparently) been initialized but it is not (yet)
3684 * in use. It's ok to call abort on such an object, and there's
3685 * nothing to do. */
3686 return PSA_SUCCESS;
3687 }
3688
Paul Elliott59ad9452022-12-18 15:09:02 +00003689 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3690
3691 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003692
3693 operation->id = 0;
3694
Paul Elliotte6145dc2023-02-07 12:51:21 +00003695 /* Do not clear either the error_occurred or num_ops elements here as they
3696 * only want to be cleared by the application calling abort, not by abort
3697 * being called at completion of an operation. */
3698
Paul Elliott59ad9452022-12-18 15:09:02 +00003699 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003700}
3701
3702psa_status_t psa_verify_hash_start(
3703 psa_verify_hash_interruptible_operation_t *operation,
3704 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
David Horstmann0fea6a52024-03-11 13:41:05 +00003705 const uint8_t *hash_external, size_t hash_length,
3706 const uint8_t *signature_external, size_t signature_length)
Paul Elliott9fe12f62022-11-30 19:16:02 +00003707{
3708 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3709 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3710 psa_key_slot_t *slot;
3711
David Horstmann0fea6a52024-03-11 13:41:05 +00003712 LOCAL_INPUT_DECLARE(hash_external, hash);
3713 LOCAL_INPUT_DECLARE(signature_external, signature);
3714
Paul Elliottc9774412023-02-06 15:14:07 +00003715 /* Check that start has not been previously called, or operation has not
3716 * previously errored. */
3717 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003718 return PSA_ERROR_BAD_STATE;
3719 }
3720
3721 status = psa_sign_verify_check_alg(0, alg);
3722 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003723 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003724 return status;
3725 }
3726
3727 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3728 PSA_KEY_USAGE_VERIFY_HASH,
3729 alg);
3730
3731 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003732 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003733 return status;
3734 }
3735
David Horstmann0fea6a52024-03-11 13:41:05 +00003736 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3737 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3738
Paul Elliott9fe12f62022-11-30 19:16:02 +00003739 psa_key_attributes_t attributes = {
3740 .core = slot->attr
3741 };
3742
Paul Elliott296ede92022-12-15 17:00:30 +00003743 /* Ensure ops count gets reset, in case of operation re-use. */
3744 operation->num_ops = 0;
3745
Paul Elliott9fe12f62022-11-30 19:16:02 +00003746 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3747 slot->key.data,
3748 slot->key.bytes,
3749 alg, hash, hash_length,
3750 signature, signature_length);
David Horstmann0fea6a52024-03-11 13:41:05 +00003751#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
3752exit:
3753#endif
Paul Elliott9fe12f62022-11-30 19:16:02 +00003754
3755 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003756 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003757 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003758 }
3759
Ryan Everett1b70a072024-01-04 10:32:49 +00003760 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003761
Paul Elliottc9774412023-02-06 15:14:07 +00003762 if (unlock_status != PSA_SUCCESS) {
3763 operation->error_occurred = 1;
3764 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003765
David Horstmann0fea6a52024-03-11 13:41:05 +00003766 LOCAL_INPUT_FREE(hash_external, hash);
3767 LOCAL_INPUT_FREE(signature_external, signature);
3768
Paul Elliottc9774412023-02-06 15:14:07 +00003769 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003770}
3771
3772psa_status_t psa_verify_hash_complete(
3773 psa_verify_hash_interruptible_operation_t *operation)
3774{
3775 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3776
Paul Elliottc9774412023-02-06 15:14:07 +00003777 /* Check that start has been called first, and that operation has not
3778 * previously errored. */
3779 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003780 status = PSA_ERROR_BAD_STATE;
3781 goto exit;
3782 }
3783
3784 status = psa_driver_wrapper_verify_hash_complete(operation);
3785
Paul Elliott296ede92022-12-15 17:00:30 +00003786 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003787 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003788 operation);
3789
Paul Elliottebe225c2023-02-10 14:32:53 +00003790exit:
3791
Paul Elliott9fe12f62022-11-30 19:16:02 +00003792 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003793 if (status != PSA_SUCCESS) {
3794 operation->error_occurred = 1;
3795 }
3796
Paul Elliott59ad9452022-12-18 15:09:02 +00003797 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003798 }
3799
3800 return status;
3801}
3802
3803psa_status_t psa_verify_hash_abort(
3804 psa_verify_hash_interruptible_operation_t *operation)
3805{
Paul Elliott59ad9452022-12-18 15:09:02 +00003806 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003807
Paul Elliott59ad9452022-12-18 15:09:02 +00003808 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003809
Paul Elliott59ad9452022-12-18 15:09:02 +00003810 /* We clear the number of ops done here, so that it is not cleared when
3811 * the operation fails or succeeds, only on manual abort. */
3812 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003813
Paul Elliottc9774412023-02-06 15:14:07 +00003814 /* Likewise, failure state. */
3815 operation->error_occurred = 0;
3816
Paul Elliott59ad9452022-12-18 15:09:02 +00003817 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003818}
3819
Paul Elliott588f8ed2022-12-02 18:10:26 +00003820/****************************************************************/
3821/* Asymmetric interruptible cryptography internal */
3822/* implementations */
3823/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003824
Paul Elliott588f8ed2022-12-02 18:10:26 +00003825void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3826{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003827
Paul Elliott588f8ed2022-12-02 18:10:26 +00003828#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3829 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3830 defined(MBEDTLS_ECP_RESTARTABLE)
3831
3832 /* Internal implementation uses zero to indicate infinite number max ops,
3833 * therefore avoid this value, and set to minimum possible. */
3834 if (max_ops == 0) {
3835 max_ops = 1;
3836 }
3837
Paul Elliott588f8ed2022-12-02 18:10:26 +00003838 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003839#else
3840 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003841#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3842 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3843 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3844}
3845
Paul Elliott588f8ed2022-12-02 18:10:26 +00003846uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003847 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003848{
3849#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3850 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3851 defined(MBEDTLS_ECP_RESTARTABLE)
3852
Paul Elliott93d9ca82023-02-15 18:14:21 +00003853 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003854#else
3855 (void) operation;
3856 return 0;
3857#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3858 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3859 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3860}
3861
3862uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003863 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003864{
3865 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3866 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3867 defined(MBEDTLS_ECP_RESTARTABLE)
3868
Paul Elliott93d9ca82023-02-15 18:14:21 +00003869 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003870#else
3871 (void) operation;
3872 return 0;
3873#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3874 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3875 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3876}
3877
3878psa_status_t mbedtls_psa_sign_hash_start(
3879 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3880 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3881 size_t key_buffer_size, psa_algorithm_t alg,
3882 const uint8_t *hash, size_t hash_length)
3883{
3884 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003885 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003886
Paul Elliott068fe072023-01-16 13:59:15 +00003887 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3888 return PSA_ERROR_NOT_SUPPORTED;
3889 }
3890
3891 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003892 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003893 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003894
3895#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003896 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3897 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003898
Paul Elliotta1c94092023-02-15 16:38:04 +00003899 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3900
Paul Elliott93d9ca82023-02-15 18:14:21 +00003901 /* Ensure num_ops is zero'ed in case of context re-use. */
3902 operation->num_ops = 0;
3903
Paul Elliott068fe072023-01-16 13:59:15 +00003904 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3905 attributes->core.bits,
3906 key_buffer,
3907 key_buffer_size,
3908 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003909
Paul Elliott068fe072023-01-16 13:59:15 +00003910 if (status != PSA_SUCCESS) {
3911 return status;
3912 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003913
Paul Elliott1bc59df2023-02-05 13:41:57 +00003914 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003915 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003916
Paul Elliott068fe072023-01-16 13:59:15 +00003917 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003918 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003919 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003920
Paul Elliott0290a762023-02-09 14:30:24 +00003921 /* We only need to store the same length of hash as the private key size
3922 * here, it would be truncated by the internal implementation anyway. */
3923 required_hash_length = (hash_length < operation->coordinate_bytes ?
3924 hash_length : operation->coordinate_bytes);
3925
Paul Elliottba70ad42023-02-15 18:23:53 +00003926 if (required_hash_length > sizeof(operation->hash)) {
3927 /* Shouldn't happen, but better safe than sorry. */
3928 return PSA_ERROR_CORRUPTION_DETECTED;
3929 }
3930
Paul Elliott0290a762023-02-09 14:30:24 +00003931 memcpy(operation->hash, hash, required_hash_length);
3932 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003933
3934 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003935
3936#else
Paul Elliott068fe072023-01-16 13:59:15 +00003937 (void) operation;
3938 (void) key_buffer;
3939 (void) key_buffer_size;
3940 (void) alg;
3941 (void) hash;
3942 (void) hash_length;
3943 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003944 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003945
Paul Elliott068fe072023-01-16 13:59:15 +00003946 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003947#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3948 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3949 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003950}
3951
3952psa_status_t mbedtls_psa_sign_hash_complete(
3953 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3954 uint8_t *signature, size_t signature_size,
3955 size_t *signature_length)
3956{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003957#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3958 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3959 defined(MBEDTLS_ECP_RESTARTABLE)
3960
Paul Elliotta1c94092023-02-15 16:38:04 +00003961 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003962 mbedtls_mpi r;
3963 mbedtls_mpi s;
3964
Paul Elliott46845252023-02-03 14:59:11 +00003965 mbedtls_mpi_init(&r);
3966 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003967
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003968 /* Ensure max_ops is set to the current value (or default). */
3969 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3970
Paul Elliotta1c94092023-02-15 16:38:04 +00003971 if (signature_size < 2 * operation->coordinate_bytes) {
3972 status = PSA_ERROR_BUFFER_TOO_SMALL;
3973 goto exit;
3974 }
3975
Paul Elliott588f8ed2022-12-02 18:10:26 +00003976 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003977
Paul Elliott588f8ed2022-12-02 18:10:26 +00003978#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3979 status = mbedtls_to_psa_error(
3980 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003981 &r,
3982 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003983 &operation->ctx->d,
3984 operation->hash,
3985 operation->hash_length,
3986 operation->md_alg,
3987 mbedtls_psa_get_random,
3988 MBEDTLS_PSA_RANDOM_STATE,
3989 &operation->restart_ctx));
3990#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003991 status = PSA_ERROR_NOT_SUPPORTED;
3992 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003993#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3994 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003995 status = mbedtls_to_psa_error(
3996 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003997 &r,
3998 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003999 &operation->ctx->d,
4000 operation->hash,
4001 operation->hash_length,
4002 mbedtls_psa_get_random,
4003 MBEDTLS_PSA_RANDOM_STATE,
4004 mbedtls_psa_get_random,
4005 MBEDTLS_PSA_RANDOM_STATE,
4006 &operation->restart_ctx));
4007 }
4008
Paul Elliottf8e5b562023-02-19 18:43:45 +00004009 /* Hide the fact that the restart context only holds a delta of number of
4010 * ops done during the last operation, not an absolute value. */
4011 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4012
Paul Elliott724bd252023-02-08 12:35:08 +00004013 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00004014 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00004015 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004016 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004017 operation->coordinate_bytes)
4018 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00004019
4020 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00004021 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004022 }
4023
4024 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00004025 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004026 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004027 operation->coordinate_bytes,
4028 operation->coordinate_bytes)
4029 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00004030
4031 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00004032 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004033 }
4034
Paul Elliott1bc59df2023-02-05 13:41:57 +00004035 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004036
Paul Elliott724bd252023-02-08 12:35:08 +00004037 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004038 }
Paul Elliott724bd252023-02-08 12:35:08 +00004039
4040exit:
4041
4042 mbedtls_mpi_free(&r);
4043 mbedtls_mpi_free(&s);
4044 return status;
4045
Paul Elliott588f8ed2022-12-02 18:10:26 +00004046 #else
4047
4048 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004049 (void) signature;
4050 (void) signature_size;
4051 (void) signature_length;
4052
4053 return PSA_ERROR_NOT_SUPPORTED;
4054
4055#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4056 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4057 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4058}
4059
4060psa_status_t mbedtls_psa_sign_hash_abort(
4061 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
4062{
4063
4064#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4065 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4066 defined(MBEDTLS_ECP_RESTARTABLE)
4067
4068 if (operation->ctx) {
4069 mbedtls_ecdsa_free(operation->ctx);
4070 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004071 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004072 }
4073
4074 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4075
Paul Elliott93d9ca82023-02-15 18:14:21 +00004076 operation->num_ops = 0;
4077
Paul Elliott588f8ed2022-12-02 18:10:26 +00004078 return PSA_SUCCESS;
4079
4080#else
4081
4082 (void) operation;
4083
4084 return PSA_ERROR_NOT_SUPPORTED;
4085
4086#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4087 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4088 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4089}
4090
4091psa_status_t mbedtls_psa_verify_hash_start(
4092 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
4093 const psa_key_attributes_t *attributes,
4094 const uint8_t *key_buffer, size_t key_buffer_size,
4095 psa_algorithm_t alg,
4096 const uint8_t *hash, size_t hash_length,
4097 const uint8_t *signature, size_t signature_length)
4098{
4099 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00004100 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00004101 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004102
Paul Elliott068fe072023-01-16 13:59:15 +00004103 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
4104 return PSA_ERROR_NOT_SUPPORTED;
4105 }
4106
4107 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00004108 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00004109 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004110
4111#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00004112 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4113 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00004114
Paul Elliotta1c94092023-02-15 16:38:04 +00004115 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
4116 mbedtls_mpi_init(&operation->r);
4117 mbedtls_mpi_init(&operation->s);
4118
Paul Elliott93d9ca82023-02-15 18:14:21 +00004119 /* Ensure num_ops is zero'ed in case of context re-use. */
4120 operation->num_ops = 0;
4121
Paul Elliott068fe072023-01-16 13:59:15 +00004122 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
4123 attributes->core.bits,
4124 key_buffer,
4125 key_buffer_size,
4126 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004127
Paul Elliott068fe072023-01-16 13:59:15 +00004128 if (status != PSA_SUCCESS) {
4129 return status;
4130 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004131
Paul Elliottc569fc22023-02-10 13:02:54 +00004132 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004133
Paul Elliott1bc59df2023-02-05 13:41:57 +00004134 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004135 return PSA_ERROR_INVALID_SIGNATURE;
4136 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004137
Paul Elliott068fe072023-01-16 13:59:15 +00004138 status = mbedtls_to_psa_error(
4139 mbedtls_mpi_read_binary(&operation->r,
4140 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004141 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004142
Paul Elliott068fe072023-01-16 13:59:15 +00004143 if (status != PSA_SUCCESS) {
4144 return status;
4145 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004146
Paul Elliott068fe072023-01-16 13:59:15 +00004147 status = mbedtls_to_psa_error(
4148 mbedtls_mpi_read_binary(&operation->s,
4149 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004150 coordinate_bytes,
4151 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004152
Paul Elliott068fe072023-01-16 13:59:15 +00004153 if (status != PSA_SUCCESS) {
4154 return status;
4155 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004156
Paul Elliott2c9843f2023-02-15 17:32:42 +00004157 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004158
Paul Elliott2c9843f2023-02-15 17:32:42 +00004159 if (status != PSA_SUCCESS) {
4160 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004161 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004162
Paul Elliott0290a762023-02-09 14:30:24 +00004163 /* We only need to store the same length of hash as the private key size
4164 * here, it would be truncated by the internal implementation anyway. */
4165 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4166 coordinate_bytes);
4167
Paul Elliottba70ad42023-02-15 18:23:53 +00004168 if (required_hash_length > sizeof(operation->hash)) {
4169 /* Shouldn't happen, but better safe than sorry. */
4170 return PSA_ERROR_CORRUPTION_DETECTED;
4171 }
4172
Paul Elliott0290a762023-02-09 14:30:24 +00004173 memcpy(operation->hash, hash, required_hash_length);
4174 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004175
4176 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004177#else
Paul Elliott068fe072023-01-16 13:59:15 +00004178 (void) operation;
4179 (void) key_buffer;
4180 (void) key_buffer_size;
4181 (void) alg;
4182 (void) hash;
4183 (void) hash_length;
4184 (void) signature;
4185 (void) signature_length;
4186 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004187 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004188 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004189
Paul Elliott068fe072023-01-16 13:59:15 +00004190 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004191#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4192 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4193 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004194}
4195
4196psa_status_t mbedtls_psa_verify_hash_complete(
4197 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4198{
4199
4200#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4201 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4202 defined(MBEDTLS_ECP_RESTARTABLE)
4203
Paul Elliottf8e5b562023-02-19 18:43:45 +00004204 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4205
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004206 /* Ensure max_ops is set to the current value (or default). */
4207 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4208
Paul Elliottf8e5b562023-02-19 18:43:45 +00004209 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004210 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4211 operation->hash,
4212 operation->hash_length,
4213 &operation->ctx->Q,
4214 &operation->r,
4215 &operation->s,
4216 &operation->restart_ctx));
4217
Paul Elliottf8e5b562023-02-19 18:43:45 +00004218 /* Hide the fact that the restart context only holds a delta of number of
4219 * ops done during the last operation, not an absolute value. */
4220 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4221
4222 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004223#else
4224 (void) operation;
4225
4226 return PSA_ERROR_NOT_SUPPORTED;
4227
4228#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4229 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4230 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4231}
4232
4233psa_status_t mbedtls_psa_verify_hash_abort(
4234 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4235{
4236
4237#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4238 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4239 defined(MBEDTLS_ECP_RESTARTABLE)
4240
4241 if (operation->ctx) {
4242 mbedtls_ecdsa_free(operation->ctx);
4243 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004244 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004245 }
4246
4247 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4248
Paul Elliott93d9ca82023-02-15 18:14:21 +00004249 operation->num_ops = 0;
4250
Paul Elliott588f8ed2022-12-02 18:10:26 +00004251 mbedtls_mpi_free(&operation->r);
4252 mbedtls_mpi_free(&operation->s);
4253
4254 return PSA_SUCCESS;
4255
4256#else
4257 (void) operation;
4258
4259 return PSA_ERROR_NOT_SUPPORTED;
4260
4261#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4262 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4263 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4264}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004265
David Horstmann6e99bb22024-02-06 15:27:49 +00004266static psa_status_t psa_generate_random_internal(uint8_t *output,
4267 size_t output_size)
4268{
4269 GUARD_MODULE_INITIALIZED;
4270
4271 psa_status_t status;
4272
4273#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4274
4275 size_t output_length = 0;
4276 status = mbedtls_psa_external_get_random(&global_data.rng,
4277 output, output_size,
4278 &output_length);
4279 if (status != PSA_SUCCESS) {
4280 goto exit;
4281 }
4282 /* Breaking up a request into smaller chunks is currently not supported
4283 * for the external RNG interface. */
4284 if (output_length != output_size) {
4285 status = PSA_ERROR_INSUFFICIENT_ENTROPY;
4286 goto exit;
4287 }
4288 status = PSA_SUCCESS;
4289
4290#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4291
4292 while (output_size > 0) {
4293 size_t request_size =
4294 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4295 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4296 output_size);
4297 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
4298 output, request_size);
4299 if (ret != 0) {
4300 status = mbedtls_to_psa_error(ret);
4301 goto exit;
4302 }
4303 output_size -= request_size;
4304 output += request_size;
4305 }
4306 status = PSA_SUCCESS;
4307#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4308
4309exit:
4310 return status;
4311}
4312
4313
mohammad1603503973b2018-03-12 15:59:30 +02004314/****************************************************************/
4315/* Symmetric cryptography */
4316/****************************************************************/
4317
Gilles Peskine449bd832023-01-11 14:50:10 +01004318static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4319 mbedtls_svc_key_id_t key,
4320 psa_algorithm_t alg,
4321 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004322{
4323 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4324 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004325 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004326 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4327 PSA_KEY_USAGE_ENCRYPT :
4328 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004329 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004330
4331 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004332 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004333 status = PSA_ERROR_BAD_STATE;
4334 goto exit;
4335 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004336
Gilles Peskine449bd832023-01-11 14:50:10 +01004337 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004338 status = PSA_ERROR_INVALID_ARGUMENT;
4339 goto exit;
4340 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004341
Gilles Peskine449bd832023-01-11 14:50:10 +01004342 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4343 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004344 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004345 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004346
Ronald Cron49fafa92021-03-10 08:34:23 +01004347 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004348 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004349 * so we only set it (in the driver wrapper) after resources have been
4350 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004351 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004352 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004353 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004354 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004355 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004356 }
4357 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004358
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004359 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004360 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004361 };
4362
Ronald Cronab99ac22020-10-01 16:38:28 +02004363 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004364 if (cipher_operation == MBEDTLS_ENCRYPT) {
4365 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4366 &attributes,
4367 slot->key.data,
4368 slot->key.bytes,
4369 alg);
4370 } else {
4371 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4372 &attributes,
4373 slot->key.data,
4374 slot->key.bytes,
4375 alg);
4376 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004377
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004378exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004379 if (status != PSA_SUCCESS) {
4380 psa_cipher_abort(operation);
4381 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004382
Ryan Everett1b70a072024-01-04 10:32:49 +00004383 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004384
Gilles Peskine449bd832023-01-11 14:50:10 +01004385 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004386}
4387
Gilles Peskine449bd832023-01-11 14:50:10 +01004388psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4389 mbedtls_svc_key_id_t key,
4390 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004391{
Gilles Peskine449bd832023-01-11 14:50:10 +01004392 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004393}
4394
Gilles Peskine449bd832023-01-11 14:50:10 +01004395psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4396 mbedtls_svc_key_id_t key,
4397 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004398{
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004400}
4401
Gilles Peskine449bd832023-01-11 14:50:10 +01004402psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
Gabor Mezei358eb212024-02-07 18:10:13 +01004403 uint8_t *iv_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004404 size_t iv_size,
4405 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004406{
Ronald Cron6d051732020-10-01 14:10:20 +02004407 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Sergeybef1f632023-03-06 15:25:06 -07004408 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004409
Gabor Mezei358eb212024-02-07 18:10:13 +01004410 LOCAL_OUTPUT_DECLARE(iv_external, iv);
4411
Gilles Peskine449bd832023-01-11 14:50:10 +01004412 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004413 status = PSA_ERROR_BAD_STATE;
4414 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004415 }
4416
Gilles Peskine449bd832023-01-11 14:50:10 +01004417 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004418 status = PSA_ERROR_BAD_STATE;
4419 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004420 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004421
Ronald Cron2fb90522021-07-05 12:31:44 +02004422 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004423 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004424 status = PSA_ERROR_BUFFER_TOO_SMALL;
4425 goto exit;
4426 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004427
Gilles Peskine449bd832023-01-11 14:50:10 +01004428 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004429 status = PSA_ERROR_GENERIC_ERROR;
4430 goto exit;
4431 }
4432
Gabor Mezei358eb212024-02-07 18:10:13 +01004433 LOCAL_OUTPUT_ALLOC(iv_external, default_iv_length, iv);
4434
Gabor Mezei1b5b58d2024-03-04 17:15:08 +01004435 status = psa_generate_random_internal(iv, default_iv_length);
Gilles Peskine449bd832023-01-11 14:50:10 +01004436 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004437 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004438 }
Ronald Cron5618a392021-03-26 09:52:26 +01004439
Gilles Peskine449bd832023-01-11 14:50:10 +01004440 status = psa_driver_wrapper_cipher_set_iv(operation,
Gabor Mezei358eb212024-02-07 18:10:13 +01004441 iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004442
4443exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004444 if (status == PSA_SUCCESS) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004445 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004446 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004448 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004449 psa_cipher_abort(operation);
Gabor Mezei358eb212024-02-07 18:10:13 +01004450 if (iv != NULL) {
4451 mbedtls_platform_zeroize(iv, default_iv_length);
4452 }
Ronald Cron2fb90522021-07-05 12:31:44 +02004453 }
Ronald Cron6d051732020-10-01 14:10:20 +02004454
Gabor Mezei358eb212024-02-07 18:10:13 +01004455 LOCAL_OUTPUT_FREE(iv_external, iv);
Gilles Peskine449bd832023-01-11 14:50:10 +01004456 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004457}
4458
Gilles Peskine449bd832023-01-11 14:50:10 +01004459psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004460 const uint8_t *iv_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004461 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004462{
Ronald Cron6d051732020-10-01 14:10:20 +02004463 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004464
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004465 LOCAL_INPUT_DECLARE(iv_external, iv);
4466
Gilles Peskine449bd832023-01-11 14:50:10 +01004467 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004468 status = PSA_ERROR_BAD_STATE;
4469 goto exit;
4470 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004471
Gilles Peskine449bd832023-01-11 14:50:10 +01004472 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004473 status = PSA_ERROR_BAD_STATE;
4474 goto exit;
4475 }
Ronald Crona0d68172021-03-26 10:15:08 +01004476
Gilles Peskine449bd832023-01-11 14:50:10 +01004477 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004478 status = PSA_ERROR_INVALID_ARGUMENT;
4479 goto exit;
4480 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004481
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004482 LOCAL_INPUT_ALLOC(iv_external, iv_length, iv);
4483
Gilles Peskine449bd832023-01-11 14:50:10 +01004484 status = psa_driver_wrapper_cipher_set_iv(operation,
4485 iv,
4486 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004487
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004488exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004489 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004490 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004491 } else {
4492 psa_cipher_abort(operation);
4493 }
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004494
4495 LOCAL_INPUT_FREE(iv_external, iv);
4496
Gilles Peskine449bd832023-01-11 14:50:10 +01004497 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004498}
4499
Gilles Peskine449bd832023-01-11 14:50:10 +01004500psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
Gabor Mezei212eb082024-01-24 16:56:00 +01004501 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 size_t input_length,
Gabor Mezei212eb082024-01-24 16:56:00 +01004503 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004504 size_t output_size,
4505 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004506{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004507 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004508
Gabor Mezei212eb082024-01-24 16:56:00 +01004509 LOCAL_INPUT_DECLARE(input_external, input);
4510 LOCAL_OUTPUT_DECLARE(output_external, output);
4511
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004513 status = PSA_ERROR_BAD_STATE;
4514 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004515 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004516
Gilles Peskine449bd832023-01-11 14:50:10 +01004517 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004518 status = PSA_ERROR_BAD_STATE;
4519 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004520 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004521
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004522 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gabor Mezei0b041162024-02-29 10:08:16 +00004523 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004524
Gilles Peskine449bd832023-01-11 14:50:10 +01004525 status = psa_driver_wrapper_cipher_update(operation,
4526 input,
4527 input_length,
4528 output,
4529 output_size,
4530 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004531
4532exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004533 if (status != PSA_SUCCESS) {
4534 psa_cipher_abort(operation);
4535 }
Ronald Cron6d051732020-10-01 14:10:20 +02004536
Gabor Mezei212eb082024-01-24 16:56:00 +01004537 LOCAL_INPUT_FREE(input_external, input);
4538 LOCAL_OUTPUT_FREE(output_external, output);
4539
Gilles Peskine449bd832023-01-11 14:50:10 +01004540 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004541}
4542
Gilles Peskine449bd832023-01-11 14:50:10 +01004543psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
Gabor Mezei212eb082024-01-24 16:56:00 +01004544 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 size_t output_size,
4546 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004547{
David Saadab4ecc272019-02-14 13:48:10 +02004548 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004549
Gabor Mezei212eb082024-01-24 16:56:00 +01004550 LOCAL_OUTPUT_DECLARE(output_external, output);
4551
Gilles Peskine449bd832023-01-11 14:50:10 +01004552 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004553 status = PSA_ERROR_BAD_STATE;
4554 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004555 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004556
Gilles Peskine449bd832023-01-11 14:50:10 +01004557 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004558 status = PSA_ERROR_BAD_STATE;
4559 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004560 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004561
Gabor Mezei0b041162024-02-29 10:08:16 +00004562 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004563
Gilles Peskine449bd832023-01-11 14:50:10 +01004564 status = psa_driver_wrapper_cipher_finish(operation,
4565 output,
4566 output_size,
4567 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004568
4569exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004570 if (status == PSA_SUCCESS) {
Gabor Mezei212eb082024-01-24 16:56:00 +01004571 status = psa_cipher_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01004572 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004573 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004574 (void) psa_cipher_abort(operation);
Steven Cooremanef8575e2020-09-11 11:44:50 +02004575 }
Gabor Mezei212eb082024-01-24 16:56:00 +01004576
4577 LOCAL_OUTPUT_FREE(output_external, output);
4578
4579 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004580}
4581
Gilles Peskine449bd832023-01-11 14:50:10 +01004582psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004583{
Gilles Peskine449bd832023-01-11 14:50:10 +01004584 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004585 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004586 * in use. It's ok to call abort on such an object, and there's
4587 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004588 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004589 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004590
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004592
Ronald Cron49fafa92021-03-10 08:34:23 +01004593 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004594 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004595 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004596
Gilles Peskine449bd832023-01-11 14:50:10 +01004597 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004598}
4599
Gilles Peskine449bd832023-01-11 14:50:10 +01004600psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4601 psa_algorithm_t alg,
David Horstmann36df4b22023-12-13 15:55:25 +00004602 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 size_t input_length,
David Horstmann36df4b22023-12-13 15:55:25 +00004604 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004605 size_t output_size,
4606 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004607{
4608 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004609 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004610 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004611 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4612 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004613 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004614
David Horstmann62a56d92023-12-14 18:12:47 +00004615 LOCAL_INPUT_DECLARE(input_external, input);
4616 LOCAL_OUTPUT_DECLARE(output_external, output);
4617
Gilles Peskine449bd832023-01-11 14:50:10 +01004618 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004619 status = PSA_ERROR_INVALID_ARGUMENT;
4620 goto exit;
4621 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004622
Gilles Peskine449bd832023-01-11 14:50:10 +01004623 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4624 PSA_KEY_USAGE_ENCRYPT,
4625 alg);
4626 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004627 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004628 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004629
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004630 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004631 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004632 };
4633
Gilles Peskine449bd832023-01-11 14:50:10 +01004634 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4635 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004636 status = PSA_ERROR_GENERIC_ERROR;
4637 goto exit;
4638 }
4639
Gilles Peskine449bd832023-01-11 14:50:10 +01004640 if (default_iv_length > 0) {
4641 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004642 status = PSA_ERROR_BUFFER_TOO_SMALL;
4643 goto exit;
4644 }
4645
David Horstmann6e99bb22024-02-06 15:27:49 +00004646 status = psa_generate_random_internal(local_iv, default_iv_length);
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004648 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004649 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004650 }
4651
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004652 LOCAL_INPUT_ALLOC(input_external, input_length, input);
4653 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
4654
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004655 status = psa_driver_wrapper_cipher_encrypt(
4656 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004657 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004658 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004659 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004660
4661exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004662 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004663 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004664 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004665 }
Ronald Cron23919522021-07-08 19:00:07 +02004666
Gilles Peskine449bd832023-01-11 14:50:10 +01004667 if (status == PSA_SUCCESS) {
4668 if (default_iv_length > 0) {
4669 memcpy(output, local_iv, default_iv_length);
4670 }
4671 *output_length += default_iv_length;
4672 } else {
4673 *output_length = 0;
4674 }
4675
David Horstmann62a56d92023-12-14 18:12:47 +00004676 LOCAL_INPUT_FREE(input_external, input);
4677 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004678
Gilles Peskine449bd832023-01-11 14:50:10 +01004679 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004680}
4681
Gilles Peskine449bd832023-01-11 14:50:10 +01004682psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4683 psa_algorithm_t alg,
Gabor Mezei212eb082024-01-24 16:56:00 +01004684 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004685 size_t input_length,
Gabor Mezei212eb082024-01-24 16:56:00 +01004686 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004687 size_t output_size,
4688 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004689{
4690 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004691 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004692 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004693 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004694
Gabor Mezei212eb082024-01-24 16:56:00 +01004695 LOCAL_INPUT_DECLARE(input_external, input);
4696 LOCAL_OUTPUT_DECLARE(output_external, output);
4697
Gilles Peskine449bd832023-01-11 14:50:10 +01004698 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004699 status = PSA_ERROR_INVALID_ARGUMENT;
4700 goto exit;
4701 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004702
Gilles Peskine449bd832023-01-11 14:50:10 +01004703 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4704 PSA_KEY_USAGE_DECRYPT,
4705 alg);
4706 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004707 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004708 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004709
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004710 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004711 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004712 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004713
Gilles Peskine449bd832023-01-11 14:50:10 +01004714 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4715 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004716 status = PSA_ERROR_INVALID_ARGUMENT;
4717 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004718 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004719 status = PSA_ERROR_INVALID_ARGUMENT;
4720 goto exit;
4721 }
4722
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004723 LOCAL_INPUT_ALLOC(input_external, input_length, input);
4724 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
4725
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004726 status = psa_driver_wrapper_cipher_decrypt(
4727 &attributes, slot->key.data, slot->key.bytes,
4728 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004729 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004730
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004731exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004732 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004733 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004734 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004735 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004736
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004738 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004739 }
Ronald Cron23919522021-07-08 19:00:07 +02004740
Gabor Mezei212eb082024-01-24 16:56:00 +01004741 LOCAL_INPUT_FREE(input_external, input);
4742 LOCAL_OUTPUT_FREE(output_external, output);
4743
Gilles Peskine449bd832023-01-11 14:50:10 +01004744 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004745}
4746
4747
mohammad16035955c982018-04-26 00:53:03 +03004748/****************************************************************/
4749/* AEAD */
4750/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004751
Paul Elliottbaff51c2021-09-28 17:44:45 +01004752/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004753static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004754{
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004756}
4757
4758/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004759static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4760 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004761{
Gilles Peskine449bd832023-01-11 14:50:10 +01004762 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004763
Gilles Peskine449bd832023-01-11 14:50:10 +01004764 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004765#if defined(PSA_WANT_ALG_GCM)
4766 case PSA_ALG_GCM:
4767 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004768 * arbitrarily large nonces. Please note that we do not generally
4769 * recommend the usage of nonces of greater length than
4770 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4771 * size, which can then lead to collisions if you encrypt a very
4772 * large number of messages.*/
4773 if (nonce_length != 0) {
4774 return PSA_SUCCESS;
4775 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004776 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004777#endif /* PSA_WANT_ALG_GCM */
4778#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004779 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004780 if (nonce_length >= 7 && nonce_length <= 13) {
4781 return PSA_SUCCESS;
4782 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004783 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004784#endif /* PSA_WANT_ALG_CCM */
4785#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004786 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004787 if (nonce_length == 12) {
4788 return PSA_SUCCESS;
4789 } else if (nonce_length == 8) {
4790 return PSA_ERROR_NOT_SUPPORTED;
4791 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004792 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004793#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004794 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004795 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004796 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004797 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004798
Gilles Peskine449bd832023-01-11 14:50:10 +01004799 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004800}
4801
Gilles Peskine449bd832023-01-11 14:50:10 +01004802static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004803{
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4805 return PSA_ERROR_INVALID_ARGUMENT;
4806 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004807
Gilles Peskine449bd832023-01-11 14:50:10 +01004808 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004809}
4810
Gilles Peskine449bd832023-01-11 14:50:10 +01004811psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4812 psa_algorithm_t alg,
David Horstmann9d09a022023-11-28 19:25:00 +00004813 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 size_t nonce_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004815 const uint8_t *additional_data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 size_t additional_data_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004817 const uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 size_t plaintext_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004819 uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004820 size_t ciphertext_size,
4821 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004822{
Ronald Cron215633c2021-03-16 17:15:37 +01004823 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4824 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004825
David Horstmann9d09a022023-11-28 19:25:00 +00004826 LOCAL_INPUT_DECLARE(nonce_external, nonce);
4827 LOCAL_INPUT_DECLARE(additional_data_external, additional_data);
4828 LOCAL_INPUT_DECLARE(plaintext_external, plaintext);
4829 LOCAL_OUTPUT_DECLARE(ciphertext_external, ciphertext);
4830
mohammad1603f08a5502018-06-03 15:05:47 +03004831 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004832
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 status = psa_aead_check_algorithm(alg);
4834 if (status != PSA_SUCCESS) {
4835 return status;
4836 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004837
Ronald Cron9a986162021-03-26 12:40:07 +01004838 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004839 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4840 if (status != PSA_SUCCESS) {
4841 return status;
4842 }
mohammad16035955c982018-04-26 00:53:03 +03004843
Ronald Cron215633c2021-03-16 17:15:37 +01004844 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004845 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004846 };
mohammad16035955c982018-04-26 00:53:03 +03004847
David Horstmann9d09a022023-11-28 19:25:00 +00004848 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
4849 LOCAL_INPUT_ALLOC(additional_data_external, additional_data_length, additional_data);
4850 LOCAL_INPUT_ALLOC(plaintext_external, plaintext_length, plaintext);
4851 LOCAL_OUTPUT_ALLOC(ciphertext_external, ciphertext_size, ciphertext);
4852
Gilles Peskine449bd832023-01-11 14:50:10 +01004853 status = psa_aead_check_nonce_length(alg, nonce_length);
4854 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004855 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004856 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004857
Ronald Cronde822812021-03-17 16:08:20 +01004858 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004859 &attributes, slot->key.data, slot->key.bytes,
4860 alg,
4861 nonce, nonce_length,
4862 additional_data, additional_data_length,
4863 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004865
Gilles Peskine449bd832023-01-11 14:50:10 +01004866 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4867 memset(ciphertext, 0, ciphertext_size);
4868 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004869
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004870exit:
David Horstmann9d09a022023-11-28 19:25:00 +00004871 LOCAL_INPUT_FREE(nonce_external, nonce);
4872 LOCAL_INPUT_FREE(additional_data_external, additional_data);
4873 LOCAL_INPUT_FREE(plaintext_external, plaintext);
4874 LOCAL_OUTPUT_FREE(ciphertext_external, ciphertext);
4875
Ryan Everett1b70a072024-01-04 10:32:49 +00004876 psa_unregister_read(slot);
mohammad16035955c982018-04-26 00:53:03 +03004877
Gilles Peskine449bd832023-01-11 14:50:10 +01004878 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004879}
4880
Gilles Peskine449bd832023-01-11 14:50:10 +01004881psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4882 psa_algorithm_t alg,
David Horstmann7f2e0402023-11-28 19:43:53 +00004883 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004884 size_t nonce_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004885 const uint8_t *additional_data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004886 size_t additional_data_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004887 const uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004888 size_t ciphertext_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004889 uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 size_t plaintext_size,
4891 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004892{
Ronald Cron215633c2021-03-16 17:15:37 +01004893 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4894 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004895
David Horstmann7f2e0402023-11-28 19:43:53 +00004896 LOCAL_INPUT_DECLARE(nonce_external, nonce);
4897 LOCAL_INPUT_DECLARE(additional_data_external, additional_data);
4898 LOCAL_INPUT_DECLARE(ciphertext_external, ciphertext);
4899 LOCAL_OUTPUT_DECLARE(plaintext_external, plaintext);
4900
Gilles Peskineee652a32018-06-01 19:23:52 +02004901 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004902
Gilles Peskine449bd832023-01-11 14:50:10 +01004903 status = psa_aead_check_algorithm(alg);
4904 if (status != PSA_SUCCESS) {
4905 return status;
4906 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004907
Ronald Cron9a986162021-03-26 12:40:07 +01004908 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004909 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4910 if (status != PSA_SUCCESS) {
4911 return status;
4912 }
mohammad16035955c982018-04-26 00:53:03 +03004913
Ronald Cron215633c2021-03-16 17:15:37 +01004914 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004915 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004916 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004917
David Horstmann7f2e0402023-11-28 19:43:53 +00004918 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
4919 LOCAL_INPUT_ALLOC(additional_data_external, additional_data_length,
4920 additional_data);
4921 LOCAL_INPUT_ALLOC(ciphertext_external, ciphertext_length, ciphertext);
4922 LOCAL_OUTPUT_ALLOC(plaintext_external, plaintext_size, plaintext);
4923
Gilles Peskine449bd832023-01-11 14:50:10 +01004924 status = psa_aead_check_nonce_length(alg, nonce_length);
4925 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004926 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004927 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004928
Ronald Cronde822812021-03-17 16:08:20 +01004929 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004930 &attributes, slot->key.data, slot->key.bytes,
4931 alg,
4932 nonce, nonce_length,
4933 additional_data, additional_data_length,
4934 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004936
Gilles Peskine449bd832023-01-11 14:50:10 +01004937 if (status != PSA_SUCCESS && plaintext_size != 0) {
4938 memset(plaintext, 0, plaintext_size);
4939 }
mohammad160360a64d02018-06-03 17:20:42 +03004940
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004941exit:
David Horstmann7f2e0402023-11-28 19:43:53 +00004942 LOCAL_INPUT_FREE(nonce_external, nonce);
4943 LOCAL_INPUT_FREE(additional_data_external, additional_data);
4944 LOCAL_INPUT_FREE(ciphertext_external, ciphertext);
4945 LOCAL_OUTPUT_FREE(plaintext_external, plaintext);
4946
Ryan Everett1b70a072024-01-04 10:32:49 +00004947 psa_unregister_read(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004948
Gilles Peskine449bd832023-01-11 14:50:10 +01004949 return status;
mohammad16035955c982018-04-26 00:53:03 +03004950}
4951
Gilles Peskine449bd832023-01-11 14:50:10 +01004952static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4953{
4954 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004955
Gilles Peskine449bd832023-01-11 14:50:10 +01004956 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004957#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004958 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004959 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004960 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4961 return PSA_ERROR_INVALID_ARGUMENT;
4962 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004963 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004964#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004965
Przemek Stekiel86679c72022-10-06 17:06:56 +02004966#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004967 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004968 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004969 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4970 return PSA_ERROR_INVALID_ARGUMENT;
4971 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004972 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004973#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004974
Przemek Stekiel86679c72022-10-06 17:06:56 +02004975#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004976 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004977 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004978 if (tag_len != 16) {
4979 return PSA_ERROR_INVALID_ARGUMENT;
4980 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004981 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004982#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004983
4984 default:
4985 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004986 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004987 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004988 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004989}
4990
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004991/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004992static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4993 int is_encrypt,
4994 mbedtls_svc_key_id_t key,
4995 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004996{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004997 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4998 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4999 psa_key_slot_t *slot = NULL;
5000 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005001 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005002
Gilles Peskine449bd832023-01-11 14:50:10 +01005003 status = psa_aead_check_algorithm(alg);
5004 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005005 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005006 }
Paul Elliottc2b71442021-06-24 18:17:52 +01005007
Gilles Peskine449bd832023-01-11 14:50:10 +01005008 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005009 status = PSA_ERROR_BAD_STATE;
5010 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01005011 }
5012
Gilles Peskine449bd832023-01-11 14:50:10 +01005013 if (operation->nonce_set || operation->lengths_set ||
5014 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005015 status = PSA_ERROR_BAD_STATE;
5016 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01005017 }
5018
Gilles Peskine449bd832023-01-11 14:50:10 +01005019 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005020 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005021 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005022 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005023 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005024
Gilles Peskine449bd832023-01-11 14:50:10 +01005025 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
5026 alg);
5027 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005028 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005029 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005030
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005031 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005032 .core = slot->attr
5033 };
5034
Gilles Peskine449bd832023-01-11 14:50:10 +01005035 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02005036 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005037 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02005038
Gilles Peskine449bd832023-01-11 14:50:10 +01005039 if (is_encrypt) {
5040 status = psa_driver_wrapper_aead_encrypt_setup(operation,
5041 &attributes,
5042 slot->key.data,
5043 slot->key.bytes,
5044 alg);
5045 } else {
5046 status = psa_driver_wrapper_aead_decrypt_setup(operation,
5047 &attributes,
5048 slot->key.data,
5049 slot->key.bytes,
5050 alg);
5051 }
5052 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005053 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005055
Gilles Peskine449bd832023-01-11 14:50:10 +01005056 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005057
5058exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00005059 unlock_status = psa_unregister_read(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005060
Gilles Peskine449bd832023-01-11 14:50:10 +01005061 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005062 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005063 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01005064 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01005065 } else {
5066 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005067 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005068
Gilles Peskine449bd832023-01-11 14:50:10 +01005069 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01005070}
5071
Paul Elliott302ff6b2021-04-20 18:10:30 +01005072/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005073psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
5074 mbedtls_svc_key_id_t key,
5075 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005076{
Gilles Peskine449bd832023-01-11 14:50:10 +01005077 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005078}
5079
5080/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005081psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
5082 mbedtls_svc_key_id_t key,
5083 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005084{
Gilles Peskine449bd832023-01-11 14:50:10 +01005085 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005086}
5087
David Horstmannfed23772023-12-19 17:49:20 +00005088static psa_status_t psa_aead_set_nonce_internal(psa_aead_operation_t *operation,
5089 const uint8_t *nonce,
5090 size_t nonce_length)
5091{
5092 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5093
5094 if (operation->id == 0) {
5095 status = PSA_ERROR_BAD_STATE;
5096 goto exit;
5097 }
5098
5099 if (operation->nonce_set) {
5100 status = PSA_ERROR_BAD_STATE;
5101 goto exit;
5102 }
5103
5104 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
5105 if (status != PSA_SUCCESS) {
5106 status = PSA_ERROR_INVALID_ARGUMENT;
5107 goto exit;
5108 }
5109
5110 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
5111 nonce_length);
5112
5113exit:
5114 if (status == PSA_SUCCESS) {
5115 operation->nonce_set = 1;
5116 } else {
5117 psa_aead_abort(operation);
5118 }
5119
5120 return status;
5121}
5122
Paul Elliott302ff6b2021-04-20 18:10:30 +01005123/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01005124psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
David Horstmannd3cad8b2023-12-11 14:46:04 +00005125 uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005126 size_t nonce_size,
5127 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005128{
5129 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01005130 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07005131 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005132
David Horstmannd3cad8b2023-12-11 14:46:04 +00005133 LOCAL_OUTPUT_DECLARE(nonce_external, nonce);
5134 LOCAL_OUTPUT_ALLOC(nonce_external, nonce_size, nonce);
5135
Paul Elliott8eb9daf2021-06-04 16:42:21 +01005136 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005137
Gilles Peskine449bd832023-01-11 14:50:10 +01005138 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005139 status = PSA_ERROR_BAD_STATE;
5140 goto exit;
5141 }
5142
Gilles Peskine449bd832023-01-11 14:50:10 +01005143 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005144 status = PSA_ERROR_BAD_STATE;
5145 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005146 }
5147
Paul Elliotte193ea82021-10-01 13:00:16 +01005148 /* For CCM, this size may not be correct according to the PSA
5149 * specification. The PSA Crypto 1.0.1 specification states:
5150 *
5151 * CCM encodes the plaintext length pLen in L octets, with L the smallest
5152 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
5153 *
5154 * However this restriction that L has to be the smallest integer is not
5155 * applied in practice, and it is not implementable here since the
5156 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005157 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
5158 operation->alg);
5159 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005160 status = PSA_ERROR_BUFFER_TOO_SMALL;
5161 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005162 }
5163
David Horstmann6e99bb22024-02-06 15:27:49 +00005164 status = psa_generate_random_internal(local_nonce, required_nonce_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01005165 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005166 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005167 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01005168
David Horstmannfed23772023-12-19 17:49:20 +00005169 status = psa_aead_set_nonce_internal(operation, local_nonce,
5170 required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005171
Paul Elliott39dc6b82021-05-11 19:16:09 +01005172exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005173 if (status == PSA_SUCCESS) {
5174 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005175 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01005176 } else {
5177 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01005178 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005179
David Horstmannd3cad8b2023-12-11 14:46:04 +00005180 LOCAL_OUTPUT_FREE(nonce_external, nonce);
5181
Gilles Peskine449bd832023-01-11 14:50:10 +01005182 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005183}
5184
5185/* Set the nonce for a multipart authenticated encryption or decryption
5186 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005187psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
David Horstmann8f0ef512023-12-11 15:17:11 +00005188 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005189 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005190{
David Horstmannfed23772023-12-19 17:49:20 +00005191 psa_status_t status;
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005192
David Horstmann8f0ef512023-12-11 15:17:11 +00005193 LOCAL_INPUT_DECLARE(nonce_external, nonce);
5194 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
Paul Elliottcee785c2021-05-20 14:29:20 +01005195
David Horstmannfed23772023-12-19 17:49:20 +00005196 status = psa_aead_set_nonce_internal(operation, nonce, nonce_length);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005197
David Horstmann18dc0322023-12-20 16:16:43 +00005198/* Exit label is only needed for buffer copying, prevent unused warnings. */
5199#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Paul Elliott39dc6b82021-05-11 19:16:09 +01005200exit:
David Horstmann18dc0322023-12-20 16:16:43 +00005201#endif
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005202
David Horstmann8f0ef512023-12-11 15:17:11 +00005203 LOCAL_INPUT_FREE(nonce_external, nonce);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005204
Gilles Peskine449bd832023-01-11 14:50:10 +01005205 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005206}
5207
5208/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005209psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
5210 size_t ad_length,
5211 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005212{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005213 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5214
Gilles Peskine449bd832023-01-11 14:50:10 +01005215 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005216 status = PSA_ERROR_BAD_STATE;
5217 goto exit;
5218 }
5219
Gilles Peskine449bd832023-01-11 14:50:10 +01005220 if (operation->lengths_set || operation->ad_started ||
5221 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005222 status = PSA_ERROR_BAD_STATE;
5223 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005224 }
5225
Gilles Peskine449bd832023-01-11 14:50:10 +01005226 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005227#if defined(PSA_WANT_ALG_GCM)
5228 case PSA_ALG_GCM:
5229 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01005230 * bits. Without the guard this code will generate warnings on 32bit
5231 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01005232#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01005233 if (((uint64_t) ad_length) >> 61 != 0 ||
5234 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005235 status = PSA_ERROR_INVALID_ARGUMENT;
5236 goto exit;
5237 }
Paul Elliott325d3742021-09-27 17:56:28 +01005238#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005239 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005240#endif /* PSA_WANT_ALG_GCM */
5241#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005242 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01005243 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005244 status = PSA_ERROR_INVALID_ARGUMENT;
5245 goto exit;
5246 }
5247 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005248#endif /* PSA_WANT_ALG_CCM */
5249#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005250 case PSA_ALG_CHACHA20_POLY1305:
5251 /* No length restrictions for ChaChaPoly. */
5252 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005253#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005254 default:
5255 break;
5256 }
Paul Elliott325d3742021-09-27 17:56:28 +01005257
Gilles Peskine449bd832023-01-11 14:50:10 +01005258 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
5259 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005260
Paul Elliott39dc6b82021-05-11 19:16:09 +01005261exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005262 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005263 operation->ad_remaining = ad_length;
5264 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01005265 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 } else {
5267 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01005268 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005269
Gilles Peskine449bd832023-01-11 14:50:10 +01005270 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005271}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005272
5273/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005274psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
David Horstmann25dac6e2023-12-11 15:23:13 +00005275 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005276 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005277{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005278 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5279
David Horstmann25dac6e2023-12-11 15:23:13 +00005280 LOCAL_INPUT_DECLARE(input_external, input);
5281 LOCAL_INPUT_ALLOC(input_external, input_length, input);
5282
Gilles Peskine449bd832023-01-11 14:50:10 +01005283 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005284 status = PSA_ERROR_BAD_STATE;
5285 goto exit;
5286 }
5287
Gilles Peskine449bd832023-01-11 14:50:10 +01005288 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005289 status = PSA_ERROR_BAD_STATE;
5290 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005291 }
5292
Gilles Peskine449bd832023-01-11 14:50:10 +01005293 if (operation->lengths_set) {
5294 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005295 status = PSA_ERROR_INVALID_ARGUMENT;
5296 goto exit;
5297 }
5298
5299 operation->ad_remaining -= input_length;
5300 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005301#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005302 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005303 status = PSA_ERROR_BAD_STATE;
5304 goto exit;
5305 }
5306#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005307
Gilles Peskine449bd832023-01-11 14:50:10 +01005308 status = psa_driver_wrapper_aead_update_ad(operation, input,
5309 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005310
Paul Elliott39dc6b82021-05-11 19:16:09 +01005311exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005312 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005313 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005314 } else {
5315 psa_aead_abort(operation);
5316 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005317
David Horstmann25dac6e2023-12-11 15:23:13 +00005318 LOCAL_INPUT_FREE(input_external, input);
5319
Gilles Peskine449bd832023-01-11 14:50:10 +01005320 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005321}
5322
5323/* Encrypt or decrypt a message fragment in an active multipart AEAD
5324 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005325psa_status_t psa_aead_update(psa_aead_operation_t *operation,
David Horstmann2914fac2023-12-11 15:28:37 +00005326 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005327 size_t input_length,
David Horstmann2914fac2023-12-11 15:28:37 +00005328 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005329 size_t output_size,
5330 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005331{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005332 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005333
David Horstmann2914fac2023-12-11 15:28:37 +00005334
5335 LOCAL_INPUT_DECLARE(input_external, input);
5336 LOCAL_OUTPUT_DECLARE(output_external, output);
5337
5338 LOCAL_INPUT_ALLOC(input_external, input_length, input);
5339 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
5340
Paul Elliott302ff6b2021-04-20 18:10:30 +01005341 *output_length = 0;
5342
Gilles Peskine449bd832023-01-11 14:50:10 +01005343 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005344 status = PSA_ERROR_BAD_STATE;
5345 goto exit;
5346 }
5347
Gilles Peskine449bd832023-01-11 14:50:10 +01005348 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005349 status = PSA_ERROR_BAD_STATE;
5350 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005351 }
5352
Gilles Peskine449bd832023-01-11 14:50:10 +01005353 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005354 /* Additional data length was supplied, but not all the additional
5355 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005356 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005357 status = PSA_ERROR_INVALID_ARGUMENT;
5358 goto exit;
5359 }
5360
5361 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005362 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005363 status = PSA_ERROR_INVALID_ARGUMENT;
5364 goto exit;
5365 }
5366
5367 operation->body_remaining -= input_length;
5368 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005369#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005370 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005371 status = PSA_ERROR_BAD_STATE;
5372 goto exit;
5373 }
5374#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005375
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5377 output, output_size,
5378 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005379
Paul Elliott39dc6b82021-05-11 19:16:09 +01005380exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005382 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005383 } else {
5384 psa_aead_abort(operation);
5385 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005386
David Horstmann2914fac2023-12-11 15:28:37 +00005387 LOCAL_INPUT_FREE(input_external, input);
5388 LOCAL_OUTPUT_FREE(output_external, output);
5389
Gilles Peskine449bd832023-01-11 14:50:10 +01005390 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005391}
5392
Gilles Peskine449bd832023-01-11 14:50:10 +01005393static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005394{
Gilles Peskine449bd832023-01-11 14:50:10 +01005395 if (operation->id == 0 || !operation->nonce_set) {
5396 return PSA_ERROR_BAD_STATE;
5397 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005398
Gilles Peskine449bd832023-01-11 14:50:10 +01005399 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5400 operation->body_remaining != 0)) {
5401 return PSA_ERROR_INVALID_ARGUMENT;
5402 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005403
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005405}
5406
Paul Elliott302ff6b2021-04-20 18:10:30 +01005407/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005408psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
David Horstmann6db0e732023-12-11 15:35:59 +00005409 uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005410 size_t ciphertext_size,
5411 size_t *ciphertext_length,
David Horstmann6db0e732023-12-11 15:35:59 +00005412 uint8_t *tag_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005413 size_t tag_size,
5414 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005415{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005416 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5417
David Horstmann6db0e732023-12-11 15:35:59 +00005418 LOCAL_OUTPUT_DECLARE(ciphertext_external, ciphertext);
5419 LOCAL_OUTPUT_DECLARE(tag_external, tag);
5420
5421 LOCAL_OUTPUT_ALLOC(ciphertext_external, ciphertext_size, ciphertext);
5422 LOCAL_OUTPUT_ALLOC(tag_external, tag_size, tag);
5423
Paul Elliott302ff6b2021-04-20 18:10:30 +01005424 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005425 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005426
Gilles Peskine449bd832023-01-11 14:50:10 +01005427 status = psa_aead_final_checks(operation);
5428 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005429 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005431
Gilles Peskine449bd832023-01-11 14:50:10 +01005432 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005433 status = PSA_ERROR_BAD_STATE;
5434 goto exit;
5435 }
5436
Gilles Peskine449bd832023-01-11 14:50:10 +01005437 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5438 ciphertext_size,
5439 ciphertext_length,
5440 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005441
Paul Elliott39dc6b82021-05-11 19:16:09 +01005442exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005443
5444
Paul Elliottf47b0952021-05-21 18:02:33 +01005445 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005446 * the zero tag size, make sure the tag is set to something implausible.
5447 * Even if the operation succeeds, make sure we clear the rest of the
5448 * buffer to prevent potential leakage of anything previously placed in
5449 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005450 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005451
Gilles Peskine449bd832023-01-11 14:50:10 +01005452 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005453
David Horstmann6db0e732023-12-11 15:35:59 +00005454 LOCAL_OUTPUT_FREE(ciphertext_external, ciphertext);
5455 LOCAL_OUTPUT_FREE(tag_external, tag);
5456
Gilles Peskine449bd832023-01-11 14:50:10 +01005457 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005458}
5459
5460/* Finish authenticating and decrypting a message in a multipart AEAD
5461 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005462psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
David Horstmanne000a0a2023-12-11 16:37:04 +00005463 uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005464 size_t plaintext_size,
5465 size_t *plaintext_length,
David Horstmanne000a0a2023-12-11 16:37:04 +00005466 const uint8_t *tag_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005467 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005468{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005469 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5470
David Horstmanne000a0a2023-12-11 16:37:04 +00005471 LOCAL_OUTPUT_DECLARE(plaintext_external, plaintext);
5472 LOCAL_INPUT_DECLARE(tag_external, tag);
5473
5474 LOCAL_OUTPUT_ALLOC(plaintext_external, plaintext_size, plaintext);
5475 LOCAL_INPUT_ALLOC(tag_external, tag_length, tag);
5476
Paul Elliott302ff6b2021-04-20 18:10:30 +01005477 *plaintext_length = 0;
5478
Gilles Peskine449bd832023-01-11 14:50:10 +01005479 status = psa_aead_final_checks(operation);
5480 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005481 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005482 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005483
Gilles Peskine449bd832023-01-11 14:50:10 +01005484 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005485 status = PSA_ERROR_BAD_STATE;
5486 goto exit;
5487 }
5488
Gilles Peskine449bd832023-01-11 14:50:10 +01005489 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5490 plaintext_size,
5491 plaintext_length,
5492 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005493
5494exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005495 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005496
David Horstmanne000a0a2023-12-11 16:37:04 +00005497 LOCAL_OUTPUT_FREE(plaintext_external, plaintext);
5498 LOCAL_INPUT_FREE(tag_external, tag);
5499
Gilles Peskine449bd832023-01-11 14:50:10 +01005500 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005501}
5502
5503/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005504psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005505{
5506 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5507
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005509 /* The object has (apparently) been initialized but it is not (yet)
5510 * in use. It's ok to call abort on such an object, and there's
5511 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005512 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005513 }
5514
Gilles Peskine449bd832023-01-11 14:50:10 +01005515 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005516
Gilles Peskine449bd832023-01-11 14:50:10 +01005517 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005518
Gilles Peskine449bd832023-01-11 14:50:10 +01005519 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005520}
5521
Gilles Peskinee59236f2018-01-27 23:32:46 +01005522/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005523/* Generators */
5524/****************************************************************/
5525
Przemek Stekiel69c46792022-06-10 12:59:51 +02005526#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005527 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005528 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305529 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305530 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005531#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005532#endif /* At least one builtin KDF */
5533
Przemek Stekiel69c46792022-06-10 12:59:51 +02005534#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005535 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5536 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5537static psa_status_t psa_key_derivation_start_hmac(
5538 psa_mac_operation_t *operation,
5539 psa_algorithm_t hash_alg,
5540 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005541 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005542{
5543 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5544 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005545 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5546 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5547 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005548
Steven Cooreman72f736a2021-05-07 14:14:37 +02005549 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005550 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005551
Gilles Peskine449bd832023-01-11 14:50:10 +01005552 status = psa_driver_wrapper_mac_sign_setup(operation,
5553 &attributes,
5554 hmac_key, hmac_key_length,
5555 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005556
Gilles Peskine449bd832023-01-11 14:50:10 +01005557 psa_reset_key_attributes(&attributes);
5558 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005559}
5560#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005561
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005562#define HKDF_STATE_INIT 0 /* no input yet */
5563#define HKDF_STATE_STARTED 1 /* got salt */
5564#define HKDF_STATE_KEYED 2 /* got key */
5565#define HKDF_STATE_OUTPUT 3 /* output started */
5566
Gilles Peskinecbe66502019-05-16 16:59:18 +02005567static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005568 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005569{
Gilles Peskine449bd832023-01-11 14:50:10 +01005570 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5571 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5572 } else {
5573 return operation->alg;
5574 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005575}
5576
Gilles Peskine449bd832023-01-11 14:50:10 +01005577psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005578{
5579 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005580 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5581 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005582 /* The object has (apparently) been initialized but it is not
5583 * in use. It's ok to call abort on such an object, and there's
5584 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005585 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005586#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005587 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5588 mbedtls_free(operation->ctx.hkdf.info);
5589 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5590 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005591#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005592#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5593 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005594 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5595 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5596 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5597 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005598 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005599 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005600 }
5601
Gilles Peskine449bd832023-01-11 14:50:10 +01005602 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005603 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005604 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005605 }
5606
Gilles Peskine449bd832023-01-11 14:50:10 +01005607 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005608 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005609 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005610 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005611#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005612 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005613 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005614 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005615 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005616#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005617 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005618
5619 /* We leave the fields Ai and output_block to be erased safely by the
5620 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005621 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005622#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5623 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005624#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005625 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5626 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5627 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5628 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005629#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305630#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305631 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305632 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005633 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305634 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305635 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305636
5637 status = PSA_SUCCESS;
5638 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305639#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005640 {
5641 status = PSA_ERROR_BAD_STATE;
5642 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005643 mbedtls_platform_zeroize(operation, sizeof(*operation));
5644 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005645}
5646
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005647psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005648 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005649{
Gilles Peskine449bd832023-01-11 14:50:10 +01005650 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005651 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005652 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005653 }
5654
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005655 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005656 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005657}
5658
Gilles Peskine449bd832023-01-11 14:50:10 +01005659psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5660 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005661{
Gilles Peskine449bd832023-01-11 14:50:10 +01005662 if (operation->alg == 0) {
5663 return PSA_ERROR_BAD_STATE;
5664 }
5665 if (capacity > operation->capacity) {
5666 return PSA_ERROR_INVALID_ARGUMENT;
5667 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005668 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005669 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005670}
5671
Przemek Stekiel69c46792022-06-10 12:59:51 +02005672#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005673/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005674static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5675 psa_algorithm_t kdf_alg,
5676 uint8_t *output,
5677 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005678{
Gilles Peskine449bd832023-01-11 14:50:10 +01005679 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5680 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005681 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005682 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005683#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005684 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005685#else
5686 const uint8_t last_block = 0xff;
5687#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005688
Gilles Peskine449bd832023-01-11 14:50:10 +01005689 if (hkdf->state < HKDF_STATE_KEYED ||
5690 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005691#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005692 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005693#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005694 )) {
5695 return PSA_ERROR_BAD_STATE;
5696 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005697 hkdf->state = HKDF_STATE_OUTPUT;
5698
Gilles Peskine449bd832023-01-11 14:50:10 +01005699 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005700 /* Copy what remains of the current block */
5701 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005702 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005703 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005704 }
5705 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005706 output += n;
5707 output_length -= n;
5708 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005709 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005710 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005711 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005712 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005713 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005714 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005715 * object was corrupted or if this function is called directly
5716 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005717 if (hkdf->block_number == last_block) {
5718 return PSA_ERROR_BAD_STATE;
5719 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005720
5721 /* We need a new block */
5722 ++hkdf->block_number;
5723 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005724
Gilles Peskine449bd832023-01-11 14:50:10 +01005725 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5726 hash_alg,
5727 hkdf->prk,
5728 hash_length);
5729 if (status != PSA_SUCCESS) {
5730 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005731 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005732
5733 if (hkdf->block_number != 1) {
5734 status = psa_mac_update(&hkdf->hmac,
5735 hkdf->output_block,
5736 hash_length);
5737 if (status != PSA_SUCCESS) {
5738 return status;
5739 }
5740 }
5741 status = psa_mac_update(&hkdf->hmac,
5742 hkdf->info,
5743 hkdf->info_length);
5744 if (status != PSA_SUCCESS) {
5745 return status;
5746 }
5747 status = psa_mac_update(&hkdf->hmac,
5748 &hkdf->block_number, 1);
5749 if (status != PSA_SUCCESS) {
5750 return status;
5751 }
5752 status = psa_mac_sign_finish(&hkdf->hmac,
5753 hkdf->output_block,
5754 sizeof(hkdf->output_block),
5755 &hmac_output_length);
5756 if (status != PSA_SUCCESS) {
5757 return status;
5758 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005759 }
5760
Gilles Peskine449bd832023-01-11 14:50:10 +01005761 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005762}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005763#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005764
John Durkop07cc04a2020-11-16 22:08:34 -08005765#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5766 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005767static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5768 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005769 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005770{
Gilles Peskine449bd832023-01-11 14:50:10 +01005771 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5772 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005773 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5774 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005775 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005776
Janos Follath7742fee2019-06-17 12:58:10 +01005777 /* We can't be wanting more output after block 0xff, otherwise
5778 * the capacity check in psa_key_derivation_output_bytes() would have
5779 * prevented this call. It could happen only if the operation
5780 * object was corrupted or if this function is called directly
5781 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005782 if (tls12_prf->block_number == 0xff) {
5783 return PSA_ERROR_CORRUPTION_DETECTED;
5784 }
Janos Follath7742fee2019-06-17 12:58:10 +01005785
5786 /* We need a new block */
5787 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005788 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005789
5790 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5791 *
5792 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5793 *
5794 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5795 * HMAC_hash(secret, A(2) + seed) +
5796 * HMAC_hash(secret, A(3) + seed) + ...
5797 *
5798 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005799 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005800 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005801 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005802 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005803 * is currently extracted as `output_block` and where i is
5804 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005805 */
5806
Gilles Peskine449bd832023-01-11 14:50:10 +01005807 status = psa_key_derivation_start_hmac(&hmac,
5808 hash_alg,
5809 tls12_prf->secret,
5810 tls12_prf->secret_length);
5811 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005812 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005813 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005814
5815 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005816 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005817 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5818 * the variable seed and in this instance means it in the context of the
5819 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005820 status = psa_mac_update(&hmac,
5821 tls12_prf->label,
5822 tls12_prf->label_length);
5823 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005824 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005825 }
5826 status = psa_mac_update(&hmac,
5827 tls12_prf->seed,
5828 tls12_prf->seed_length);
5829 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005830 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005831 }
5832 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005833 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005834 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5835 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005836 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005837 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005838 }
5839
Gilles Peskine449bd832023-01-11 14:50:10 +01005840 status = psa_mac_sign_finish(&hmac,
5841 tls12_prf->Ai, hash_length,
5842 &hmac_output_length);
5843 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005844 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005845 }
5846 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005847 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005848 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005849
5850 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005851 status = psa_key_derivation_start_hmac(&hmac,
5852 hash_alg,
5853 tls12_prf->secret,
5854 tls12_prf->secret_length);
5855 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005856 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005857 }
5858 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5859 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005860 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005861 }
5862 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5863 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005864 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005865 }
5866 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5867 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005868 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005869 }
5870 status = psa_mac_sign_finish(&hmac,
5871 tls12_prf->output_block, hash_length,
5872 &hmac_output_length);
5873 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005874 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005875 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005876
Janos Follath7742fee2019-06-17 12:58:10 +01005877
5878cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005879 cleanup_status = psa_mac_abort(&hmac);
5880 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005881 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005883
Gilles Peskine449bd832023-01-11 14:50:10 +01005884 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005885}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005886
Janos Follath844eb0e2019-06-19 12:10:49 +01005887static psa_status_t psa_key_derivation_tls12_prf_read(
5888 psa_tls12_prf_key_derivation_t *tls12_prf,
5889 psa_algorithm_t alg,
5890 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005891 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005892{
Gilles Peskine449bd832023-01-11 14:50:10 +01005893 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5894 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005895 psa_status_t status;
5896 uint8_t offset, length;
5897
Gilles Peskine449bd832023-01-11 14:50:10 +01005898 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005899 case PSA_TLS12_PRF_STATE_LABEL_SET:
5900 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5901 break;
5902 case PSA_TLS12_PRF_STATE_OUTPUT:
5903 break;
5904 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005905 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005906 }
5907
Gilles Peskine449bd832023-01-11 14:50:10 +01005908 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005909 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005910 if (tls12_prf->left_in_block == 0) {
5911 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5912 alg);
5913 if (status != PSA_SUCCESS) {
5914 return status;
5915 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005916
5917 continue;
5918 }
5919
Gilles Peskine449bd832023-01-11 14:50:10 +01005920 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005921 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005922 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005923 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005924 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005925
5926 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005927 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005928 output += length;
5929 output_length -= length;
5930 tls12_prf->left_in_block -= length;
5931 }
5932
Gilles Peskine449bd832023-01-11 14:50:10 +01005933 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005934}
John Durkop07cc04a2020-11-16 22:08:34 -08005935#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5936 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005937
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005938#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5939static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5940 psa_tls12_ecjpake_to_pms_t *ecjpake,
5941 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005942 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005943{
5944 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005945 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005946
Gilles Peskine449bd832023-01-11 14:50:10 +01005947 if (output_length != 32) {
5948 return PSA_ERROR_INVALID_ARGUMENT;
5949 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005950
Gilles Peskine449bd832023-01-11 14:50:10 +01005951 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5952 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5953 &output_size);
5954 if (status != PSA_SUCCESS) {
5955 return status;
5956 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005957
Gilles Peskine449bd832023-01-11 14:50:10 +01005958 if (output_size != output_length) {
5959 return PSA_ERROR_GENERIC_ERROR;
5960 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005961
Gilles Peskine449bd832023-01-11 14:50:10 +01005962 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005963}
5964#endif
5965
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305966#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305967static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5968 psa_pbkdf2_key_derivation_t *pbkdf2,
5969 psa_algorithm_t prf_alg,
5970 uint8_t prf_output_length,
5971 psa_key_attributes_t *attributes)
5972{
5973 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305974 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305975 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305976 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305977 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305978 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305979 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305980
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305981 mac_operation.is_sign = 1;
5982 mac_operation.mac_size = prf_output_length;
5983 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305984
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305985 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5986 attributes,
5987 pbkdf2->password,
5988 pbkdf2->password_length,
5989 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305990 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305991 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305992 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305993 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5994 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305995 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305996 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305997 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305998 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305999 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05306000 }
6001 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
6002 &mac_output_length);
6003 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05306004 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05306005 }
6006
6007 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05306008 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05306009 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05306010 }
6011
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05306012 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306013
6014 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05306015 /* We are passing prf_output_length as mac_size because the driver
6016 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306017 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306018 status = psa_driver_wrapper_mac_compute(attributes,
6019 pbkdf2->password,
6020 pbkdf2->password_length,
6021 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05306022 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306023 &mac_output_length);
6024 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05306025 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306026 }
6027
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05306028 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306029 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05306030
6031cleanup:
6032 /* Zeroise buffers to clear sensitive data from memory. */
6033 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
6034 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306035}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05306036
6037static psa_status_t psa_key_derivation_pbkdf2_read(
6038 psa_pbkdf2_key_derivation_t *pbkdf2,
6039 psa_algorithm_t kdf_alg,
6040 uint8_t *output,
6041 size_t output_length)
6042{
6043 psa_status_t status;
6044 psa_algorithm_t prf_alg;
6045 uint8_t prf_output_length;
6046 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
6047 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
6048 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
6049
6050 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6051 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
6052 prf_output_length = PSA_HASH_LENGTH(prf_alg);
6053 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05306054 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6055 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306056 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05306057 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05306058 } else {
6059 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05306060 }
6061
6062 switch (pbkdf2->state) {
6063 case PSA_PBKDF2_STATE_PASSWORD_SET:
6064 /* Initially we need a new block so bytes_used is equal to block size*/
6065 pbkdf2->bytes_used = prf_output_length;
6066 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
6067 break;
6068 case PSA_PBKDF2_STATE_OUTPUT:
6069 break;
6070 default:
6071 return PSA_ERROR_BAD_STATE;
6072 }
6073
6074 while (output_length != 0) {
6075 uint8_t n = prf_output_length - pbkdf2->bytes_used;
6076 if (n > output_length) {
6077 n = (uint8_t) output_length;
6078 }
6079 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
6080 output += n;
6081 output_length -= n;
6082 pbkdf2->bytes_used += n;
6083
6084 if (output_length == 0) {
6085 break;
6086 }
6087
6088 /* We need a new block */
6089 pbkdf2->bytes_used = 0;
6090 pbkdf2->block_number++;
6091
6092 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
6093 prf_output_length,
6094 &attributes);
6095 if (status != PSA_SUCCESS) {
6096 return status;
6097 }
6098 }
6099
6100 return PSA_SUCCESS;
6101}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306102#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306103
Janos Follath6c6c8fc2019-06-17 12:38:20 +01006104psa_status_t psa_key_derivation_output_bytes(
6105 psa_key_derivation_operation_t *operation,
Ryan Everettf943e222024-01-19 14:46:39 +00006106 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01006107 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006108{
6109 psa_status_t status;
Ryan Everettf943e222024-01-19 14:46:39 +00006110 LOCAL_OUTPUT_DECLARE(output_external, output);
6111
Gilles Peskine449bd832023-01-11 14:50:10 +01006112 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02006113
Gilles Peskine449bd832023-01-11 14:50:10 +01006114 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006115 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006116 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006117 }
6118
Gilles Peskine449bd832023-01-11 14:50:10 +01006119 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006120 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006121 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02006122 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
6123 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006124 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02006125 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006126 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006127 }
Ryan Everettf943e222024-01-19 14:46:39 +00006128
6129 LOCAL_OUTPUT_ALLOC(output_external, output_length, output);
Ryan Everettda9227d2024-01-25 11:37:22 +00006130 if (output_length > operation->capacity) {
6131 operation->capacity = 0;
6132 /* Go through the error path to wipe all confidential data now
6133 * that the operation object is useless. */
6134 status = PSA_ERROR_INSUFFICIENT_DATA;
6135 goto exit;
6136 }
6137
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006138 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006139
Przemek Stekiel69c46792022-06-10 12:59:51 +02006140#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006141 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6142 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
6143 output, output_length);
6144 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006145#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006146#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6147 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006148 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6149 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6150 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
6151 kdf_alg, output,
6152 output_length);
6153 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006154#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
6155 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006156#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006157 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006158 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01006159 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
6160 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006161#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306162#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306163 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05306164 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
6165 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05306166 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306167#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006168
Gilles Peskineeab56e42018-07-12 17:12:33 +02006169 {
Steven Cooreman74afe472021-02-10 17:19:22 +01006170 (void) kdf_alg;
Ryan Everettf943e222024-01-19 14:46:39 +00006171 status = PSA_ERROR_BAD_STATE;
6172 LOCAL_OUTPUT_FREE(output_external, output);
6173
6174 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006175 }
6176
6177exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006178 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006179 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006180 * This allows us to differentiate between exhausted operations and
6181 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
6182 * operations. */
6183 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006184 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006185 operation->alg = alg;
Ryan Everettee5920a2024-02-09 15:09:28 +00006186 if (output != NULL) {
6187 memset(output, '!', output_length);
6188 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006189 }
Ryan Everettda9227d2024-01-25 11:37:22 +00006190
6191 LOCAL_OUTPUT_FREE(output_external, output);
Gilles Peskine449bd832023-01-11 14:50:10 +01006192 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006193}
6194
David Brown7807bf72021-02-09 16:28:23 -07006195#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006196static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02006197{
Gilles Peskine449bd832023-01-11 14:50:10 +01006198 if (data_size >= 8) {
6199 mbedtls_des_key_set_parity(data);
6200 }
6201 if (data_size >= 16) {
6202 mbedtls_des_key_set_parity(data + 8);
6203 }
6204 if (data_size >= 24) {
6205 mbedtls_des_key_set_parity(data + 16);
6206 }
Gilles Peskine08542d82018-07-19 17:05:42 +02006207}
David Brown7807bf72021-02-09 16:28:23 -07006208#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02006209
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006210/*
Gilles Peskine449bd832023-01-11 14:50:10 +01006211 * ECC keys on a Weierstrass elliptic curve require the generation
6212 * of a private key which is an integer
6213 * in the range [1, N - 1], where N is the boundary of the private key domain:
6214 * N is the prime p for Diffie-Hellman, or the order of the
6215 * curve’s base point for ECC.
6216 *
6217 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
6218 * This function generates the private key using the following process:
6219 *
6220 * 1. Draw a byte string of length ceiling(m/8) bytes.
6221 * 2. If m is not a multiple of 8, set the most significant
6222 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
6223 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
6224 * 4. If k > N - 2, discard the result and return to step 1.
6225 * 5. Output k + 1 as the private key.
6226 *
6227 * This method allows compliance to NIST standards, specifically the methods titled
6228 * Key-Pair Generation by Testing Candidates in the following publications:
6229 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
6230 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
6231 * Diffie-Hellman keys.
6232 *
6233 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
6234 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
6235 *
6236 * Note: Function allocates memory for *data buffer, so given *data should be
6237 * always NULL.
6238 */
Valerio Setti86587ab2023-06-27 13:09:30 +02006239#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
6240#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006241static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006242 psa_key_slot_t *slot,
6243 size_t bits,
6244 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006245 uint8_t **data
6246 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006247{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006248 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006249 mbedtls_mpi k;
6250 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006251 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006252 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006253 size_t m;
6254 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006255
Gilles Peskine449bd832023-01-11 14:50:10 +01006256 mbedtls_mpi_init(&k);
6257 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006258
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006259 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01006260 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006261 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01006262 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006263
Gilles Peskine449bd832023-01-11 14:50:10 +01006264 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006265 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01006266 goto cleanup;
6267 }
6268
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006269 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01006270 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006271
Gilles Peskine449bd832023-01-11 14:50:10 +01006272 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006273
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006274 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006275 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006276 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006277
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006278 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006279
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006280 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006282
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006283 /* Note: This function is always called with *data == NULL and it
6284 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006285 *data = mbedtls_calloc(1, m_bytes);
6286 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006287 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006288 goto cleanup;
6289 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006290
Gilles Peskine449bd832023-01-11 14:50:10 +01006291 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006292 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006293 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006294 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01006295 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006296
6297 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006298 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006299 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006300 * (8 * ceiling(m/8) - m) bits of the first byte in
6301 * the string to zero.
6302 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006303 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006304 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006305 }
6306
6307 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01006308 * big-endian byte string.
6309 */
6310 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006311
6312 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01006313 * Result of comparison is returned. When it indicates error
6314 * then this function is called again.
6315 */
6316 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006317 }
6318
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006319 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006320 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6321 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006322cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006323 if (ret != 0) {
6324 status = mbedtls_to_psa_error(ret);
6325 }
6326 if (status != PSA_SUCCESS) {
6327 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006328 *data = NULL;
6329 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006330 mbedtls_mpi_free(&k);
6331 mbedtls_mpi_free(&diff_N_2);
6332 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006333}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006334
6335/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6336 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6337 *
6338 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6339 * draw a 32-byte string and process it as specified in
6340 * Elliptic Curves for Security [RFC7748] §5.
6341 *
6342 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6343 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6344 *
6345 * Note: Function allocates memory for *data buffer, so given *data should be
6346 * always NULL.
6347 */
6348
6349static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6350 size_t bits,
6351 psa_key_derivation_operation_t *operation,
6352 uint8_t **data
6353 )
6354{
6355 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006356 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006357
Gilles Peskine449bd832023-01-11 14:50:10 +01006358 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006359 case 255:
6360 output_length = 32;
6361 break;
6362 case 448:
6363 output_length = 56;
6364 break;
6365 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006366 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006367 break;
6368 }
6369
Gilles Peskine449bd832023-01-11 14:50:10 +01006370 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006371
Gilles Peskine449bd832023-01-11 14:50:10 +01006372 if (*data == NULL) {
6373 return PSA_ERROR_INSUFFICIENT_MEMORY;
6374 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006375
Gilles Peskine449bd832023-01-11 14:50:10 +01006376 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006377
Gilles Peskine449bd832023-01-11 14:50:10 +01006378 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006379 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006380 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006381
Gilles Peskine449bd832023-01-11 14:50:10 +01006382 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006383 case 255:
6384 (*data)[0] &= 248;
6385 (*data)[31] &= 127;
6386 (*data)[31] |= 64;
6387 break;
6388 case 448:
6389 (*data)[0] &= 252;
6390 (*data)[55] |= 128;
6391 break;
6392 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006393 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006394 break;
6395 }
6396
6397 return status;
6398}
Valerio Setti86587ab2023-06-27 13:09:30 +02006399#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6400static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6401 psa_key_slot_t *slot, size_t bits,
6402 psa_key_derivation_operation_t *operation, uint8_t **data)
6403{
6404 (void) slot;
6405 (void) bits;
6406 (void) operation;
6407 (void) data;
6408 return PSA_ERROR_NOT_SUPPORTED;
6409}
6410
6411static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6412 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6413{
6414 (void) bits;
6415 (void) operation;
6416 (void) data;
6417 return PSA_ERROR_NOT_SUPPORTED;
6418}
6419#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6420#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006421
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006422static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006423 psa_key_slot_t *slot,
6424 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006425 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006426{
6427 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006428 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306429 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006430 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006431 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006432
Gilles Peskine449bd832023-01-11 14:50:10 +01006433 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6434 return PSA_ERROR_INVALID_ARGUMENT;
6435 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006436
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006437#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006438 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006439 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6440 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6441 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006442 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006443 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6444 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006445 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006446 }
6447 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006448 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006449 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6450 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006451 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006452 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006453 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006454 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006455#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006456 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006457 if (key_type_is_raw_bytes(slot->attr.type)) {
6458 if (bits % 8 != 0) {
6459 return PSA_ERROR_INVALID_ARGUMENT;
6460 }
6461 data = mbedtls_calloc(1, bytes);
6462 if (data == NULL) {
6463 return PSA_ERROR_INSUFFICIENT_MEMORY;
6464 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006465
Gilles Peskine449bd832023-01-11 14:50:10 +01006466 status = psa_key_derivation_output_bytes(operation, data, bytes);
6467 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006468 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006469 }
David Brown12ca5032021-02-11 11:02:00 -07006470#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006471 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6472 psa_des_set_key_parity(data, bytes);
6473 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006474#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006475 } else {
6476 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006477 }
Ronald Crondd04d422020-11-28 15:14:42 +01006478
Ronald Cronbf33c932020-11-28 18:06:53 +01006479 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006480 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006481 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006482 };
6483
Gilles Peskine449bd832023-01-11 14:50:10 +01006484 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6485 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6486 &storage_size);
6487 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306488 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006489 }
Archanad8a83dc2021-06-14 10:04:16 +05306490 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006491 status = psa_allocate_buffer_to_slot(slot, storage_size);
6492 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306493 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006494 }
Archanad8a83dc2021-06-14 10:04:16 +05306495
Gilles Peskine449bd832023-01-11 14:50:10 +01006496 status = psa_driver_wrapper_import_key(&attributes,
6497 data, bytes,
6498 slot->key.data,
6499 slot->key.bytes,
6500 &slot->key.bytes, &bits);
6501 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006502 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006503 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006504
6505exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006506 mbedtls_free(data);
6507 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006508}
6509
Gilles Peskine449bd832023-01-11 14:50:10 +01006510psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6511 psa_key_derivation_operation_t *operation,
6512 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006513{
6514 psa_status_t status;
6515 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006516 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006517
Ronald Cron81709fc2020-11-14 12:10:32 +01006518 *key = MBEDTLS_SVC_KEY_ID_INIT;
6519
Gilles Peskine0f84d622019-09-12 19:03:13 +02006520 /* Reject any attempt to create a zero-length key so that we don't
6521 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006522 if (psa_get_key_bits(attributes) == 0) {
6523 return PSA_ERROR_INVALID_ARGUMENT;
6524 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006525
Gilles Peskine449bd832023-01-11 14:50:10 +01006526 if (operation->alg == PSA_ALG_NONE) {
6527 return PSA_ERROR_BAD_STATE;
6528 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006529
Gilles Peskine449bd832023-01-11 14:50:10 +01006530 if (!operation->can_output_key) {
6531 return PSA_ERROR_NOT_PERMITTED;
6532 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006533
Gilles Peskine449bd832023-01-11 14:50:10 +01006534 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6535 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006536#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006537 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006538 /* Deriving a key in a secure element is not implemented yet. */
6539 status = PSA_ERROR_NOT_SUPPORTED;
6540 }
6541#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006542 if (status == PSA_SUCCESS) {
6543 status = psa_generate_derived_key_internal(slot,
6544 attributes->core.bits,
6545 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006546 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006547 if (status == PSA_SUCCESS) {
6548 status = psa_finish_key_creation(slot, driver, key);
6549 }
6550 if (status != PSA_SUCCESS) {
6551 psa_fail_key_creation(slot, driver);
6552 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006553
Gilles Peskine449bd832023-01-11 14:50:10 +01006554 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006555}
6556
Gilles Peskineeab56e42018-07-12 17:12:33 +02006557
6558
6559/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006560/* Key derivation */
6561/****************************************************************/
6562
Steven Cooreman932ffb72021-02-15 12:14:32 +01006563#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006564static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006565{
6566#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006567 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6568 return 1;
6569 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006570#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006571#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006572 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6573 return 1;
6574 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006575#endif
6576#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006577 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6578 return 1;
6579 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006580#endif
6581#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6583 return 1;
6584 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006585#endif
6586#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006587 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6588 return 1;
6589 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006590#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006591#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006592 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6593 return 1;
6594 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006595#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306596#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6597 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6598 return 1;
6599 }
6600#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306601#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6602 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6603 return 1;
6604 }
6605#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006606 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006607}
6608
Gilles Peskine449bd832023-01-11 14:50:10 +01006609static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006610{
6611 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006612 psa_status_t status = psa_hash_setup(&operation, alg);
6613 psa_hash_abort(&operation);
6614 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006615}
6616
Gilles Peskine969c5d62019-01-16 15:53:06 +01006617static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006618 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006619 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006620{
Janos Follath5fe19732019-06-20 15:09:30 +01006621 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6622 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006623 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006624
Gilles Peskine969c5d62019-01-16 15:53:06 +01006625 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006626 if (!is_kdf_alg_supported(kdf_alg)) {
6627 return PSA_ERROR_NOT_SUPPORTED;
6628 }
John Durkop07cc04a2020-11-16 22:08:34 -08006629
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006630 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306631 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006632 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6633 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306634 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6635 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6636 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306637 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306638 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006639 if (hash_size == 0) {
6640 return PSA_ERROR_NOT_SUPPORTED;
6641 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006642
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006643 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6644 * we might fail later, which is somewhat unfriendly and potentially
6645 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006646 psa_status_t status = psa_hash_try_support(hash_alg);
6647 if (status != PSA_SUCCESS) {
6648 return status;
6649 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006650 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006651
Gilles Peskine449bd832023-01-11 14:50:10 +01006652 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6653 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6654 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6655 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006656 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006657#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006658 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006659 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6660 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006661 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006662 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006663#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6664 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006665 operation->capacity = 255 * hash_size;
6666 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006667}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006668
Gilles Peskine449bd832023-01-11 14:50:10 +01006669static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006670{
6671#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006672 if (alg == PSA_ALG_ECDH) {
6673 return PSA_SUCCESS;
6674 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006675#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006676#if defined(PSA_WANT_ALG_FFDH)
6677 if (alg == PSA_ALG_FFDH) {
6678 return PSA_SUCCESS;
6679 }
6680#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006681 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006682 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006683}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006684
6685static int psa_key_derivation_allows_free_form_secret_input(
6686 psa_algorithm_t kdf_alg)
6687{
6688#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6689 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6690 return 0;
6691 }
6692#endif
6693 (void) kdf_alg;
6694 return 1;
6695}
John Durkop07cc04a2020-11-16 22:08:34 -08006696#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006697
Gilles Peskine449bd832023-01-11 14:50:10 +01006698psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6699 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006700{
6701 psa_status_t status;
6702
Gilles Peskine449bd832023-01-11 14:50:10 +01006703 if (operation->alg != 0) {
6704 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006705 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006706
Gilles Peskine449bd832023-01-11 14:50:10 +01006707 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6708 return PSA_ERROR_INVALID_ARGUMENT;
6709 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6710#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6711 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6712 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6713 status = psa_key_agreement_try_support(ka_alg);
6714 if (status != PSA_SUCCESS) {
6715 return status;
6716 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006717 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6718 return PSA_ERROR_INVALID_ARGUMENT;
6719 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006720 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6721#else
6722 return PSA_ERROR_NOT_SUPPORTED;
6723#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6724 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6725#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6726 status = psa_key_derivation_setup_kdf(operation, alg);
6727#else
6728 return PSA_ERROR_NOT_SUPPORTED;
6729#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6730 } else {
6731 return PSA_ERROR_INVALID_ARGUMENT;
6732 }
6733
6734 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006735 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006736 }
6737 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006738}
6739
Przemek Stekiel69c46792022-06-10 12:59:51 +02006740#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006741static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6742 psa_algorithm_t kdf_alg,
6743 psa_key_derivation_step_t step,
6744 const uint8_t *data,
6745 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006746{
Gilles Peskine449bd832023-01-11 14:50:10 +01006747 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006748 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006749 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006750 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006751#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006752 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6753 return PSA_ERROR_INVALID_ARGUMENT;
6754 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006755#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006756 if (hkdf->state != HKDF_STATE_INIT) {
6757 return PSA_ERROR_BAD_STATE;
6758 } else {
6759 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6760 hash_alg,
6761 data, data_length);
6762 if (status != PSA_SUCCESS) {
6763 return status;
6764 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006765 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006766 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006767 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006768 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006769#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006770 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006771 /* We shouldn't be in different state as HKDF_EXPAND only allows
6772 * two inputs: SECRET (this case) and INFO which does not modify
6773 * the state. It could happen only if the hkdf
6774 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006775 if (hkdf->state != HKDF_STATE_INIT) {
6776 return PSA_ERROR_BAD_STATE;
6777 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006778
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006779 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006780 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6781 return PSA_ERROR_INVALID_ARGUMENT;
6782 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006783
Gilles Peskine449bd832023-01-11 14:50:10 +01006784 memcpy(hkdf->prk, data, data_length);
6785 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006786#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006787 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006788 /* HKDF: If no salt was provided, use an empty salt.
6789 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006790 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006791#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006792 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6793 return PSA_ERROR_BAD_STATE;
6794 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006795#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006796 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6797 hash_alg,
6798 NULL, 0);
6799 if (status != PSA_SUCCESS) {
6800 return status;
6801 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006802 hkdf->state = HKDF_STATE_STARTED;
6803 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006804 if (hkdf->state != HKDF_STATE_STARTED) {
6805 return PSA_ERROR_BAD_STATE;
6806 }
6807 status = psa_mac_update(&hkdf->hmac,
6808 data, data_length);
6809 if (status != PSA_SUCCESS) {
6810 return status;
6811 }
6812 status = psa_mac_sign_finish(&hkdf->hmac,
6813 hkdf->prk,
6814 sizeof(hkdf->prk),
6815 &data_length);
6816 if (status != PSA_SUCCESS) {
6817 return status;
6818 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006819 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006820
Gilles Peskine2b522db2019-04-12 15:11:49 +02006821 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006822 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006823#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006825 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006826 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006827 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006828 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006829#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006830 {
6831 /* Block 0 is empty, and the next block will be
6832 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006833 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006834 }
6835
Gilles Peskine449bd832023-01-11 14:50:10 +01006836 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006837 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006838#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006839 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6840 return PSA_ERROR_INVALID_ARGUMENT;
6841 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006842#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006843#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006844 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6845 hkdf->state == HKDF_STATE_INIT) {
6846 return PSA_ERROR_BAD_STATE;
6847 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006848#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006849 if (hkdf->state == HKDF_STATE_OUTPUT) {
6850 return PSA_ERROR_BAD_STATE;
6851 }
6852 if (hkdf->info_set) {
6853 return PSA_ERROR_BAD_STATE;
6854 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006855 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006856 if (data_length != 0) {
6857 hkdf->info = mbedtls_calloc(1, data_length);
6858 if (hkdf->info == NULL) {
6859 return PSA_ERROR_INSUFFICIENT_MEMORY;
6860 }
6861 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006862 }
6863 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006864 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006865 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006866 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006867 }
6868}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006869#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006870
John Durkop07cc04a2020-11-16 22:08:34 -08006871#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6872 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006873static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6874 const uint8_t *data,
6875 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006876{
Gilles Peskine449bd832023-01-11 14:50:10 +01006877 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6878 return PSA_ERROR_BAD_STATE;
6879 }
Janos Follathf08e2652019-06-13 09:05:41 +01006880
Gilles Peskine449bd832023-01-11 14:50:10 +01006881 if (data_length != 0) {
6882 prf->seed = mbedtls_calloc(1, data_length);
6883 if (prf->seed == NULL) {
6884 return PSA_ERROR_INSUFFICIENT_MEMORY;
6885 }
Janos Follathf08e2652019-06-13 09:05:41 +01006886
Gilles Peskine449bd832023-01-11 14:50:10 +01006887 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006888 prf->seed_length = data_length;
6889 }
Janos Follathf08e2652019-06-13 09:05:41 +01006890
Gilles Peskine43f958b2020-12-13 14:55:14 +01006891 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006892
Gilles Peskine449bd832023-01-11 14:50:10 +01006893 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006894}
6895
Gilles Peskine449bd832023-01-11 14:50:10 +01006896static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6897 const uint8_t *data,
6898 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006899{
Gilles Peskine449bd832023-01-11 14:50:10 +01006900 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6901 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6902 return PSA_ERROR_BAD_STATE;
6903 }
Janos Follath81550542019-06-13 14:26:34 +01006904
Gilles Peskine449bd832023-01-11 14:50:10 +01006905 if (data_length != 0) {
6906 prf->secret = mbedtls_calloc(1, data_length);
6907 if (prf->secret == NULL) {
6908 return PSA_ERROR_INSUFFICIENT_MEMORY;
6909 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006910
Gilles Peskine449bd832023-01-11 14:50:10 +01006911 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006912 prf->secret_length = data_length;
6913 }
Janos Follath81550542019-06-13 14:26:34 +01006914
Gilles Peskine43f958b2020-12-13 14:55:14 +01006915 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006916
Gilles Peskine449bd832023-01-11 14:50:10 +01006917 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006918}
6919
Gilles Peskine449bd832023-01-11 14:50:10 +01006920static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6921 const uint8_t *data,
6922 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006923{
Gilles Peskine449bd832023-01-11 14:50:10 +01006924 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6925 return PSA_ERROR_BAD_STATE;
6926 }
Janos Follath63028dd2019-06-13 09:15:47 +01006927
Gilles Peskine449bd832023-01-11 14:50:10 +01006928 if (data_length != 0) {
6929 prf->label = mbedtls_calloc(1, data_length);
6930 if (prf->label == NULL) {
6931 return PSA_ERROR_INSUFFICIENT_MEMORY;
6932 }
Janos Follath63028dd2019-06-13 09:15:47 +01006933
Gilles Peskine449bd832023-01-11 14:50:10 +01006934 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006935 prf->label_length = data_length;
6936 }
Janos Follath63028dd2019-06-13 09:15:47 +01006937
Gilles Peskine43f958b2020-12-13 14:55:14 +01006938 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006939
Gilles Peskine449bd832023-01-11 14:50:10 +01006940 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006941}
6942
Gilles Peskine449bd832023-01-11 14:50:10 +01006943static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6944 psa_key_derivation_step_t step,
6945 const uint8_t *data,
6946 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006947{
Gilles Peskine449bd832023-01-11 14:50:10 +01006948 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006949 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006950 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006951 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006952 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006953 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006954 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006955 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006956 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006957 }
6958}
John Durkop07cc04a2020-11-16 22:08:34 -08006959#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6960 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6961
6962#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6963static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6964 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006965 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006966 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006967{
6968 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006969 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6970 4 + data_length + prf->other_secret_length :
6971 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006972
Gilles Peskine449bd832023-01-11 14:50:10 +01006973 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6974 return PSA_ERROR_INVALID_ARGUMENT;
6975 }
John Durkop07cc04a2020-11-16 22:08:34 -08006976
Gilles Peskine449bd832023-01-11 14:50:10 +01006977 uint8_t *pms = mbedtls_calloc(1, pms_len);
6978 if (pms == NULL) {
6979 return PSA_ERROR_INSUFFICIENT_MEMORY;
6980 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006981 uint8_t *cur = pms;
6982
6983 /* pure-PSK:
6984 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006985 *
6986 * The premaster secret is formed as follows: if the PSK is N octets
6987 * long, concatenate a uint16 with the value N, N zero octets, a second
6988 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006989 *
6990 * mixed-PSK:
6991 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6992 * follows: concatenate a uint16 with the length of the other secret,
6993 * the other secret itself, uint16 with the length of PSK, and the
6994 * PSK itself.
6995 * For details please check:
6996 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6997 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6998 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006999 */
7000
Gilles Peskine449bd832023-01-11 14:50:10 +01007001 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
7002 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
7003 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
7004 if (prf->other_secret_length != 0) {
7005 memcpy(cur, prf->other_secret, prf->other_secret_length);
7006 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02007007 cur += prf->other_secret_length;
7008 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007009 } else {
7010 *cur++ = MBEDTLS_BYTE_1(data_length);
7011 *cur++ = MBEDTLS_BYTE_0(data_length);
7012 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02007013 cur += data_length;
7014 }
7015
Gilles Peskine449bd832023-01-11 14:50:10 +01007016 *cur++ = MBEDTLS_BYTE_1(data_length);
7017 *cur++ = MBEDTLS_BYTE_0(data_length);
7018 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08007019 cur += data_length;
7020
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007021 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08007022
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01007023 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01007024 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08007025}
Janos Follath6660f0e2019-06-17 08:44:03 +01007026
Przemek Stekiele47201b2022-04-19 13:53:28 +02007027static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
7028 psa_tls12_prf_key_derivation_t *prf,
7029 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007030 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02007031{
Gilles Peskine449bd832023-01-11 14:50:10 +01007032 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
7033 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02007034 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007035
7036 if (data_length != 0) {
7037 prf->other_secret = mbedtls_calloc(1, data_length);
7038 if (prf->other_secret == NULL) {
7039 return PSA_ERROR_INSUFFICIENT_MEMORY;
7040 }
7041
7042 memcpy(prf->other_secret, data, data_length);
7043 prf->other_secret_length = data_length;
7044 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02007045 prf->other_secret_length = 0;
7046 }
7047
7048 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
7049
Gilles Peskine449bd832023-01-11 14:50:10 +01007050 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02007051}
7052
Janos Follath6660f0e2019-06-17 08:44:03 +01007053static psa_status_t psa_tls12_prf_psk_to_ms_input(
7054 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01007055 psa_key_derivation_step_t step,
7056 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007057 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01007058{
Gilles Peskine449bd832023-01-11 14:50:10 +01007059 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02007060 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007061 return psa_tls12_prf_psk_to_ms_set_key(prf,
7062 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02007063 break;
7064 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007065 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
7066 data,
7067 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02007068 break;
7069 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007070 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02007071 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01007072
Przemek Stekiele47201b2022-04-19 13:53:28 +02007073 }
Janos Follath6660f0e2019-06-17 08:44:03 +01007074}
John Durkop07cc04a2020-11-16 22:08:34 -08007075#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007076
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007077#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
7078static psa_status_t psa_tls12_ecjpake_to_pms_input(
7079 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04007080 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007081 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007082 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007083{
Gilles Peskine449bd832023-01-11 14:50:10 +01007084 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
7085 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
7086 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04007087 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007088
7089 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01007090 if (data[0] != 0x04) {
7091 return PSA_ERROR_INVALID_ARGUMENT;
7092 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007093
7094 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007095 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007096
Gilles Peskine449bd832023-01-11 14:50:10 +01007097 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007098}
7099#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307100
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307101#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307102static psa_status_t psa_pbkdf2_set_input_cost(
7103 psa_pbkdf2_key_derivation_t *pbkdf2,
7104 psa_key_derivation_step_t step,
7105 uint64_t data)
7106{
7107 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
7108 return PSA_ERROR_INVALID_ARGUMENT;
7109 }
7110
7111 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
7112 return PSA_ERROR_BAD_STATE;
7113 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307114
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05307115 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307116 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307117 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307118
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307119 if (data == 0) {
7120 return PSA_ERROR_INVALID_ARGUMENT;
7121 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05307122
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307123 pbkdf2->input_cost = data;
7124 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
7125
7126 return PSA_SUCCESS;
7127}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307128
7129static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
7130 const uint8_t *data,
7131 size_t data_length)
7132{
Gilles Peskineead17662023-08-20 22:02:51 +02007133 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
7134 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
7135 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
7136 /* Appending to existing salt. No state change. */
7137 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307138 return PSA_ERROR_BAD_STATE;
7139 }
7140
Gilles Peskineca57d782023-07-20 19:08:06 +02007141 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02007142 /* Appending an empty string, nothing to do. */
7143 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307144 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05307145
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307146 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
7147 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05307148 return PSA_ERROR_INSUFFICIENT_MEMORY;
7149 }
7150
Gilles Peskineead17662023-08-20 22:02:51 +02007151 if (pbkdf2->salt_length != 0) {
7152 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
7153 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307154 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05307155 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307156 mbedtls_free(pbkdf2->salt);
7157 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307158 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307159 return PSA_SUCCESS;
7160}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307161
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307162#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307163static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307164 const uint8_t *input,
7165 size_t input_len,
7166 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05307167 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307168{
7169 psa_status_t status = PSA_SUCCESS;
7170 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
Ryan Everett5d2e82f2024-02-07 17:24:59 +00007171 return psa_hash_compute(hash_alg, input, input_len, output,
7172 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
7173 } else if (input_len > 0) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307174 memcpy(output, input, input_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307175 }
Ryan Everett5d2e82f2024-02-07 17:24:59 +00007176 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307177 return status;
7178}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307179#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307180
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307181#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307182static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
7183 size_t input_len,
7184 uint8_t *output,
7185 size_t *output_len)
7186{
7187 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307188 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307189 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05307190 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307191 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
7192 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
7193 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307194 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05307195 * mac_size as the driver function sets mac_output_length = mac_size
7196 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307197 status = psa_driver_wrapper_mac_compute(&attributes,
7198 zeros, sizeof(zeros),
7199 PSA_ALG_CMAC, input, input_len,
7200 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307201 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
7202 128U,
7203 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307204 output_len);
7205 } else {
7206 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307207 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307208 }
7209 return status;
7210}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307211#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307212
7213static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307214 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307215 const uint8_t *data,
7216 size_t data_length)
7217{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307218 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307219 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
7220 return PSA_ERROR_BAD_STATE;
7221 }
7222
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307223#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307224 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
7225 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
7226 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
7227 pbkdf2->password,
7228 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307229 } else
7230#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
7231#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
7232 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307233 status = psa_pbkdf2_cmac_set_password(data, data_length,
7234 pbkdf2->password,
7235 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307236 } else
7237#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
7238 {
7239 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307240 }
7241
7242 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
7243
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307244 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307245}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307246
7247static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307248 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307249 psa_key_derivation_step_t step,
7250 const uint8_t *data,
7251 size_t data_length)
7252{
7253 switch (step) {
7254 case PSA_KEY_DERIVATION_INPUT_SALT:
7255 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
7256 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307257 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307258 default:
7259 return PSA_ERROR_INVALID_ARGUMENT;
7260 }
7261}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307262#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307263
Gilles Peskineb8965192019-09-24 16:21:10 +02007264/** Check whether the given key type is acceptable for the given
7265 * input step of a key derivation.
7266 *
7267 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
7268 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
7269 * Both secret and non-secret inputs can alternatively have the type
7270 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
7271 * that the input was passed as a buffer rather than via a key object.
7272 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02007273static int psa_key_derivation_check_input_type(
7274 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007275 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02007276{
Gilles Peskine449bd832023-01-11 14:50:10 +01007277 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007278 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007279 if (key_type == PSA_KEY_TYPE_DERIVE) {
7280 return PSA_SUCCESS;
7281 }
7282 if (key_type == PSA_KEY_TYPE_NONE) {
7283 return PSA_SUCCESS;
7284 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007285 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02007286 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007287 if (key_type == PSA_KEY_TYPE_DERIVE) {
7288 return PSA_SUCCESS;
7289 }
7290 if (key_type == PSA_KEY_TYPE_NONE) {
7291 return PSA_SUCCESS;
7292 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02007293 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007294 case PSA_KEY_DERIVATION_INPUT_LABEL:
7295 case PSA_KEY_DERIVATION_INPUT_SALT:
7296 case PSA_KEY_DERIVATION_INPUT_INFO:
7297 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01007298 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
7299 return PSA_SUCCESS;
7300 }
7301 if (key_type == PSA_KEY_TYPE_NONE) {
7302 return PSA_SUCCESS;
7303 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007304 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307305 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
7306 if (key_type == PSA_KEY_TYPE_PASSWORD) {
7307 return PSA_SUCCESS;
7308 }
7309 if (key_type == PSA_KEY_TYPE_DERIVE) {
7310 return PSA_SUCCESS;
7311 }
7312 if (key_type == PSA_KEY_TYPE_NONE) {
7313 return PSA_SUCCESS;
7314 }
7315 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007316 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007317 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007318}
7319
Janos Follathb80a94e2019-06-12 15:54:46 +01007320static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007321 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007322 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007323 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007324 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007325 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007326{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007327 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007328 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007329
Gilles Peskine449bd832023-01-11 14:50:10 +01007330 status = psa_key_derivation_check_input_type(step, key_type);
7331 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007332 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007333 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007334
Przemek Stekiel69c46792022-06-10 12:59:51 +02007335#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007336 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7337 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7338 step, data, data_length);
7339 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007340#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007341#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007342 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7343 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7344 step, data, data_length);
7345 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007346#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7347#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007348 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7349 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7350 step, data, data_length);
7351 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007352#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007353#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007354 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007355 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007356 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7357 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007358#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307359#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307360 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307361 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7362 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307363 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307364#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007365 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007366 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007367 (void) data;
7368 (void) data_length;
7369 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007370 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007371 }
7372
Gilles Peskine224b0d62019-09-23 18:13:17 +02007373exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007374 if (status != PSA_SUCCESS) {
7375 psa_key_derivation_abort(operation);
7376 }
7377 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007378}
7379
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307380static psa_status_t psa_key_derivation_input_integer_internal(
7381 psa_key_derivation_operation_t *operation,
7382 psa_key_derivation_step_t step,
7383 uint64_t value)
7384{
7385 psa_status_t status;
7386 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7387
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307388#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307389 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307390 status = psa_pbkdf2_set_input_cost(
7391 &operation->ctx.pbkdf2, step, value);
7392 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307393#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307394 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307395 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307396 (void) value;
7397 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307398 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307399 }
7400
7401 if (status != PSA_SUCCESS) {
7402 psa_key_derivation_abort(operation);
7403 }
7404 return status;
7405}
7406
Janos Follath51f4a0f2019-06-14 11:35:55 +01007407psa_status_t psa_key_derivation_input_bytes(
7408 psa_key_derivation_operation_t *operation,
7409 psa_key_derivation_step_t step,
Ryan Everettd1e398c2024-01-19 14:46:00 +00007410 const uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007411 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007412{
Ryan Everettd1e398c2024-01-19 14:46:00 +00007413 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7414 LOCAL_INPUT_DECLARE(data_external, data);
7415
7416 LOCAL_INPUT_ALLOC(data_external, data_length, data);
7417
7418 status = psa_key_derivation_input_internal(operation, step,
7419 PSA_KEY_TYPE_NONE,
7420 data, data_length);
Ryan Everettb41c3c92024-01-25 11:56:35 +00007421#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Ryan Everettd1e398c2024-01-19 14:46:00 +00007422exit:
Ryan Everettb41c3c92024-01-25 11:56:35 +00007423#endif
Ryan Everettd1e398c2024-01-19 14:46:00 +00007424 LOCAL_INPUT_FREE(data_external, data);
7425 return status;
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007426}
7427
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307428psa_status_t psa_key_derivation_input_integer(
7429 psa_key_derivation_operation_t *operation,
7430 psa_key_derivation_step_t step,
7431 uint64_t value)
7432{
7433 return psa_key_derivation_input_integer_internal(operation, step, value);
7434}
7435
Janos Follath51f4a0f2019-06-14 11:35:55 +01007436psa_status_t psa_key_derivation_input_key(
7437 psa_key_derivation_operation_t *operation,
7438 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007439 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007440{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007441 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007442 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007443 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007444
Ronald Cron5c522922020-11-14 16:35:34 +01007445 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007446 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7447 if (status != PSA_SUCCESS) {
7448 psa_key_derivation_abort(operation);
7449 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007450 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007451
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307452 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7453 * permission to output to a key object. */
7454 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7455 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007456 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007457 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007458
Gilles Peskine449bd832023-01-11 14:50:10 +01007459 status = psa_key_derivation_input_internal(operation,
7460 step, slot->attr.type,
7461 slot->key.data,
7462 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007463
Ryan Everett1b70a072024-01-04 10:32:49 +00007464 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007465
Gilles Peskine449bd832023-01-11 14:50:10 +01007466 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007467}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007468
7469
7470
7471/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007472/* Key agreement */
7473/****************************************************************/
7474
Gilles Peskine449bd832023-01-11 14:50:10 +01007475psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7476 const uint8_t *key_buffer,
7477 size_t key_buffer_size,
7478 psa_algorithm_t alg,
7479 const uint8_t *peer_key,
7480 size_t peer_key_length,
7481 uint8_t *shared_secret,
7482 size_t shared_secret_size,
7483 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007484{
Gilles Peskine449bd832023-01-11 14:50:10 +01007485 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007486#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007487 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007488 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7489 key_buffer_size, alg,
7490 peer_key, peer_key_length,
7491 shared_secret,
7492 shared_secret_size,
7493 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007494#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007495
7496#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7497 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007498 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007499 peer_key,
7500 peer_key_length,
7501 key_buffer,
7502 key_buffer_size,
7503 shared_secret,
7504 shared_secret_size,
7505 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007506#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7507
Gilles Peskine01d718c2018-09-18 12:01:02 +02007508 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007509 (void) attributes;
7510 (void) key_buffer;
7511 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007512 (void) peer_key;
7513 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007514 (void) shared_secret;
7515 (void) shared_secret_size;
7516 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007517 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007518 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007519}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007520
Aditya Deshpande17845b82022-10-13 17:21:01 +01007521/** Internal function for raw key agreement
7522 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007523 * to the driver's implementation if a driver is present.
7524 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007525 * (psa_key_agreement_raw_builtin).
7526 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007527static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7528 psa_key_slot_t *private_key,
7529 const uint8_t *peer_key,
7530 size_t peer_key_length,
7531 uint8_t *shared_secret,
7532 size_t shared_secret_size,
7533 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007534{
Gilles Peskine449bd832023-01-11 14:50:10 +01007535 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7536 return PSA_ERROR_NOT_SUPPORTED;
7537 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007538
7539 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007540 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007541 };
7542
Gilles Peskine449bd832023-01-11 14:50:10 +01007543 return psa_driver_wrapper_key_agreement(&attributes,
7544 private_key->key.data,
7545 private_key->key.bytes, alg,
7546 peer_key, peer_key_length,
7547 shared_secret,
7548 shared_secret_size,
7549 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007550}
7551
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007552/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007553 * to potentially free embedded data structures and wipe confidential data.
7554 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007555static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7556 psa_key_derivation_step_t step,
7557 psa_key_slot_t *private_key,
7558 const uint8_t *peer_key,
7559 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007560{
7561 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007562 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007563 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007564 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007565
7566 /* Step 1: run the secret agreement algorithm to generate the shared
7567 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007568 status = psa_key_agreement_raw_internal(ka_alg,
7569 private_key,
7570 peer_key, peer_key_length,
7571 shared_secret,
7572 sizeof(shared_secret),
7573 &shared_secret_length);
7574 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007575 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007576 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007577
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007578 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007579 * the shared secret. A shared secret is permitted wherever a key
7580 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007581 status = psa_key_derivation_input_internal(operation, step,
7582 PSA_KEY_TYPE_DERIVE,
7583 shared_secret,
7584 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007585exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007586 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7587 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007588}
7589
Gilles Peskine449bd832023-01-11 14:50:10 +01007590psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7591 psa_key_derivation_step_t step,
7592 mbedtls_svc_key_id_t private_key,
Thomas Daubney9739ac02024-02-15 13:15:47 +00007593 const uint8_t *peer_key_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007594 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007595{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007596 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007597 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007598 psa_key_slot_t *slot;
Thomas Daubney9739ac02024-02-15 13:15:47 +00007599 LOCAL_INPUT_DECLARE(peer_key_external, peer_key);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007600
Gilles Peskine449bd832023-01-11 14:50:10 +01007601 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7602 return PSA_ERROR_INVALID_ARGUMENT;
7603 }
Ronald Cron5c522922020-11-14 16:35:34 +01007604 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007605 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7606 if (status != PSA_SUCCESS) {
7607 return status;
7608 }
Thomas Daubney9739ac02024-02-15 13:15:47 +00007609
Thomas Daubney692fb3c2024-03-12 16:20:41 +00007610 LOCAL_INPUT_ALLOC(peer_key_external, peer_key_length, peer_key);
Gilles Peskine449bd832023-01-11 14:50:10 +01007611 status = psa_key_agreement_internal(operation, step,
7612 slot,
7613 peer_key, peer_key_length);
Thomas Daubney9739ac02024-02-15 13:15:47 +00007614
Thomas Daubney50f58fc2024-02-15 14:24:03 +00007615#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney9739ac02024-02-15 13:15:47 +00007616exit:
Thomas Daubney50f58fc2024-02-15 14:24:03 +00007617#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007618 if (status != PSA_SUCCESS) {
7619 psa_key_derivation_abort(operation);
7620 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007621 /* If a private key has been added as SECRET, we allow the derived
7622 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007623 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007624 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007625 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007626 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007627
Ryan Everett1b70a072024-01-04 10:32:49 +00007628 unlock_status = psa_unregister_read(slot);
Thomas Daubney9739ac02024-02-15 13:15:47 +00007629 LOCAL_INPUT_FREE(peer_key_external, peer_key);
Gilles Peskine449bd832023-01-11 14:50:10 +01007630 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007631}
7632
Gilles Peskine449bd832023-01-11 14:50:10 +01007633psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7634 mbedtls_svc_key_id_t private_key,
Thomas Daubney81899ab2024-02-15 12:57:26 +00007635 const uint8_t *peer_key_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007636 size_t peer_key_length,
Thomas Daubney81899ab2024-02-15 12:57:26 +00007637 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007638 size_t output_size,
7639 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007640{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007641 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007642 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007643 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007644 size_t expected_length;
Thomas Daubney81899ab2024-02-15 12:57:26 +00007645 LOCAL_INPUT_DECLARE(peer_key_external, peer_key);
7646 LOCAL_OUTPUT_DECLARE(output_external, output);
Thomas Daubney89d8c2a2024-02-21 11:16:16 +00007647 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007648
Gilles Peskine449bd832023-01-11 14:50:10 +01007649 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007650 status = PSA_ERROR_INVALID_ARGUMENT;
7651 goto exit;
7652 }
Ronald Cron5c522922020-11-14 16:35:34 +01007653 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007654 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7655 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007656 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007657 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007658
Gilles Peskine3e561302022-04-14 00:17:15 +02007659 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7660 * for the output size. The PSA specification only guarantees that this
7661 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7662 * but it might be nice to allow smaller buffers if the output fits.
7663 * At the time of writing this comment, with only ECDH implemented,
7664 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7665 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7666 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007667 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007668 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7669 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007670 status = PSA_ERROR_BUFFER_TOO_SMALL;
7671 goto exit;
7672 }
7673
Thomas Daubney81899ab2024-02-15 12:57:26 +00007674 LOCAL_INPUT_ALLOC(peer_key_external, peer_key_length, peer_key);
Gilles Peskine449bd832023-01-11 14:50:10 +01007675 status = psa_key_agreement_raw_internal(alg, slot,
7676 peer_key, peer_key_length,
7677 output, output_size,
7678 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007679
7680exit:
Thomas Daubney5390aca2024-02-22 11:06:04 +00007681 /* Check for successful allocation of output,
7682 * with an unsuccessful status. */
Thomas Daubney0576a6a2024-02-21 15:15:00 +00007683 if (output != NULL && status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007684 /* If an error happens and is not handled properly, the output
7685 * may be used as a key to protect sensitive data. Arrange for such
7686 * a key to be random, which is likely to result in decryption or
7687 * verification errors. This is better than filling the buffer with
7688 * some constant data such as zeros, which would result in the data
7689 * being protected with a reproducible, easily knowable key.
7690 */
David Horstmann6e99bb22024-02-06 15:27:49 +00007691 psa_generate_random_internal(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007692 *output_length = output_size;
7693 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007694
Thomas Daubney5390aca2024-02-22 11:06:04 +00007695 if (output == NULL) {
Thomas Daubney89d8c2a2024-02-21 11:16:16 +00007696 /* output allocation failed. */
7697 *output_length = 0;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007698 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007699
Ryan Everett1b70a072024-01-04 10:32:49 +00007700 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007701
Thomas Daubney81899ab2024-02-15 12:57:26 +00007702 LOCAL_INPUT_FREE(peer_key_external, peer_key);
7703 LOCAL_OUTPUT_FREE(output_external, output);
Gilles Peskine449bd832023-01-11 14:50:10 +01007704 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007705}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007706
7707
7708/****************************************************************/
7709/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007710/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007711
Gilles Peskine672a7712023-04-28 21:00:28 +02007712#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7713#include "entropy_poll.h"
7714#endif
7715
Gilles Peskine30524eb2020-11-13 17:02:26 +01007716/** Initialize the PSA random generator.
7717 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007718static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007719{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007720#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007721 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007722#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7723
Gilles Peskine30524eb2020-11-13 17:02:26 +01007724 /* Set default configuration if
7725 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007726 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007727 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007728 }
7729 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007730 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007731 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007732
Gilles Peskine449bd832023-01-11 14:50:10 +01007733 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007734#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7735 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7736 /* The PSA entropy injection feature depends on using NV seed as an entropy
7737 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007738 mbedtls_entropy_add_source(&rng->entropy,
7739 mbedtls_nv_seed_poll, NULL,
7740 MBEDTLS_ENTROPY_BLOCK_SIZE,
7741 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007742#endif
7743
Gilles Peskine449bd832023-01-11 14:50:10 +01007744 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007745#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007746}
7747
7748/** Deinitialize the PSA random generator.
7749 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007750static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007751{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007752#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007753 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007754#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine449bd832023-01-11 14:50:10 +01007755 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7756 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007757#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007758}
7759
7760/** Seed the PSA random generator.
7761 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007762static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007763{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007764#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7765 /* Do nothing: the external RNG seeds itself. */
7766 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007767 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007768#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007769 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007770 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7771 drbg_seed, sizeof(drbg_seed) - 1);
7772 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007773#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007774}
7775
David Horstmann6e99bb22024-02-06 15:27:49 +00007776psa_status_t psa_generate_random(uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007777 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007778{
David Horstmann6e99bb22024-02-06 15:27:49 +00007779 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007780
David Horstmann6e99bb22024-02-06 15:27:49 +00007781 LOCAL_OUTPUT_DECLARE(output_external, output);
7782 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007783
David Horstmann6e99bb22024-02-06 15:27:49 +00007784 status = psa_generate_random_internal(output, output_size);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007785
David Horstmanne097bbd2024-02-28 14:17:10 +00007786#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
David Horstmann6e99bb22024-02-06 15:27:49 +00007787exit:
David Horstmanne097bbd2024-02-28 14:17:10 +00007788#endif
David Horstmann6e99bb22024-02-06 15:27:49 +00007789 LOCAL_OUTPUT_FREE(output_external, output);
7790 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007791}
7792
Gilles Peskine8814fc42020-12-14 15:33:44 +01007793/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007794 *
7795 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7796 * `psa_generate_random(...)`. The state parameter is ignored since the
7797 * PSA API doesn't support passing an explicit state.
7798 *
7799 * In the non-external case, psa_generate_random() calls an
7800 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7801 * and semantics as mbedtls_psa_get_random(). As an optimization,
7802 * instead of doing this back-and-forth between the PSA API and the
7803 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7804 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007805 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007806#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7807int mbedtls_psa_get_random(void *p_rng,
7808 unsigned char *output,
7809 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007810{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007811 /* This function takes a pointer to the RNG state because that's what
7812 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7813 * its own state internally and doesn't let the caller access that state.
7814 * So we just ignore the state parameter, and in practice we'll pass
7815 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007816 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007817 psa_status_t status = psa_generate_random(output, output_size);
7818 if (status == PSA_SUCCESS) {
7819 return 0;
7820 } else {
7821 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7822 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007823}
7824#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7825
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007826#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007827psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7828 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007829{
Gilles Peskine449bd832023-01-11 14:50:10 +01007830 if (global_data.initialized) {
7831 return PSA_ERROR_NOT_PERMITTED;
7832 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007833
Gilles Peskine449bd832023-01-11 14:50:10 +01007834 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7835 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7836 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7837 return PSA_ERROR_INVALID_ARGUMENT;
7838 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007839
Gilles Peskine449bd832023-01-11 14:50:10 +01007840 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007841}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007842#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007843
Ronald Cron3772afe2021-02-08 16:10:05 +01007844/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007845 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007846 * \param type The key type
7847 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007848 *
7849 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007850 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007851 * \retval #PSA_ERROR_INVALID_ARGUMENT
7852 * The size in bits of the key is not valid.
7853 * \retval #PSA_ERROR_NOT_SUPPORTED
7854 * The type and/or the size in bits of the key or the combination of
7855 * the two is not supported.
7856 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007857static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007858 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007859{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007860 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007861
Gilles Peskine449bd832023-01-11 14:50:10 +01007862 if (key_type_is_raw_bytes(type)) {
7863 status = psa_validate_unstructured_key_bit_size(type, bits);
7864 if (status != PSA_SUCCESS) {
7865 return status;
7866 }
7867 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007868#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007869 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7870 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7871 return PSA_ERROR_NOT_SUPPORTED;
7872 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007873 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007874 return PSA_ERROR_NOT_SUPPORTED;
7875 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007876
Ronald Cron01b2aba2020-10-05 09:42:02 +02007877 /* Accept only byte-aligned keys, for the same reasons as
7878 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007879 if (bits % 8 != 0) {
7880 return PSA_ERROR_NOT_SUPPORTED;
7881 }
7882 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007883#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007884
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007885#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007886 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007887 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007888 return PSA_SUCCESS;
7889 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007890#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007891
Valerio Settia55f0422023-07-10 15:34:41 +02007892#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007893 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007894 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007895 return PSA_ERROR_NOT_SUPPORTED;
7896 }
7897 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007898#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007899 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007900 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007901 }
7902
Gilles Peskine449bd832023-01-11 14:50:10 +01007903 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007904}
7905
Ronald Cron55ed0592020-10-05 10:30:40 +02007906psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007907 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007908 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007909{
7910 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007911 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007912
Gilles Peskine449bd832023-01-11 14:50:10 +01007913 if ((attributes->domain_parameters == NULL) &&
7914 (attributes->domain_parameters_size != 0)) {
7915 return PSA_ERROR_INVALID_ARGUMENT;
7916 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007917
Gilles Peskine449bd832023-01-11 14:50:10 +01007918 if (key_type_is_raw_bytes(type)) {
7919 status = psa_generate_random(key_buffer, key_buffer_size);
7920 if (status != PSA_SUCCESS) {
7921 return status;
7922 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007923
David Brown12ca5032021-02-11 11:02:00 -07007924#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007925 if (type == PSA_KEY_TYPE_DES) {
7926 psa_des_set_key_parity(key_buffer, key_buffer_size);
7927 }
David Brown8107e312021-02-12 08:08:46 -07007928#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007929 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007930
Valerio Setti76df8c12023-07-11 14:11:28 +02007931#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007932 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7933 return mbedtls_psa_rsa_generate_key(attributes,
7934 key_buffer,
7935 key_buffer_size,
7936 key_buffer_length);
7937 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007938#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007939
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007940#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007941 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7942 return mbedtls_psa_ecp_generate_key(attributes,
7943 key_buffer,
7944 key_buffer_size,
7945 key_buffer_length);
7946 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007947#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007948
Valerio Settia55f0422023-07-10 15:34:41 +02007949#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007950 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7951 return mbedtls_psa_ffdh_generate_key(attributes,
7952 key_buffer,
7953 key_buffer_size,
7954 key_buffer_length);
7955 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007956#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007957 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007958 (void) key_buffer_length;
7959 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007960 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007961
Gilles Peskine449bd832023-01-11 14:50:10 +01007962 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007963}
Darryl Green0c6575a2018-11-07 16:05:30 +00007964
Gilles Peskine449bd832023-01-11 14:50:10 +01007965psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7966 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007967{
7968 psa_status_t status;
7969 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007970 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007971 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007972
Ronald Cron81709fc2020-11-14 12:10:32 +01007973 *key = MBEDTLS_SVC_KEY_ID_INIT;
7974
Gilles Peskine0f84d622019-09-12 19:03:13 +02007975 /* Reject any attempt to create a zero-length key so that we don't
7976 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007977 if (psa_get_key_bits(attributes) == 0) {
7978 return PSA_ERROR_INVALID_ARGUMENT;
7979 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007980
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007981 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007982 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7983 return PSA_ERROR_INVALID_ARGUMENT;
7984 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007985
Gilles Peskine449bd832023-01-11 14:50:10 +01007986 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7987 &slot, &driver);
7988 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007989 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007990 }
Gilles Peskine11792082019-08-06 18:36:36 +02007991
Ronald Cron977c2472020-10-13 08:32:21 +02007992 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307993 * storage ( thus not in the case of generating a key in a secure element
7994 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7995 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007996 if (slot->key.data == NULL) {
7997 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7998 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007999 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01008000 attributes->core.type, attributes->core.bits);
8001 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01008002 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008003 }
Ronald Cron3772afe2021-02-08 16:10:05 +01008004
8005 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01008006 attributes->core.type,
8007 attributes->core.bits);
8008 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02008009 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01008010 attributes, &key_buffer_size);
8011 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01008012 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008013 }
Ronald Cron977c2472020-10-13 08:32:21 +02008014 }
Ronald Cron977c2472020-10-13 08:32:21 +02008015
Gilles Peskine449bd832023-01-11 14:50:10 +01008016 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
8017 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02008018 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008019 }
Ronald Cron977c2472020-10-13 08:32:21 +02008020 }
8021
Gilles Peskine449bd832023-01-11 14:50:10 +01008022 status = psa_driver_wrapper_generate_key(attributes,
8023 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02008024
Gilles Peskine449bd832023-01-11 14:50:10 +01008025 if (status != PSA_SUCCESS) {
8026 psa_remove_key_data_from_memory(slot);
8027 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02008028
Gilles Peskine11792082019-08-06 18:36:36 +02008029exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008030 if (status == PSA_SUCCESS) {
8031 status = psa_finish_key_creation(slot, driver, key);
8032 }
8033 if (status != PSA_SUCCESS) {
8034 psa_fail_key_creation(slot, driver);
8035 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02008036
Gilles Peskine449bd832023-01-11 14:50:10 +01008037 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008038}
8039
Gilles Peskinee59236f2018-01-27 23:32:46 +01008040/****************************************************************/
8041/* Module setup */
8042/****************************************************************/
8043
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01008044#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01008045psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01008046 void (* entropy_init)(mbedtls_entropy_context *ctx),
8047 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01008048{
Gilles Peskine449bd832023-01-11 14:50:10 +01008049 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
8050 return PSA_ERROR_BAD_STATE;
8051 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01008052 global_data.rng.entropy_init = entropy_init;
8053 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01008054 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01008055}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01008056#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01008057
Gilles Peskine449bd832023-01-11 14:50:10 +01008058void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01008059{
Gilles Peskine449bd832023-01-11 14:50:10 +01008060 psa_wipe_all_key_slots();
8061 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
8062 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01008063 }
8064 /* Wipe all remaining data, including configuration.
8065 * In particular, this sets all state indicator to the value
8066 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01008067 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02008068
8069 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01008070 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01008071}
8072
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008073#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
8074/** Recover a transaction that was interrupted by a power failure.
8075 *
8076 * This function is called during initialization, before psa_crypto_init()
8077 * returns. If this function returns a failure status, the initialization
8078 * fails.
8079 */
8080static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01008081 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008082{
Gilles Peskine449bd832023-01-11 14:50:10 +01008083 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008084 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
8085 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008086 /* TODO - fall through to the failure case until this
8087 * is implemented.
8088 * https://github.com/ARMmbed/mbed-crypto/issues/218
8089 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008090 default:
8091 /* We found an unsupported transaction in the storage.
8092 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008093 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008094 }
8095}
8096#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
8097
Gilles Peskine449bd832023-01-11 14:50:10 +01008098psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01008099{
Gilles Peskine66fb1262018-12-10 16:29:04 +01008100 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008101
Gilles Peskinec6b69072018-11-20 21:42:52 +01008102 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008103 if (global_data.initialized != 0) {
8104 return PSA_SUCCESS;
8105 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01008106
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01008107 /* Init drivers */
8108 status = psa_driver_wrapper_init();
8109 if (status != PSA_SUCCESS) {
8110 goto exit;
8111 }
8112 global_data.drivers_initialized = 1;
8113
Valerio Setti402cfba2023-11-13 10:24:32 +01008114 status = psa_initialize_key_slots();
8115 if (status != PSA_SUCCESS) {
8116 goto exit;
8117 }
8118
Gilles Peskine30524eb2020-11-13 17:02:26 +01008119 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008120 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01008121 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008122 status = mbedtls_psa_random_seed(&global_data.rng);
8123 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01008124 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008125 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01008126 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008127
Gilles Peskine4b734222019-07-24 15:56:31 +02008128#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008129 status = psa_crypto_load_transaction();
8130 if (status == PSA_SUCCESS) {
8131 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
8132 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008133 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008134 }
8135 status = psa_crypto_stop_transaction();
8136 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02008137 /* There's no transaction to complete. It's all good. */
8138 status = PSA_SUCCESS;
8139 }
Gilles Peskine4b734222019-07-24 15:56:31 +02008140#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02008141
Gilles Peskinec6b69072018-11-20 21:42:52 +01008142 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01008143 global_data.initialized = 1;
8144
8145exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008146 if (status != PSA_SUCCESS) {
8147 mbedtls_psa_crypto_free();
8148 }
8149 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008150}
8151
Yanray Wangffc3c482023-07-11 12:01:04 +08008152#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008153psa_status_t psa_crypto_driver_pake_get_password_len(
8154 const psa_crypto_driver_pake_inputs_t *inputs,
8155 size_t *password_len)
8156{
8157 if (inputs->password_len == 0) {
8158 return PSA_ERROR_BAD_STATE;
8159 }
8160
8161 *password_len = inputs->password_len;
8162
8163 return PSA_SUCCESS;
8164}
8165
8166psa_status_t psa_crypto_driver_pake_get_password(
8167 const psa_crypto_driver_pake_inputs_t *inputs,
8168 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
8169{
8170 if (inputs->password_len == 0) {
8171 return PSA_ERROR_BAD_STATE;
8172 }
8173
8174 if (buffer_size < inputs->password_len) {
8175 return PSA_ERROR_BUFFER_TOO_SMALL;
8176 }
8177
8178 memcpy(buffer, inputs->password, inputs->password_len);
8179 *buffer_length = inputs->password_len;
8180
8181 return PSA_SUCCESS;
8182}
8183
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008184psa_status_t psa_crypto_driver_pake_get_user_len(
8185 const psa_crypto_driver_pake_inputs_t *inputs,
8186 size_t *user_len)
8187{
8188 if (inputs->user_len == 0) {
8189 return PSA_ERROR_BAD_STATE;
8190 }
8191
8192 *user_len = inputs->user_len;
8193
8194 return PSA_SUCCESS;
8195}
8196
8197psa_status_t psa_crypto_driver_pake_get_user(
8198 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008199 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008200{
8201 if (inputs->user_len == 0) {
8202 return PSA_ERROR_BAD_STATE;
8203 }
8204
Przemek Stekielc0e62502023-03-14 11:49:36 +01008205 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008206 return PSA_ERROR_BUFFER_TOO_SMALL;
8207 }
8208
Przemek Stekielc0e62502023-03-14 11:49:36 +01008209 memcpy(user_id, inputs->user, inputs->user_len);
8210 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008211
8212 return PSA_SUCCESS;
8213}
8214
8215psa_status_t psa_crypto_driver_pake_get_peer_len(
8216 const psa_crypto_driver_pake_inputs_t *inputs,
8217 size_t *peer_len)
8218{
8219 if (inputs->peer_len == 0) {
8220 return PSA_ERROR_BAD_STATE;
8221 }
8222
8223 *peer_len = inputs->peer_len;
8224
8225 return PSA_SUCCESS;
8226}
8227
8228psa_status_t psa_crypto_driver_pake_get_peer(
8229 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008230 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008231{
8232 if (inputs->peer_len == 0) {
8233 return PSA_ERROR_BAD_STATE;
8234 }
8235
Przemek Stekielc0e62502023-03-14 11:49:36 +01008236 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008237 return PSA_ERROR_BUFFER_TOO_SMALL;
8238 }
8239
Przemek Stekielc0e62502023-03-14 11:49:36 +01008240 memcpy(peer_id, inputs->peer, inputs->peer_len);
8241 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008242
8243 return PSA_SUCCESS;
8244}
8245
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008246psa_status_t psa_crypto_driver_pake_get_cipher_suite(
8247 const psa_crypto_driver_pake_inputs_t *inputs,
8248 psa_pake_cipher_suite_t *cipher_suite)
8249{
8250 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
8251 return PSA_ERROR_BAD_STATE;
8252 }
8253
8254 *cipher_suite = inputs->cipher_suite;
8255
8256 return PSA_SUCCESS;
8257}
8258
Neil Armstronga7d08c32022-06-01 18:21:20 +02008259psa_status_t psa_pake_setup(
8260 psa_pake_operation_t *operation,
8261 const psa_pake_cipher_suite_t *cipher_suite)
8262{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008263 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008264
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008265 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008266 status = PSA_ERROR_BAD_STATE;
8267 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008268 }
8269
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008270 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01008271 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008272 status = PSA_ERROR_INVALID_ARGUMENT;
8273 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008274 }
8275
Przemek Stekiel51eac532022-12-07 11:04:51 +01008276 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
8277
Przemek Stekiele12ed362022-12-21 12:54:46 +01008278 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01008279 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
8280 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008281 operation->data.inputs.cipher_suite = *cipher_suite;
8282
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008283#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008284 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008285 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01008286 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008287
David Horstmann16f01512023-06-14 17:21:07 +01008288 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01008289 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008290 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008291#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008292 {
8293 status = PSA_ERROR_NOT_SUPPORTED;
8294 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008295 }
8296
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008297 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
8298
Przemek Stekiel51eac532022-12-07 11:04:51 +01008299 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008300exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008301 psa_pake_abort(operation);
8302 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008303}
8304
8305psa_status_t psa_pake_set_password_key(
8306 psa_pake_operation_t *operation,
8307 mbedtls_svc_key_id_t password)
8308{
Neil Armstrong5ae60962022-09-15 11:29:46 +02008309 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01008310 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
8311 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008312 psa_key_attributes_t attributes;
8313 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008314
Przemek Stekiel51eac532022-12-07 11:04:51 +01008315 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008316 status = PSA_ERROR_BAD_STATE;
8317 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008318 }
8319
Przemek Stekiel6c764412022-11-22 14:05:12 +01008320 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
8321 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008322 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008323 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008324 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008325 }
8326
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008327 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01008328 .core = slot->attr
8329 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02008330
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008331 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008332
Przemek Stekiel51eac532022-12-07 11:04:51 +01008333 if (type != PSA_KEY_TYPE_PASSWORD &&
8334 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8335 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008336 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008337 }
8338
Przemek Stekiel51eac532022-12-07 11:04:51 +01008339 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8340 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008341 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008342 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008343 }
8344
8345 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8346 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01008347 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008348exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008349 if (status != PSA_SUCCESS) {
8350 psa_pake_abort(operation);
8351 }
Ryan Everett1b70a072024-01-04 10:32:49 +00008352 unlock_status = psa_unregister_read(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008353 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008354}
8355
8356psa_status_t psa_pake_set_user(
8357 psa_pake_operation_t *operation,
David Horstmann4f534ae2024-01-22 17:35:59 +00008358 const uint8_t *user_id_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008359 size_t user_id_len)
8360{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008361 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
David Horstmann4f534ae2024-01-22 17:35:59 +00008362 LOCAL_INPUT_DECLARE(user_id_external, user_id);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008363
8364 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008365 status = PSA_ERROR_BAD_STATE;
8366 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008367 }
8368
Przemek Stekiel51eac532022-12-07 11:04:51 +01008369 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008370 status = PSA_ERROR_INVALID_ARGUMENT;
8371 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008372 }
8373
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008374 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008375 status = PSA_ERROR_BAD_STATE;
8376 goto exit;
8377 }
8378
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008379 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8380 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008381 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8382 goto exit;
8383 }
8384
David Horstmann4f534ae2024-01-22 17:35:59 +00008385 LOCAL_INPUT_ALLOC(user_id_external, user_id_len, user_id);
8386
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008387 memcpy(operation->data.inputs.user, user_id, user_id_len);
8388 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008389
David Horstmann4f534ae2024-01-22 17:35:59 +00008390 status = PSA_SUCCESS;
8391
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008392exit:
David Horstmann4f534ae2024-01-22 17:35:59 +00008393 LOCAL_INPUT_FREE(user_id_external, user_id);
8394 if (status != PSA_SUCCESS) {
8395 psa_pake_abort(operation);
8396 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008397 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008398}
8399
8400psa_status_t psa_pake_set_peer(
8401 psa_pake_operation_t *operation,
David Horstmann4f534ae2024-01-22 17:35:59 +00008402 const uint8_t *peer_id_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008403 size_t peer_id_len)
8404{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008405 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
David Horstmann4f534ae2024-01-22 17:35:59 +00008406 LOCAL_INPUT_DECLARE(peer_id_external, peer_id);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008407
8408 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008409 status = PSA_ERROR_BAD_STATE;
8410 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008411 }
8412
Przemek Stekiel51eac532022-12-07 11:04:51 +01008413 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008414 status = PSA_ERROR_INVALID_ARGUMENT;
8415 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008416 }
8417
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008418 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008419 status = PSA_ERROR_BAD_STATE;
8420 goto exit;
8421 }
8422
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008423 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8424 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008425 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8426 goto exit;
8427 }
8428
David Horstmann4f534ae2024-01-22 17:35:59 +00008429 LOCAL_INPUT_ALLOC(peer_id_external, peer_id_len, peer_id);
8430
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008431 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8432 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008433
David Horstmann4f534ae2024-01-22 17:35:59 +00008434 status = PSA_SUCCESS;
8435
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008436exit:
David Horstmann4f534ae2024-01-22 17:35:59 +00008437 LOCAL_INPUT_FREE(peer_id_external, peer_id);
8438 if (status != PSA_SUCCESS) {
8439 psa_pake_abort(operation);
8440 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008441 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008442}
8443
8444psa_status_t psa_pake_set_role(
8445 psa_pake_operation_t *operation,
8446 psa_pake_role_t role)
8447{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008448 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008449
Przemek Stekiel51eac532022-12-07 11:04:51 +01008450 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008451 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008452 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008453 }
8454
Przemek Stekiel09104b82023-03-06 14:11:51 +01008455 switch (operation->alg) {
8456#if defined(PSA_WANT_ALG_JPAKE)
8457 case PSA_ALG_JPAKE:
8458 if (role == PSA_PAKE_ROLE_NONE) {
8459 return PSA_SUCCESS;
8460 }
8461 status = PSA_ERROR_INVALID_ARGUMENT;
8462 break;
8463#endif
8464 default:
8465 (void) role;
8466 status = PSA_ERROR_NOT_SUPPORTED;
8467 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008468 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008469exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008470 psa_pake_abort(operation);
8471 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008472}
8473
David Horstmanne7f21e62023-05-12 18:17:21 +01008474/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008475#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008476static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008477 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008478{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008479 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008480 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008481 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008482
David Horstmann024e5c52023-06-14 15:48:21 +01008483 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008484 is_x1 = (stage->outputs < 1);
8485 } else {
8486 is_x1 = (stage->inputs < 1);
8487 }
8488
David Horstmann74a3d8c2023-06-14 18:28:19 +01008489 key_share_step = is_x1 ?
8490 PSA_JPAKE_X1_STEP_KEY_SHARE :
8491 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008492 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008493 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8494 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8495 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8496 } else {
8497 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008498 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008499 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008500}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008501#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008502
Przemek Stekiel2797d372022-12-22 11:19:22 +01008503static psa_status_t psa_pake_complete_inputs(
8504 psa_pake_operation_t *operation)
8505{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008506 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008507 /* Create copy of the inputs on stack as inputs share memory
8508 with the driver context which will be setup by the driver. */
8509 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008510
Przemek Stekielfde11282023-03-13 16:06:09 +01008511 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008512 return PSA_ERROR_BAD_STATE;
8513 }
8514
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008515 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008516 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8517 return PSA_ERROR_BAD_STATE;
8518 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008519 }
8520
Przemek Stekiel18620a32023-01-17 16:34:52 +01008521 /* Clear driver context */
8522 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8523
8524 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008525
8526 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008527 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008528
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008529 /* User and peer are translated to role. */
8530 mbedtls_free(inputs.user);
8531 mbedtls_free(inputs.peer);
8532
Przemek Stekiel2797d372022-12-22 11:19:22 +01008533 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008534#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008535 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008536 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008537 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008538#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008539 {
8540 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008541 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008542 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008543 return status;
8544}
8545
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008546#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008547static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008548 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008549 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008550 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008551{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008552 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8553 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8554 step != PSA_PAKE_STEP_ZK_PROOF) {
8555 return PSA_ERROR_INVALID_ARGUMENT;
8556 }
8557
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008558 psa_jpake_computation_stage_t *computation_stage =
8559 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008560
David Horstmann5da95602023-06-08 15:37:12 +01008561 if (computation_stage->round != PSA_JPAKE_FIRST &&
8562 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008563 return PSA_ERROR_BAD_STATE;
8564 }
8565
David Horstmanne7f21e62023-05-12 18:17:21 +01008566 /* Check that the step we are given is the one we were expecting */
8567 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008568 return PSA_ERROR_BAD_STATE;
8569 }
8570
David Horstmanne7f21e62023-05-12 18:17:21 +01008571 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8572 computation_stage->inputs == 0 &&
8573 computation_stage->outputs == 0) {
8574 /* Start of the round, so function decides whether we are inputting
8575 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008576 computation_stage->io_mode = io_mode;
8577 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008578 /* Middle of the round so the mode we are in must match the function
8579 * called by the user */
8580 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008581 }
8582
8583 return PSA_SUCCESS;
8584}
8585
David Horstmanne7f21e62023-05-12 18:17:21 +01008586static psa_status_t psa_jpake_epilogue(
8587 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008588 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008589{
David Horstmanne7f21e62023-05-12 18:17:21 +01008590 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008591 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008592
David Horstmanne7f21e62023-05-12 18:17:21 +01008593 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8594 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008595 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008596 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008597 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008598 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008599 }
8600 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008601 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008602 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008603 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008604 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008605 }
8606 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008607 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8608 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008609 /* End of a round, move to the next round */
8610 stage->inputs = 0;
8611 stage->outputs = 0;
8612 stage->round++;
8613 }
8614 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008615 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008616 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008617 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008618 return PSA_SUCCESS;
8619}
David Horstmanne7f21e62023-05-12 18:17:21 +01008620
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008621#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008622
Neil Armstronga7d08c32022-06-01 18:21:20 +02008623psa_status_t psa_pake_output(
8624 psa_pake_operation_t *operation,
8625 psa_pake_step_t step,
David Horstmannc75639d2024-01-22 17:56:39 +00008626 uint8_t *output_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008627 size_t output_size,
8628 size_t *output_length)
8629{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008630 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008631 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
David Horstmannc75639d2024-01-22 17:56:39 +00008632 LOCAL_OUTPUT_DECLARE(output_external, output);
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008633 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008634
8635 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008636 status = psa_pake_complete_inputs(operation);
8637 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008638 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008639 }
8640 }
8641
8642 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008643 status = PSA_ERROR_BAD_STATE;
8644 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008645 }
8646
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008647 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008648 status = PSA_ERROR_INVALID_ARGUMENT;
8649 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008650 }
8651
Przemek Stekiele12ed362022-12-21 12:54:46 +01008652 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008653#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008654 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008655 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008656 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008657 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008658 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008659 driver_step = convert_jpake_computation_stage_to_driver_step(
8660 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008661 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008662#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008663 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008664 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008665 status = PSA_ERROR_NOT_SUPPORTED;
8666 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008667 }
8668
David Horstmannc75639d2024-01-22 17:56:39 +00008669 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
8670
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008671 status = psa_driver_wrapper_pake_output(operation, driver_step,
8672 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008673
8674 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008675 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008676 }
8677
8678 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008679#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008680 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008681 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008682 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008683 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008684 }
8685 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008686#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008687 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008688 status = PSA_ERROR_NOT_SUPPORTED;
8689 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008690 }
8691
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008692exit:
David Horstmannc75639d2024-01-22 17:56:39 +00008693 LOCAL_OUTPUT_FREE(output_external, output);
8694 if (status != PSA_SUCCESS) {
8695 psa_pake_abort(operation);
8696 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008697 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008698}
8699
8700psa_status_t psa_pake_input(
8701 psa_pake_operation_t *operation,
8702 psa_pake_step_t step,
David Horstmannc75639d2024-01-22 17:56:39 +00008703 const uint8_t *input_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008704 size_t input_length)
8705{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008706 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008707 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008708 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8709 operation->primitive,
8710 step);
David Horstmannc75639d2024-01-22 17:56:39 +00008711 LOCAL_INPUT_DECLARE(input_external, input);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008712
8713 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008714 status = psa_pake_complete_inputs(operation);
8715 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008716 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008717 }
8718 }
8719
8720 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008721 status = PSA_ERROR_BAD_STATE;
8722 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008723 }
8724
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008725 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008726 status = PSA_ERROR_INVALID_ARGUMENT;
8727 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008728 }
8729
Przemek Stekiele12ed362022-12-21 12:54:46 +01008730 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008731#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008732 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008733 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008734 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008735 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008736 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008737 driver_step = convert_jpake_computation_stage_to_driver_step(
8738 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008739 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008740#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008741 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008742 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008743 status = PSA_ERROR_NOT_SUPPORTED;
8744 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008745 }
8746
David Horstmannc75639d2024-01-22 17:56:39 +00008747 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008748 status = psa_driver_wrapper_pake_input(operation, driver_step,
8749 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008750
8751 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008752 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008753 }
8754
8755 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008756#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008757 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008758 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008759 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008760 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008761 }
8762 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008763#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008764 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008765 status = PSA_ERROR_NOT_SUPPORTED;
8766 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008767 }
8768
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008769exit:
David Horstmannc75639d2024-01-22 17:56:39 +00008770 LOCAL_INPUT_FREE(input_external, input);
8771 if (status != PSA_SUCCESS) {
8772 psa_pake_abort(operation);
8773 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008774 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008775}
8776
8777psa_status_t psa_pake_get_implicit_key(
8778 psa_pake_operation_t *operation,
8779 psa_key_derivation_operation_t *output)
8780{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008781 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008782 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008783 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008784 size_t shared_key_len = 0;
8785
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008786 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008787 status = PSA_ERROR_BAD_STATE;
8788 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008789 }
8790
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008791#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008792 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008793 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008794 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008795 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008796 status = PSA_ERROR_BAD_STATE;
8797 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008798 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008799 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008800#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008801 {
8802 status = PSA_ERROR_NOT_SUPPORTED;
8803 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008804 }
8805
Przemek Stekiel0c781802022-11-29 14:53:13 +01008806 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8807 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008808 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008809 &shared_key_len);
8810
8811 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008812 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008813 }
8814
8815 status = psa_key_derivation_input_bytes(output,
8816 PSA_KEY_DERIVATION_INPUT_SECRET,
8817 shared_key,
8818 shared_key_len);
8819
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008820 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008821exit:
8822 abort_status = psa_pake_abort(operation);
8823 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008824}
8825
8826psa_status_t psa_pake_abort(
8827 psa_pake_operation_t *operation)
8828{
Przemek Stekield69dca92023-01-31 19:59:20 +01008829 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008830
Przemek Stekield69dca92023-01-31 19:59:20 +01008831 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008832 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008833 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008834
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008835 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8836 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008837 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008838 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008839 }
8840 if (operation->data.inputs.user != NULL) {
8841 mbedtls_free(operation->data.inputs.user);
8842 }
8843 if (operation->data.inputs.peer != NULL) {
8844 mbedtls_free(operation->data.inputs.peer);
8845 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008846 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008847 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008848
Przemek Stekield69dca92023-01-31 19:59:20 +01008849 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008850}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008851#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008852
David Horstmann00d7a042023-12-07 18:39:17 +00008853/* Memory copying test hooks. These are called before input copy, after input
8854 * copy, before output copy and after output copy, respectively.
8855 * They are used by memory-poisoning tests to temporarily unpoison buffers
8856 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00008857#if defined(MBEDTLS_TEST_HOOKS)
8858void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8859void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8860void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8861void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8862#endif
David Horstmannfde97392023-10-30 20:29:43 +00008863
David Horstmann1b7279a2023-11-15 15:18:30 +00008864/** Copy from an input buffer to a local copy.
8865 *
8866 * \param[in] input Pointer to input buffer.
8867 * \param[in] input_len Length of the input buffer.
8868 * \param[out] input_copy Pointer to a local copy in which to store the input data.
8869 * \param[out] input_copy_len Length of the local copy buffer.
8870 * \return #PSA_SUCCESS, if the buffer was successfully
8871 * copied.
8872 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
8873 * copy is too small to hold contents of the
8874 * input buffer.
8875 */
8876MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00008877psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
8878 uint8_t *input_copy, size_t input_copy_len)
8879{
8880 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00008881 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00008882 }
8883
David Horstmann372b8bb2023-11-24 16:21:04 +00008884#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008885 if (psa_input_pre_copy_hook != NULL) {
8886 psa_input_pre_copy_hook(input, input_len);
8887 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008888#endif
8889
David Horstmann777e7412023-11-15 17:33:47 +00008890 if (input_len > 0) {
8891 memcpy(input_copy, input, input_len);
8892 }
David Horstmannfde97392023-10-30 20:29:43 +00008893
David Horstmann372b8bb2023-11-24 16:21:04 +00008894#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008895 if (psa_input_post_copy_hook != NULL) {
8896 psa_input_post_copy_hook(input, input_len);
8897 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008898#endif
8899
David Horstmannfde97392023-10-30 20:29:43 +00008900 return PSA_SUCCESS;
8901}
8902
David Horstmann1b7279a2023-11-15 15:18:30 +00008903/** Copy from a local output buffer into a user-supplied one.
8904 *
8905 * \param[in] output_copy Pointer to a local buffer containing the output.
8906 * \param[in] output_copy_len Length of the local buffer.
8907 * \param[out] output Pointer to user-supplied output buffer.
8908 * \param[out] output_len Length of the user-supplied output buffer.
8909 * \return #PSA_SUCCESS, if the buffer was successfully
8910 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00008911 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00008912 * user-supplied output buffer is too small to
8913 * hold the contents of the local buffer.
8914 */
8915MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00008916psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
8917 uint8_t *output, size_t output_len)
8918{
8919 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00008920 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00008921 }
David Horstmann777e7412023-11-15 17:33:47 +00008922
David Horstmann372b8bb2023-11-24 16:21:04 +00008923#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008924 if (psa_output_pre_copy_hook != NULL) {
8925 psa_output_pre_copy_hook(output, output_len);
8926 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008927#endif
8928
David Horstmann777e7412023-11-15 17:33:47 +00008929 if (output_copy_len > 0) {
8930 memcpy(output, output_copy, output_copy_len);
8931 }
8932
David Horstmann372b8bb2023-11-24 16:21:04 +00008933#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008934 if (psa_output_post_copy_hook != NULL) {
8935 psa_output_post_copy_hook(output, output_len);
8936 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008937#endif
8938
David Horstmann8978f5c2023-10-30 20:37:12 +00008939 return PSA_SUCCESS;
8940}
8941
David Horstmannf1734052023-11-20 17:15:32 +00008942psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
8943 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00008944{
8945 psa_status_t status;
8946
David Horstmann9db14482023-11-23 15:50:37 +00008947 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00008948
David Horstmannc5cc1c32023-11-15 18:11:26 +00008949 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00008950 return PSA_SUCCESS;
8951 }
8952
David Horstmannf1734052023-11-20 17:15:32 +00008953 local_input->buffer = mbedtls_calloc(input_len, 1);
8954 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00008955 /* Since we dealt with the zero-length case above, we know that
8956 * a NULL return value means a failure of allocation. */
8957 return PSA_ERROR_INSUFFICIENT_MEMORY;
8958 }
David Horstmannf1734052023-11-20 17:15:32 +00008959 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00008960
David Horstmannf1734052023-11-20 17:15:32 +00008961 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00008962
8963 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00008964 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00008965 if (status != PSA_SUCCESS) {
8966 goto error;
8967 }
8968
8969 return PSA_SUCCESS;
8970
8971error:
David Horstmannf1734052023-11-20 17:15:32 +00008972 mbedtls_free(local_input->buffer);
8973 local_input->buffer = NULL;
8974 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00008975 return status;
8976}
8977
David Horstmannf1734052023-11-20 17:15:32 +00008978void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00008979{
David Horstmannf1734052023-11-20 17:15:32 +00008980 mbedtls_free(local_input->buffer);
8981 local_input->buffer = NULL;
8982 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00008983}
8984
David Horstmann89875a42023-11-20 12:54:09 +00008985psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
8986 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00008987{
David Horstmann9db14482023-11-23 15:50:37 +00008988 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00008989
David Horstmannc5cc1c32023-11-15 18:11:26 +00008990 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008991 return PSA_SUCCESS;
8992 }
David Horstmann89875a42023-11-20 12:54:09 +00008993 local_output->buffer = mbedtls_calloc(output_len, 1);
8994 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008995 /* Since we dealt with the zero-length case above, we know that
8996 * a NULL return value means a failure of allocation. */
8997 return PSA_ERROR_INSUFFICIENT_MEMORY;
8998 }
David Horstmann89875a42023-11-20 12:54:09 +00008999 local_output->length = output_len;
9000 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00009001
9002 return PSA_SUCCESS;
9003}
9004
David Horstmann89875a42023-11-20 12:54:09 +00009005psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00009006{
David Horstmannc335a4e2023-11-15 15:57:32 +00009007 psa_status_t status;
9008
David Horstmann89875a42023-11-20 12:54:09 +00009009 if (local_output->buffer == NULL) {
9010 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00009011 return PSA_SUCCESS;
9012 }
David Horstmann89875a42023-11-20 12:54:09 +00009013 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00009014 /* We have an internal copy but nothing to copy back to. */
9015 return PSA_ERROR_CORRUPTION_DETECTED;
9016 }
9017
David Horstmann89875a42023-11-20 12:54:09 +00009018 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
9019 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00009020 if (status != PSA_SUCCESS) {
9021 return status;
9022 }
David Horstmann9467ea32023-11-08 17:44:18 +00009023
David Horstmann89875a42023-11-20 12:54:09 +00009024 mbedtls_free(local_output->buffer);
9025 local_output->buffer = NULL;
9026 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00009027
9028 return PSA_SUCCESS;
9029}
9030
Gilles Peskinee59236f2018-01-27 23:32:46 +01009031#endif /* MBEDTLS_PSA_CRYPTO_C */