blob: 331a5f1aee929073029cc44991bcca523ca898cc [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;
220#define LOCAL_OUTPUT_FREE(output, output_copy) \
221 output_copy = NULL;
David Horstmann513101b2023-11-29 17:24:08 +0000222#endif /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
David Horstmanne9a88ab2023-11-29 17:07:13 +0000223
224
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100225int psa_can_do_hash(psa_algorithm_t hash_alg)
226{
227 (void) hash_alg;
228 return global_data.drivers_initialized;
229}
Valerio Settic6f004f2023-12-12 11:27:36 +0100230
Valerio Setti1fff4f22023-12-28 14:19:34 +0100231int psa_can_do_cipher(psa_key_type_t key_type, psa_algorithm_t cipher_alg)
Valerio Settic6f004f2023-12-12 11:27:36 +0100232{
Valerio Setti1fff4f22023-12-28 14:19:34 +0100233 (void) key_type;
Valerio Settic6f004f2023-12-12 11:27:36 +0100234 (void) cipher_alg;
235 return global_data.drivers_initialized;
236}
237
238
Valerio Settia55f0422023-07-10 15:34:41 +0200239#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel53410502023-04-28 13:18:43 +0200240 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) || \
Valerio Settia55f0422023-07-10 15:34:41 +0200241 defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekiel134cc2e2023-05-05 10:13:37 +0200242static int psa_is_dh_key_size_valid(size_t bits)
243{
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200244 if (bits != 2048 && bits != 3072 && bits != 4096 &&
245 bits != 6144 && bits != 8192) {
246 return 0;
247 }
248
249 return 1;
250}
Valerio Settia55f0422023-07-10 15:34:41 +0200251#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT ||
Przemek Stekiel53410502023-04-28 13:18:43 +0200252 MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY ||
Valerio Settia55f0422023-07-10 15:34:41 +0200253 PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE */
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100254
Gilles Peskine449bd832023-01-11 14:50:10 +0100255psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100256{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100257 /* Mbed TLS error codes can combine a high-level error code and a
258 * low-level error code. The low-level error usually reflects the
259 * root cause better, so dispatch on that preferably. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100260 int low_level_ret = -(-ret & 0x007f);
261 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100262 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100263 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100264
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100265#if defined(MBEDTLS_AES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100266 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
267 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100268 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman09a9e582023-08-31 11:05:22 +0100269 case MBEDTLS_ERR_AES_BAD_INPUT_DATA:
270 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100271#endif
272
273#if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_ASN1_WRITE_C)
Gilles Peskine9a944802018-06-21 09:35:35 +0200274 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
275 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
276 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
277 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
278 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100279 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200280 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100281 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200282 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100283 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100284#endif
Gilles Peskine9a944802018-06-21 09:35:35 +0200285
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100286#if defined(MBEDTLS_CAMELLIA_C)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000287 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Gilles Peskinea5905292018-02-07 20:59:33 +0100288 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100290#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100291
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100292#if defined(MBEDTLS_CCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100293 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100294 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100295 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100296 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100297#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100298
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100299#if defined(MBEDTLS_CHACHA20_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200300 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100302#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200303
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100304#if defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200305 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100306 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200307 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100308 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100309#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200310
Dave Rodgman509b5672023-08-16 19:26:23 +0100311#if defined(MBEDTLS_CIPHER_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100312 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100313 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100314 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100315 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100316 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100317 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100318 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100319 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100320 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100321 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100322 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100324 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100325 return PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100326#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100327
Gilles Peskine449bd832023-01-11 14:50:10 +0100328#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
329 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100330 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
331 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100332 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100334 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
335 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100336 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100337 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100338 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100339#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100340
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100341#if defined(MBEDTLS_DES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100342 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100343 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100344#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100345
Gilles Peskinee59236f2018-01-27 23:32:46 +0100346 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
347 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
348 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100350
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100351#if defined(MBEDTLS_GCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100352 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 return PSA_ERROR_INVALID_SIGNATURE;
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200354 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100356 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100358#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100359
Gilles Peskine82e57d12020-11-13 21:31:17 +0100360#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100361 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100362 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
363 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100364 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100366 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
367 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100369 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100370 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100371#endif
372
Dave Rodgmandea266f2023-08-31 11:52:43 +0100373#if defined(MBEDTLS_MD_LIGHT)
Gilles Peskinea5905292018-02-07 20:59:33 +0100374 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100375 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100376 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100377 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100378 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100379 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100380#if defined(MBEDTLS_FS_IO)
Gilles Peskinea5905292018-02-07 20:59:33 +0100381 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100382 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100383#endif
384#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100385
Dave Rodgman509b5672023-08-16 19:26:23 +0100386#if defined(MBEDTLS_BIGNUM_C)
387#if defined(MBEDTLS_FS_IO)
Gilles Peskinef76aa772018-10-29 19:24:33 +0100388 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100389 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100390#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100391 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100392 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100393 case MBEDTLS_ERR_MPI_INVALID_CHARACTER:
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_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100396 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100397 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100398 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100399 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
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_NOT_ACCEPTABLE:
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_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100405#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100406
Dave Rodgman509b5672023-08-16 19:26:23 +0100407#if defined(MBEDTLS_PK_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100408 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100409 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100410 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
411 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100412 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100413#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) || defined(MBEDTLS_FS_IO) || \
414 defined(MBEDTLS_PSA_ITS_FILE_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100415 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100416 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100417#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100418 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
419 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100421 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100422 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100423 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
424 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100425 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100426 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100427 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100428 case MBEDTLS_ERR_PK_INVALID_ALG:
429 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
430 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100431 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100432 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100433 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200434 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100435 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100436#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100437
Gilles Peskineff2d2002019-05-06 15:26:23 +0200438 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100439 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200440 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100441 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200442
Dave Rodgman509b5672023-08-16 19:26:23 +0100443#if defined(MBEDTLS_RSA_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100444 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100445 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100446 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100447 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100448 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100449 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100450 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100451 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100452 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
453 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100454 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100455 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100456 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100457 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100459 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100460 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100461#endif
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200462
Dave Rodgman1dab4452023-09-01 09:59:51 +0100463#if defined(MBEDTLS_ECP_LIGHT)
itayzafrir5c753392018-05-08 11:18:38 +0300464 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300465 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100466 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300467 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100468 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300469 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100470 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300471 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
472 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100473 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300474 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100476 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100477 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100478
Dave Rodgman509b5672023-08-16 19:26:23 +0100479#if defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +0000480 case MBEDTLS_ERR_ECP_IN_PROGRESS:
481 return PSA_OPERATION_INCOMPLETE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100482#endif
483#endif
Paul Elliott588f8ed2022-12-02 18:10:26 +0000484
Janos Follatha13b9052019-11-22 12:48:59 +0000485 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100486 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300487
Gilles Peskinee59236f2018-01-27 23:32:46 +0100488 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100489 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100490 }
491}
492
Paul Elliottdc42ca82023-02-24 18:11:59 +0000493/**
494 * \brief For output buffers which contain "tags"
495 * (outputs that may be checked for validity like
496 * hashes, MACs and signatures), fill the unused
497 * part of the output buffer (the whole buffer on
498 * error, the trailing part on success) with
499 * something that isn't a valid tag (barring an
500 * attack on the tag and deliberately-crafted
501 * input), in case the caller doesn't check the
502 * return status properly.
503 *
504 * \param output_buffer Pointer to buffer to wipe. May not be NULL
505 * unless \p output_buffer_size is zero.
506 * \param status Status of function called to generate
507 * output_buffer originally
508 * \param output_buffer_size Size of output buffer. If zero, \p output_buffer
509 * could be NULL.
510 * \param output_buffer_length Length of data written to output_buffer, must be
511 * less than \p output_buffer_size
512 */
513static void psa_wipe_tag_output_buffer(uint8_t *output_buffer, psa_status_t status,
Paul Elliott7118d172023-02-26 16:57:05 +0000514 size_t output_buffer_size, size_t output_buffer_length)
515{
Paul Elliottdc42ca82023-02-24 18:11:59 +0000516 size_t offset = 0;
517
518 if (output_buffer_size == 0) {
519 /* If output_buffer_size is 0 then we have nothing to do. We must not
520 call memset because output_buffer may be NULL in this case */
521 return;
522 }
523
524 if (status == PSA_SUCCESS) {
525 offset = output_buffer_length;
526 }
527
528 memset(output_buffer + offset, '!', output_buffer_size - offset);
529}
530
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200531
Gilles Peskine449bd832023-01-11 14:50:10 +0100532psa_status_t psa_validate_unstructured_key_bit_size(psa_key_type_t type,
533 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200534{
535 /* Check that the bit size is acceptable for the key type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100536 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200537 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200538 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200539 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200540 case PSA_KEY_TYPE_PASSWORD:
541 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200542 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100543#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200544 case PSA_KEY_TYPE_AES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100545 if (bits != 128 && bits != 192 && bits != 256) {
546 return PSA_ERROR_INVALID_ARGUMENT;
547 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200548 break;
549#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200550#if defined(PSA_WANT_KEY_TYPE_ARIA)
551 case PSA_KEY_TYPE_ARIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 if (bits != 128 && bits != 192 && bits != 256) {
553 return PSA_ERROR_INVALID_ARGUMENT;
554 }
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200555 break;
556#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100557#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200558 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100559 if (bits != 128 && bits != 192 && bits != 256) {
560 return PSA_ERROR_INVALID_ARGUMENT;
561 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200562 break;
563#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100564#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200565 case PSA_KEY_TYPE_DES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100566 if (bits != 64 && bits != 128 && bits != 192) {
567 return PSA_ERROR_INVALID_ARGUMENT;
568 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200569 break;
570#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100571#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200572 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 if (bits != 256) {
574 return PSA_ERROR_INVALID_ARGUMENT;
575 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200576 break;
577#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200578 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200580 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100581 if (bits % 8 != 0) {
582 return PSA_ERROR_INVALID_ARGUMENT;
583 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200584
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200586}
587
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100588/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100589 *
Steven Cooremancd640932021-03-08 12:00:27 +0100590 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
591 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100592 *
593 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100594 * \param[in] key_type The key type of the key to be used with the
595 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100596 *
597 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100598 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100599 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100600 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100601 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100602MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100603 psa_algorithm_t algorithm,
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100605{
Gilles Peskine449bd832023-01-11 14:50:10 +0100606 if (PSA_ALG_IS_HMAC(algorithm)) {
607 if (key_type == PSA_KEY_TYPE_HMAC) {
608 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100609 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100610 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100611
Gilles Peskine449bd832023-01-11 14:50:10 +0100612 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
613 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
614 * key. */
615 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
616 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
617 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
618 * the block length (larger than 1) for block ciphers. */
619 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
620 return PSA_SUCCESS;
621 }
622 }
623 }
624
625 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100626}
627
Gilles Peskine449bd832023-01-11 14:50:10 +0100628psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
629 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200630{
Gilles Peskine449bd832023-01-11 14:50:10 +0100631 if (slot->key.data != NULL) {
632 return PSA_ERROR_ALREADY_EXISTS;
633 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200634
Gilles Peskine449bd832023-01-11 14:50:10 +0100635 slot->key.data = mbedtls_calloc(1, buffer_length);
636 if (slot->key.data == NULL) {
637 return PSA_ERROR_INSUFFICIENT_MEMORY;
638 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200639
Ronald Cronea0f8a62020-11-25 17:52:23 +0100640 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100641 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200642}
643
Gilles Peskine449bd832023-01-11 14:50:10 +0100644psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
645 const uint8_t *data,
646 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200647{
Gilles Peskine449bd832023-01-11 14:50:10 +0100648 psa_status_t status = psa_allocate_buffer_to_slot(slot,
649 data_length);
650 if (status != PSA_SUCCESS) {
651 return status;
652 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200653
Gilles Peskine449bd832023-01-11 14:50:10 +0100654 memcpy(slot->key.data, data, data_length);
655 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200656}
657
Ronald Crona0fe59f2020-11-29 11:14:53 +0100658psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100659 const psa_key_attributes_t *attributes,
660 const uint8_t *data, size_t data_length,
661 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100662 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100663{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100664 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
665 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100666
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200667 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100668 if (data_length == 0) {
669 return PSA_ERROR_NOT_SUPPORTED;
670 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200671
Gilles Peskine449bd832023-01-11 14:50:10 +0100672 if (key_type_is_raw_bytes(type)) {
673 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200674
Gilles Peskine449bd832023-01-11 14:50:10 +0100675 status = psa_validate_unstructured_key_bit_size(attributes->core.type,
676 *bits);
677 if (status != PSA_SUCCESS) {
678 return status;
679 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200680
Ronald Crondd04d422020-11-28 15:14:42 +0100681 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100682 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100683 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200685
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 return PSA_SUCCESS;
687 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +0200688#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200689 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100690 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200691 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100692 return PSA_ERROR_INVALID_ARGUMENT;
693 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200694 return mbedtls_psa_ffdh_import_key(attributes,
695 data, data_length,
696 key_buffer, key_buffer_size,
697 key_buffer_length,
698 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100699 }
Valerio Settia55f0422023-07-10 15:34:41 +0200700#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200701 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti27c501a2023-06-27 16:58:52 +0200702#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100703 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
704 if (PSA_KEY_TYPE_IS_ECC(type)) {
705 return mbedtls_psa_ecp_import_key(attributes,
706 data, data_length,
707 key_buffer, key_buffer_size,
708 key_buffer_length,
709 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100710 }
Valerio Setti27c501a2023-06-27 16:58:52 +0200711#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800712 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settife478902023-07-25 12:27:19 +0200713#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
714 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100715 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
716 if (PSA_KEY_TYPE_IS_RSA(type)) {
717 return mbedtls_psa_rsa_import_key(attributes,
718 data, data_length,
719 key_buffer, key_buffer_size,
720 key_buffer_length,
721 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200722 }
Valerio Settife478902023-07-25 12:27:19 +0200723#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
724 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -0800725 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100726 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100727
Gilles Peskine449bd832023-01-11 14:50:10 +0100728 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100729}
730
Gilles Peskinef603c712019-01-19 13:40:11 +0100731/** Calculate the intersection of two algorithm usage policies.
732 *
733 * Return 0 (which allows no operation) on incompatibility.
734 */
735static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100736 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100737 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100738 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100739{
Gilles Peskine549ea862019-05-22 11:45:59 +0200740 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100741 if (alg1 == alg2) {
742 return alg1;
743 }
Steven Cooreman03488022021-02-18 12:07:20 +0100744 /* If the policies are from the same hash-and-sign family, check
745 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100746 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
747 PSA_ALG_IS_SIGN_HASH(alg2) &&
748 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
749 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
750 return alg2;
751 }
752 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
753 return alg1;
754 }
Steven Cooreman03488022021-02-18 12:07:20 +0100755 }
756 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100757 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100758 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100759 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
760 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
761 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
762 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
763 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100764 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100765
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100766 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100767 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
768 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
769 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
770 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100771 }
772 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100773 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
774 (alg1_len <= alg2_len)) {
775 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100776 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100777 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
778 (alg2_len <= alg1_len)) {
779 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100780 }
781 }
782 /* If the policies are from the same MAC family, check whether one
783 * of them is a minimum-MAC-length policy. Calculate the most
784 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100785 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
786 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
787 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100788 /* Validate the combination of key type and algorithm. Since the base
789 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
791 return 0;
792 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100793
Steven Cooreman31a876d2021-03-03 20:47:40 +0100794 /* Get the (exact or at-least) output lengths for both sides of the
795 * requested intersection. None of the currently supported algorithms
796 * have an output length dependent on the actual key size, so setting it
797 * to a bogus value of 0 is currently OK.
798 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100799 * Note that for at-least-this-length wildcard algorithms, the output
800 * length is set to the shortest allowed length, which allows us to
801 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100802 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
803 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100804 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100805
Steven Cooremana1d83222021-02-25 10:20:29 +0100806 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100807 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
808 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
809 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100810 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100811
812 /* If only one is an at-least-this-length policy, the intersection would
813 * be the other (fixed-length) policy as long as said fixed length is
814 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100815 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
816 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +0100817 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100818 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
819 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100820 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100821
Steven Cooremancd640932021-03-08 12:00:27 +0100822 /* If none of them are wildcards, check whether they define the same tag
823 * length. This is still possible here when one is default-length and
824 * the other specific-length. Ensure to always return the
825 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100826 if (alg1_len == alg2_len) {
827 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
828 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100829 }
830 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100831 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +0100832}
833
Gilles Peskine449bd832023-01-11 14:50:10 +0100834static int psa_key_algorithm_permits(psa_key_type_t key_type,
835 psa_algorithm_t policy_alg,
836 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +0200837{
Gilles Peskine549ea862019-05-22 11:45:59 +0200838 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100839 if (requested_alg == policy_alg) {
840 return 1;
841 }
Steven Cooreman03488022021-02-18 12:07:20 +0100842 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
843 * and requested_alg is the same hash-and-sign family with any hash,
844 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100845 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
846 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
847 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
848 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +0100849 }
850 /* If policy_alg is a wildcard AEAD algorithm of the same base as
851 * the requested algorithm, check the requested tag length to be
852 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100853 if (PSA_ALG_IS_AEAD(policy_alg) &&
854 PSA_ALG_IS_AEAD(requested_alg) &&
855 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
856 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
857 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
858 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
859 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +0100860 }
Steven Cooremancd640932021-03-08 12:00:27 +0100861 /* If policy_alg is a MAC algorithm of the same base as the requested
862 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100863 if (PSA_ALG_IS_MAC(policy_alg) &&
864 PSA_ALG_IS_MAC(requested_alg) &&
865 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
866 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100867 /* Validate the combination of key type and algorithm. Since the policy
868 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100869 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
870 return 0;
871 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100872
Steven Cooreman31a876d2021-03-03 20:47:40 +0100873 /* Get both the requested output length for the algorithm which is to be
874 * verified, and the default output length for the base algorithm.
875 * Note that none of the currently supported algorithms have an output
876 * length dependent on actual key size, so setting it to a bogus value
877 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100878 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100879 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100880 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +0100881 key_type, 0,
882 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100883
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100884 /* If the policy is default-length, only allow an algorithm with
885 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100886 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
887 return requested_output_length == default_output_length;
888 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100889
890 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +0100891 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100892 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
893 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
894 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100895 }
896
Steven Cooremancd640932021-03-08 12:00:27 +0100897 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
898 * check for the requested MAC length to be equal to or longer than the
899 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100900 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
901 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
902 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100903 }
Gilles Peskined6f371b2019-05-10 19:33:38 +0200904 }
Steven Cooremance48e852020-10-05 16:02:45 +0200905 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +0200906 * a key derivation with that key agreement should also be allowed. This
907 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100908 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
909 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
910 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
911 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +0200912 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100913 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100914 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200915}
916
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100917/** Test whether a policy permits an algorithm.
918 *
919 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +0100920 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100921 * \note This function requires providing the key type for which the policy is
922 * being validated, since some algorithm policy definitions (e.g. MAC)
923 * have different properties depending on what kind of cipher it is
924 * combined with.
925 *
Steven Cooreman7e39f052021-02-23 14:18:32 +0100926 * \retval PSA_SUCCESS When \p alg is a specific algorithm
927 * allowed by the \p policy.
928 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
929 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
930 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100931 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100932static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
933 psa_key_type_t key_type,
934 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100935{
Steven Cooremand788fab2021-02-25 11:29:17 +0100936 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +0100937 if (alg == 0) {
938 return PSA_ERROR_INVALID_ARGUMENT;
939 }
Steven Cooremand788fab2021-02-25 11:29:17 +0100940
Steven Cooreman7e39f052021-02-23 14:18:32 +0100941 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100942 if (PSA_ALG_IS_WILDCARD(alg)) {
943 return PSA_ERROR_INVALID_ARGUMENT;
944 }
Steven Cooreman7e39f052021-02-23 14:18:32 +0100945
Gilles Peskine449bd832023-01-11 14:50:10 +0100946 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
947 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
948 return PSA_SUCCESS;
949 } else {
950 return PSA_ERROR_NOT_PERMITTED;
951 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +0100952}
953
Gilles Peskinef603c712019-01-19 13:40:11 +0100954/** Restrict a key policy based on a constraint.
955 *
Steven Cooreman5a172672021-03-02 21:27:42 +0100956 * \note This function requires providing the key type for which the policy is
957 * being restricted, since some algorithm policy definitions (e.g. MAC)
958 * have different properties depending on what kind of cipher it is
959 * combined with.
960 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100961 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +0100962 * \param[in,out] policy The policy to restrict.
963 * \param[in] constraint The policy constraint to apply.
964 *
965 * \retval #PSA_SUCCESS
966 * \c *policy contains the intersection of the original value of
967 * \c *policy and \c *constraint.
968 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100969 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +0100970 * \c *policy is unchanged.
971 */
972static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100973 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100974 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +0100975 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +0100976{
977 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +0100978 psa_key_policy_algorithm_intersection(key_type, policy->alg,
979 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +0200980 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +0100981 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
982 constraint->alg2);
983 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
984 return PSA_ERROR_INVALID_ARGUMENT;
985 }
986 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
987 return PSA_ERROR_INVALID_ARGUMENT;
988 }
Gilles Peskinef603c712019-01-19 13:40:11 +0100989 policy->usage &= constraint->usage;
990 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +0200991 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100992 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +0100993}
994
Przemek Stekiel061f6942022-11-30 10:51:35 +0100995/** Get the description of a key given its identifier and policy constraints
996 * and lock it.
997 *
998 * The key must have allow all the usage flags set in \p usage. If \p alg is
999 * nonzero, the key must allow operations with this algorithm. If \p alg is
1000 * zero, the algorithm is not checked.
1001 *
1002 * In case of a persistent key, the function loads the description of the key
1003 * into a key slot if not already done.
1004 *
Ryan Everett098c6652024-01-03 13:03:36 +00001005 * On success, the returned key slot has been registered for reading.
1006 * It is the responsibility of the caller to call psa_unregister_read(slot)
1007 * when they have finished reading the contents of the slot.
Przemek Stekiel061f6942022-11-30 10:51:35 +01001008 */
1009static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01001010 mbedtls_svc_key_id_t key,
1011 psa_key_slot_t **p_slot,
1012 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +01001014{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001015 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01001016 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001017
Gilles Peskine449bd832023-01-11 14:50:10 +01001018 status = psa_get_and_lock_key_slot(key, p_slot);
1019 if (status != PSA_SUCCESS) {
1020 return status;
1021 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001022 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001023
1024 /* Enforce that usage policy for the key slot contains all the flags
1025 * required by the usage parameter. There is one exception: public
1026 * keys can always be exported, so we treat public key objects as
1027 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +01001029 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001030 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001031
Gilles Peskine449bd832023-01-11 14:50:10 +01001032 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +01001033 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001034 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001035 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001036
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001037 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001038 if (alg != 0) {
1039 status = psa_key_policy_permits(&slot->attr.policy,
1040 slot->attr.type,
1041 alg);
1042 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +01001043 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001044 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001045 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001046
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001048
1049error:
1050 *p_slot = NULL;
Ryan Everett098c6652024-01-03 13:03:36 +00001051 psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001052
Gilles Peskine449bd832023-01-11 14:50:10 +01001053 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +01001054}
Darryl Green940d72c2018-07-13 13:18:51 +01001055
Ronald Cron5c522922020-11-14 16:35:34 +01001056/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001057 *
1058 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +02001059 * available, as opposed to a key in a secure element and/or to be used
1060 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001061 *
Ronald Cronddae0f52021-08-24 15:39:44 +02001062 * This is a temporary function that may be used instead of
1063 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
1064 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001065 *
Ryan Everett098c6652024-01-03 13:03:36 +00001066 * On success, the returned key slot has been registered for reading.
1067 * It is the responsibility of the caller to call psa_unregister_read(slot)
1068 * when they have finished reading the contents of the slot.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001069 */
Ronald Cron5c522922020-11-14 16:35:34 +01001070static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1071 mbedtls_svc_key_id_t key,
1072 psa_key_slot_t **p_slot,
1073 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +02001075{
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
1077 usage, alg);
1078 if (status != PSA_SUCCESS) {
1079 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001080 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001081
Gilles Peskine449bd832023-01-11 14:50:10 +01001082 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
Ryan Everett098c6652024-01-03 13:03:36 +00001083 psa_unregister_read(*p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 *p_slot = NULL;
1085 return PSA_ERROR_NOT_SUPPORTED;
1086 }
1087
1088 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001089}
Gilles Peskine28f8f302019-07-24 13:30:31 +02001090
Gilles Peskine449bd832023-01-11 14:50:10 +01001091psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +00001092{
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +01001094 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001096
Ronald Cronea0f8a62020-11-25 17:52:23 +01001097 slot->key.data = NULL;
1098 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001099
Gilles Peskine449bd832023-01-11 14:50:10 +01001100 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001101}
1102
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001103/** Completely wipe a slot in memory, including its policy.
1104 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001105psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001106{
Gilles Peskine449bd832023-01-11 14:50:10 +01001107 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001108
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 /*
1110 * As the return error code may not be handled in case of multiple errors,
Ryan Everett7ed542e2024-01-17 11:39:09 +00001111 * do our best to report an unexpected amount of registered readers or
1112 * an unexpected state.
1113 * Assert with MBEDTLS_TEST_HOOK_TEST_ASSERT that the slot is valid for
1114 * wiping.
Gilles Peskine449bd832023-01-11 14:50:10 +01001115 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1116 * function is called as part of the execution of a test suite, the
1117 * execution of the test suite is stopped in error if the assertion fails.
1118 */
Ryan Everett7ed542e2024-01-17 11:39:09 +00001119 switch (slot->state) {
1120 case PSA_SLOT_FULL:
1121 /* In this state psa_wipe_key_slot() must only be called if the
1122 * caller is the last reader. */
1123 case PSA_SLOT_PENDING_DELETION:
1124 /* In this state psa_wipe_key_slot() must only be called if the
1125 * caller is the last reader. */
1126 if (slot->registered_readers != 1) {
1127 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 1);
1128 status = PSA_ERROR_CORRUPTION_DETECTED;
1129 }
1130 break;
1131 case PSA_SLOT_FILLING:
1132 /* In this state registered_readers must be 0. */
1133 if (slot->registered_readers != 0) {
1134 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->registered_readers == 0);
1135 status = PSA_ERROR_CORRUPTION_DETECTED;
1136 }
1137 break;
1138 case PSA_SLOT_EMPTY:
1139 /* The slot is already empty, it cannot be wiped. */
1140 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->state != PSA_SLOT_EMPTY);
1141 status = PSA_ERROR_CORRUPTION_DETECTED;
1142 break;
1143 default:
1144 /* The slot's state is invalid. */
1145 status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronddd3d052020-10-30 14:07:07 +01001146 }
1147
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001148 /* Multipart operations may still be using the key. This is safe
1149 * because all multipart operation objects are independent from
1150 * the key slot: if they need to access the key after the setup
1151 * phase, they have a copy of the key. Note that this means that
1152 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001153 /* At this point, key material and other type-specific content has
1154 * been wiped. Clear remaining metadata. We can call memset and not
Ryan Everettaa33c512023-12-21 17:32:07 +00001155 * zeroize because the metadata is not particularly sensitive.
1156 * This memset also sets the slot's state to PSA_SLOT_EMPTY. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 memset(slot, 0, sizeof(*slot));
1158 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001159}
1160
Gilles Peskine449bd832023-01-11 14:50:10 +01001161psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001162{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001163 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001164 psa_status_t status; /* status of the last operation */
1165 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001166#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1167 psa_se_drv_table_entry_t *driver;
1168#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001169
Gilles Peskine449bd832023-01-11 14:50:10 +01001170 if (mbedtls_svc_key_id_is_null(key)) {
1171 return PSA_SUCCESS;
1172 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001173
Ronald Cronf2911112020-10-29 17:51:10 +01001174 /*
Ryan Everett7ed542e2024-01-17 11:39:09 +00001175 * Get the description of the key in a key slot, and register to read it.
1176 * In the case of a persistent key, this will load the key description
1177 * from persistent memory if not done yet.
1178 * We cannot avoid this loading as without it we don't know if
Ronald Cronf2911112020-10-29 17:51:10 +01001179 * the key is operated by an SE or not and this information is needed by
Ryan Everett7ed542e2024-01-17 11:39:09 +00001180 * the current implementation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001181 status = psa_get_and_lock_key_slot(key, &slot);
1182 if (status != PSA_SUCCESS) {
1183 return status;
1184 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001185
Ryan Everett7ed542e2024-01-17 11:39:09 +00001186 /* Set the key slot containing the key description's state to
1187 * PENDING_DELETION. This stops new operations from registering
1188 * to read the slot. Current readers can safely continue to access
1189 * the key within the slot; the last registered reader will
1190 * automatically wipe the slot when they call psa_unregister_read().
1191 * If the key is persistent, we can now delete the copy of the key
1192 * from memory. If the key is opaque, we require the driver to
1193 * deal with the deletion. */
Ryan Everettc70ce572024-01-03 16:04:33 +00001194 slot->state = PSA_SLOT_PENDING_DELETION;
Ronald Cronf2911112020-10-29 17:51:10 +01001195
Gilles Peskine449bd832023-01-11 14:50:10 +01001196 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001197 /* Refuse the destruction of a read-only key (which may or may not work
1198 * if we attempt it, depending on whether the key is merely read-only
1199 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001200 * Just do the best we can, which is to wipe the copy in memory
1201 * (done in this function's cleanup code). */
1202 overall_status = PSA_ERROR_NOT_PERMITTED;
1203 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001204 }
1205
Gilles Peskine354f7672019-07-12 23:46:38 +02001206#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001207 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1208 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001209 /* For a key in a secure element, we need to do three things:
1210 * remove the key file in internal storage, destroy the
1211 * key inside the secure element, and update the driver's
1212 * persistent data. Start a transaction that will encompass these
1213 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001215 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001217 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001218 status = psa_crypto_save_transaction();
1219 if (status != PSA_SUCCESS) {
1220 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001221 /* We should still try to destroy the key in the secure
1222 * element and the key metadata in storage. This is especially
1223 * important if the error is that the storage is full.
1224 * But how to do it exactly without risking an inconsistent
1225 * state after a reset?
1226 * https://github.com/ARMmbed/mbed-crypto/issues/215
1227 */
1228 overall_status = status;
1229 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001230 }
1231
Gilles Peskine449bd832023-01-11 14:50:10 +01001232 status = psa_destroy_se_key(driver,
1233 psa_key_slot_get_slot_number(slot));
1234 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001235 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001236 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001237 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001238#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1239
Darryl Greend49a4992018-06-18 17:27:26 +01001240#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001241 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ryan Everett4a0ba802024-01-17 14:12:33 +00001242 /* Destroy the copy of the persistent key from storage.
Ryan Everett7ed542e2024-01-17 11:39:09 +00001243 * The slot will still hold a copy of the key until the last reader
1244 * unregisters. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001245 status = psa_destroy_persistent_key(slot->attr.id);
1246 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001247 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001249
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001250 /* TODO: other slots may have a copy of the same key. We should
1251 * invalidate them.
1252 * https://github.com/ARMmbed/mbed-crypto/issues/214
1253 */
Darryl Greend49a4992018-06-18 17:27:26 +01001254 }
1255#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001256
Gilles Peskinefc762652019-07-22 19:30:34 +02001257#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001258 if (driver != NULL) {
1259 status = psa_save_se_persistent_data(driver);
1260 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001261 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001262 }
1263 status = psa_crypto_stop_transaction();
1264 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001265 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001266 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001267 }
1268#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1269
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001270exit:
Ryan Everett7ed542e2024-01-17 11:39:09 +00001271 /* Unregister from reading the slot. If we are the last active reader
1272 * then this will wipe the slot. */
1273 status = psa_unregister_read(slot);
1274 /* Prioritize CORRUPTION_DETECTED from unregistering over
1275 * a storage error. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001276 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001277 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001278 }
1279 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001280}
1281
Valerio Settib2bcedb2023-07-10 11:24:00 +02001282#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001283 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001284static psa_status_t psa_get_rsa_public_exponent(
1285 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001286 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001287{
1288 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001289 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001290 uint8_t *buffer = NULL;
1291 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001292 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001293
Gilles Peskine449bd832023-01-11 14:50:10 +01001294 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1295 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001296 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001297 }
1298 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001299 /* It's the default value, which is reported as an empty string,
1300 * so there's nothing to do. */
1301 goto exit;
1302 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001303
Gilles Peskine449bd832023-01-11 14:50:10 +01001304 buflen = mbedtls_mpi_size(&mpi);
1305 buffer = mbedtls_calloc(1, buflen);
1306 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001307 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1308 goto exit;
1309 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001310 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1311 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001312 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001313 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001314 attributes->domain_parameters = buffer;
1315 attributes->domain_parameters_size = buflen;
1316
1317exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001318 mbedtls_mpi_free(&mpi);
1319 if (ret != 0) {
1320 mbedtls_free(buffer);
1321 }
1322 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001323}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001324#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001325 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001326
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001327/** Retrieve all the publicly-accessible attributes of a key.
1328 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001329psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1330 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001331{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001332 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001333 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001334 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001335
Gilles Peskine449bd832023-01-11 14:50:10 +01001336 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001337
Gilles Peskine449bd832023-01-11 14:50:10 +01001338 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1339 if (status != PSA_SUCCESS) {
1340 return status;
1341 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001342
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001343 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001344 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1345 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001346
1347#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001348 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1349 psa_set_key_slot_number(attributes,
1350 psa_key_slot_get_slot_number(slot));
1351 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001352#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001353
Gilles Peskine449bd832023-01-11 14:50:10 +01001354 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001355#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1356 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001357 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001358 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001359 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Pengyu Lvf75893b2023-12-08 17:21:39 +08001360 /* TODO: This is a temporary situation where domain parameters are deprecated,
1361 * but we need it for namely generating an RSA key with a non-default exponent.
1362 * This would be improved after https://github.com/Mbed-TLS/mbedtls/issues/6494.
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001363 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001365 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001366
Ronald Cron90857082020-11-25 14:58:33 +01001367 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001368 slot->attr.type,
1369 slot->key.data,
1370 slot->key.bytes,
1371 &rsa);
1372 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001373 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001374 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001375
Gilles Peskine449bd832023-01-11 14:50:10 +01001376 status = psa_get_rsa_public_exponent(rsa,
1377 attributes);
1378 mbedtls_rsa_free(rsa);
1379 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001380 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001381 break;
Pengyu Lve9efbc22023-12-08 16:59:08 +08001382#else
1383 case PSA_KEY_TYPE_RSA_KEY_PAIR:
1384 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
1385 attributes->domain_parameters = NULL;
1386 attributes->domain_parameters_size = SIZE_MAX;
1387 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001388#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1389 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001390 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001391 default:
1392 /* Nothing else to do. */
1393 break;
1394 }
1395
Gilles Peskine449bd832023-01-11 14:50:10 +01001396 if (status != PSA_SUCCESS) {
1397 psa_reset_key_attributes(attributes);
1398 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001399
Ryan Everett1b70a072024-01-04 10:32:49 +00001400 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001401
Gilles Peskine449bd832023-01-11 14:50:10 +01001402 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001403}
1404
Gilles Peskinec8000c02019-08-02 20:15:51 +02001405#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1406psa_status_t psa_get_key_slot_number(
1407 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001408 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001409{
Gilles Peskine449bd832023-01-11 14:50:10 +01001410 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001411 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001412 return PSA_SUCCESS;
1413 } else {
1414 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001415 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001416}
1417#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1418
Gilles Peskine449bd832023-01-11 14:50:10 +01001419static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1420 size_t key_buffer_size,
1421 uint8_t *data,
1422 size_t data_size,
1423 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001424{
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 if (key_buffer_size > data_size) {
1426 return PSA_ERROR_BUFFER_TOO_SMALL;
1427 }
1428 memcpy(data, key_buffer, key_buffer_size);
1429 memset(data + key_buffer_size, 0,
1430 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001431 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001433}
1434
Ronald Cron7285cda2020-11-26 14:46:37 +01001435psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001436 const psa_key_attributes_t *attributes,
1437 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001438 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001439{
Ronald Crond18b5f82020-11-25 16:46:05 +01001440 psa_key_type_t type = attributes->core.type;
1441
Gilles Peskine449bd832023-01-11 14:50:10 +01001442 if (key_type_is_raw_bytes(type) ||
1443 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001444 PSA_KEY_TYPE_IS_ECC(type) ||
1445 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001446 return psa_export_key_buffer_internal(
1447 key_buffer, key_buffer_size,
1448 data, data_size, data_length);
1449 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001450 /* This shouldn't happen in the reference implementation, but
1451 it is valid for a special-purpose implementation to omit
1452 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001453 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001454 }
1455}
1456
Gilles Peskine449bd832023-01-11 14:50:10 +01001457psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
Ryan Everett45ac5262024-01-08 17:15:19 +00001458 uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01001459 size_t data_size,
1460 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001461{
1462 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1463 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1464 psa_key_slot_t *slot;
Ryan Everett45ac5262024-01-08 17:15:19 +00001465 LOCAL_OUTPUT_DECLARE(data_external, data);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001466
Ronald Crone907e552021-01-18 13:22:38 +01001467 /* Reject a zero-length output buffer now, since this can never be a
1468 * valid key representation. This way we know that data must be a valid
1469 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001470 if (data_size == 0) {
1471 return PSA_ERROR_BUFFER_TOO_SMALL;
1472 }
Ronald Crone907e552021-01-18 13:22:38 +01001473
Ronald Cron9486f9d2020-11-26 13:36:23 +01001474 /* Set the key to empty now, so that even when there are errors, we always
1475 * set data_length to a value between 0 and data_size. On error, setting
1476 * the key to empty is a good choice because an empty key representation is
1477 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001478 *data_length = 0;
1479
Ronald Cron9486f9d2020-11-26 13:36:23 +01001480 /* Export requires the EXPORT flag. There is an exception for public keys,
1481 * which don't require any flag, but
1482 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1483 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001484 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1485 PSA_KEY_USAGE_EXPORT, 0);
1486 if (status != PSA_SUCCESS) {
1487 return status;
1488 }
mohammad160306e79202018-03-28 13:17:44 +03001489
Ryan Everett45ac5262024-01-08 17:15:19 +00001490 LOCAL_OUTPUT_ALLOC(data_external, data_size, data);
1491
Ronald Crond18b5f82020-11-25 16:46:05 +01001492 psa_key_attributes_t attributes = {
1493 .core = slot->attr
1494 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001495 status = psa_driver_wrapper_export_key(&attributes,
1496 slot->key.data, slot->key.bytes,
1497 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001498
Ryan Everett35f68532024-01-25 12:02:03 +00001499#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Ryan Everett45ac5262024-01-08 17:15:19 +00001500exit:
Ryan Everett35f68532024-01-25 12:02:03 +00001501#endif
Ryan Everett1b70a072024-01-04 10:32:49 +00001502 unlock_status = psa_unregister_read(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001503
Ryan Everett45ac5262024-01-08 17:15:19 +00001504 LOCAL_OUTPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01001505 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001506}
1507
Ronald Cron7285cda2020-11-26 14:46:37 +01001508psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001509 const psa_key_attributes_t *attributes,
1510 const uint8_t *key_buffer,
1511 size_t key_buffer_size,
1512 uint8_t *data,
1513 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001514 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001515{
Ronald Crond18b5f82020-11-25 16:46:05 +01001516 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001517
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001518 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001519 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1520 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001521 /* Exporting public -> public */
1522 return psa_export_key_buffer_internal(
1523 key_buffer, key_buffer_size,
1524 data, data_size, data_length);
1525 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001526#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001527 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1528 return mbedtls_psa_rsa_export_public_key(attributes,
1529 key_buffer,
1530 key_buffer_size,
1531 data,
1532 data_size,
1533 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001534#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001535 /* We don't know how to convert a private RSA key to public. */
1536 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001537#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001538 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001539 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001540#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001541 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1542 return mbedtls_psa_ecp_export_public_key(attributes,
1543 key_buffer,
1544 key_buffer_size,
1545 data,
1546 data_size,
1547 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001548#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001549 /* We don't know how to convert a private ECC key to public */
1550 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001551#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001552 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001553 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001554#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001555 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001556 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001557 key_buffer,
1558 key_buffer_size,
1559 data, data_size,
1560 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001561#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001562 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001563#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001564 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001565 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001566 (void) key_buffer;
1567 (void) key_buffer_size;
1568 (void) data;
1569 (void) data_size;
1570 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001571 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001572 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001573}
Ronald Crond18b5f82020-11-25 16:46:05 +01001574
Gilles Peskine449bd832023-01-11 14:50:10 +01001575psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
Ryan Everettb1d2c672024-01-08 17:19:30 +00001576 uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01001577 size_t data_size,
1578 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001579{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001580 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001581 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001582 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001583 psa_key_attributes_t attributes;
Ryan Everettb1d2c672024-01-08 17:19:30 +00001584 LOCAL_OUTPUT_DECLARE(data_external, data);
Darryl Greendd8fb772018-11-07 16:00:44 +00001585
Ronald Crone907e552021-01-18 13:22:38 +01001586 /* Reject a zero-length output buffer now, since this can never be a
1587 * valid key representation. This way we know that data must be a valid
1588 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001589 if (data_size == 0) {
1590 return PSA_ERROR_BUFFER_TOO_SMALL;
1591 }
Ronald Crone907e552021-01-18 13:22:38 +01001592
Darryl Greendd8fb772018-11-07 16:00:44 +00001593 /* Set the key to empty now, so that even when there are errors, we always
1594 * set data_length to a value between 0 and data_size. On error, setting
1595 * the key to empty is a good choice because an empty key representation is
1596 * unlikely to be accepted anywhere. */
1597 *data_length = 0;
1598
1599 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001600 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1601 if (status != PSA_SUCCESS) {
1602 return status;
1603 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001604
Ryan Everettb1d2c672024-01-08 17:19:30 +00001605 LOCAL_OUTPUT_ALLOC(data_external, data_size, data);
1606
Gilles Peskine449bd832023-01-11 14:50:10 +01001607 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1608 status = PSA_ERROR_INVALID_ARGUMENT;
1609 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001610 }
1611
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001612 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001613 .core = slot->attr
1614 };
Ronald Cron67227982020-11-26 15:16:05 +01001615 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001616 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001617 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001618
1619exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00001620 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001621
Ryan Everettb1d2c672024-01-08 17:19:30 +00001622 LOCAL_OUTPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01001623 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001624}
1625
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001626MBEDTLS_STATIC_ASSERT(
1627 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1628 "One or more key attribute flag is listed as both external-only and dual-use")
1629MBEDTLS_STATIC_ASSERT(
1630 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1631 "One or more key attribute flag is listed as both internal-only and dual-use")
1632MBEDTLS_STATIC_ASSERT(
1633 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1634 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001635
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001636/** Validate that a key policy is internally well-formed.
1637 *
1638 * This function only rejects invalid policies. It does not validate the
1639 * consistency of the policy with respect to other attributes of the key
1640 * such as the key type.
1641 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001642static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001643{
Gilles Peskine449bd832023-01-11 14:50:10 +01001644 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1645 PSA_KEY_USAGE_COPY |
1646 PSA_KEY_USAGE_ENCRYPT |
1647 PSA_KEY_USAGE_DECRYPT |
1648 PSA_KEY_USAGE_SIGN_MESSAGE |
1649 PSA_KEY_USAGE_VERIFY_MESSAGE |
1650 PSA_KEY_USAGE_SIGN_HASH |
1651 PSA_KEY_USAGE_VERIFY_HASH |
1652 PSA_KEY_USAGE_VERIFY_DERIVATION |
1653 PSA_KEY_USAGE_DERIVE)) != 0) {
1654 return PSA_ERROR_INVALID_ARGUMENT;
1655 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001656
Gilles Peskine449bd832023-01-11 14:50:10 +01001657 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001658}
1659
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001660/** Validate the internal consistency of key attributes.
1661 *
1662 * This function only rejects invalid attribute values. If does not
1663 * validate the consistency of the attributes with any key data that may
1664 * be involved in the creation of the key.
1665 *
1666 * Call this function early in the key creation process.
1667 *
1668 * \param[in] attributes Key attributes for the new key.
1669 * \param[out] p_drv On any return, the driver for the key, if any.
1670 * NULL for a transparent key.
1671 *
1672 */
1673static psa_status_t psa_validate_key_attributes(
1674 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001675 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001676{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001677 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001678 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1679 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001680
Gilles Peskine449bd832023-01-11 14:50:10 +01001681 status = psa_validate_key_location(lifetime, p_drv);
1682 if (status != PSA_SUCCESS) {
1683 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001684 }
1685
Gilles Peskine449bd832023-01-11 14:50:10 +01001686 status = psa_validate_key_persistence(lifetime);
1687 if (status != PSA_SUCCESS) {
1688 return status;
1689 }
1690
1691 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1692 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1693 return PSA_ERROR_INVALID_ARGUMENT;
1694 }
1695 } else {
1696 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1697 return PSA_ERROR_INVALID_ARGUMENT;
1698 }
1699 }
1700
1701 status = psa_validate_key_policy(&attributes->core.policy);
1702 if (status != PSA_SUCCESS) {
1703 return status;
1704 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001705
1706 /* Refuse to create overly large keys.
1707 * Note that this doesn't trigger on import if the attributes don't
1708 * explicitly specify a size (so psa_get_key_bits returns 0), so
1709 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001710 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1711 return PSA_ERROR_NOT_SUPPORTED;
1712 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001713
Gilles Peskine91e8c332019-08-02 19:19:39 +02001714 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001715 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1716 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1717 return PSA_ERROR_INVALID_ARGUMENT;
1718 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001719
Gilles Peskine449bd832023-01-11 14:50:10 +01001720 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001721}
1722
Gilles Peskine4747d192019-04-17 15:05:45 +02001723/** Prepare a key slot to receive key material.
1724 *
1725 * This function allocates a key slot and sets its metadata.
1726 *
1727 * If this function fails, call psa_fail_key_creation().
1728 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001729 * This function is intended to be used as follows:
1730 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001731 * it with the specified attributes, and in case of a volatile key assign it
1732 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001733 * -# Populate the slot with the key material.
1734 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1735 * In case of failure at any step, stop the sequence and call
1736 * psa_fail_key_creation().
1737 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001738 * On success, the key slot's state is PSA_SLOT_FILLING.
1739 * It is the responsibility of the caller to change the slot's state to
1740 * PSA_SLOT_EMPTY/FULL once key creation has finished.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001741 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001742 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001743 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001744 * \param[out] p_slot On success, a pointer to the prepared slot.
1745 * \param[out] p_drv On any return, the driver for the key, if any.
1746 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001747 *
1748 * \retval #PSA_SUCCESS
1749 * The key slot is ready to receive key material.
1750 * \return If this function fails, the key slot is an invalid state.
1751 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001752 */
1753static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001754 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001755 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001756 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001757 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001758{
1759 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001760 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001761 psa_key_slot_t *slot;
1762
Gilles Peskinedf179142019-07-15 22:02:14 +02001763 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001764 *p_drv = NULL;
1765
Gilles Peskine449bd832023-01-11 14:50:10 +01001766 status = psa_validate_key_attributes(attributes, p_drv);
1767 if (status != PSA_SUCCESS) {
1768 return status;
1769 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001770
Ryan Everettb69118e2024-01-02 15:54:32 +00001771 status = psa_reserve_free_key_slot(&volatile_key_id, p_slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01001772 if (status != PSA_SUCCESS) {
1773 return status;
1774 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001775 slot = *p_slot;
1776
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001777 /* We're storing the declared bit-size of the key. It's up to each
1778 * creation mechanism to verify that this information is correct.
1779 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001780 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001781 * is optional (import, copy). In case of a volatile key, assign it the
1782 * volatile key identifier associated to the slot returned to contain its
1783 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001784
1785 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001786 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001787#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1788 slot->attr.id = volatile_key_id;
1789#else
1790 slot->attr.id.key_id = volatile_key_id;
1791#endif
1792 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001793
Gilles Peskine91e8c332019-08-02 19:19:39 +02001794 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001795 * external-only flags, query `attributes`. Thanks to the check
1796 * in psa_validate_key_attributes(), this leaves the dual-use
Ryan Everettb69118e2024-01-02 15:54:32 +00001797 * flags and any internal flag that psa_reserve_free_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001798 * may have set. */
1799 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001800
Gilles Peskinecbaff462019-07-12 23:46:04 +02001801#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001802 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001803 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001804 * create the key file in internal storage, create the
1805 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001806 * persistent data. This is done by starting a transaction that will
1807 * encompass these three actions.
1808 * For registering a volatile key, we just need to find an appropriate
1809 * slot number inside the SE. Since the key is designated volatile, creating
1810 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001811 /* The first thing to do is to find a slot number for the new key.
1812 * We save the slot number in persistent storage as part of the
1813 * transaction data. It will be needed to recover if the power
1814 * fails during the key creation process, to clean up on the secure
1815 * element side after restarting. Obtaining a slot number from the
1816 * secure element driver updates its persistent state, but we do not yet
1817 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001818 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001819 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001820 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001821 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1822 &slot_number);
1823 if (status != PSA_SUCCESS) {
1824 return status;
1825 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001826
Gilles Peskine449bd832023-01-11 14:50:10 +01001827 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1828 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001829 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001830 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001831 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001832 status = psa_crypto_save_transaction();
1833 if (status != PSA_SUCCESS) {
1834 (void) psa_crypto_stop_transaction();
1835 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001836 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001837 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001838
1839 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001840 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001841 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001842
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001844 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001846 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001847#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1848
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001850}
Gilles Peskine4747d192019-04-17 15:05:45 +02001851
1852/** Finalize the creation of a key once its key material has been set.
1853 *
1854 * This entails writing the key to persistent storage.
1855 *
1856 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001857 * See the documentation of psa_start_key_creation() for the intended use
1858 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02001859 *
Ryan Everettb69118e2024-01-02 15:54:32 +00001860 * If the finalization succeeds, the function sets the key slot's state to
1861 * PSA_SLOT_FULL, and the key slot can no longer be accessed as part of the
1862 * key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01001863 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001864 * \param[in,out] slot Pointer to the slot with key material.
1865 * \param[in] driver The secure element driver for the key,
1866 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01001867 * \param[out] key On success, identifier of the key. Note that the
1868 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001869 *
1870 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02001871 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01001872 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
1873 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
1874 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
1875 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
1876 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
1877 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01001878 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001879 * \return If this function fails, the key slot is an invalid state.
1880 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001881 */
Gilles Peskine011e4282019-06-26 18:34:38 +02001882static psa_status_t psa_finish_key_creation(
1883 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01001884 psa_se_drv_table_entry_t *driver,
1885 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02001886{
1887 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02001888 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02001889 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02001890
1891#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001892 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02001893#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001894 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02001895 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001896 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01001897 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01001898
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001899 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
1900 sizeof(data.slot_number),
1901 "Slot number size does not match psa_se_key_data_storage_t");
1902
Gilles Peskine449bd832023-01-11 14:50:10 +01001903 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
1904 status = psa_save_persistent_key(&slot->attr,
1905 (uint8_t *) &data,
1906 sizeof(data));
1907 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02001908#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1909 {
Steven Cooreman40120f62020-10-29 11:42:22 +01001910 /* Key material is saved in export representation in the slot, so
1911 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001912 status = psa_save_persistent_key(&slot->attr,
1913 slot->key.data,
1914 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02001915 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001916 }
Darryl Green0c6575a2018-11-07 16:05:30 +00001917#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
1918
Gilles Peskinecbaff462019-07-12 23:46:04 +02001919#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001920 /* Finish the transaction for a key creation. This does not
1921 * happen when registering an existing key. Detect this case
1922 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001923 * creation of a persistent key in a secure element requires a transaction,
1924 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001925 if (driver != NULL &&
1926 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
1927 status = psa_save_se_persistent_data(driver);
1928 if (status != PSA_SUCCESS) {
1929 psa_destroy_persistent_key(slot->attr.id);
1930 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02001931 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001932 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02001933 }
1934#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1935
Gilles Peskine449bd832023-01-11 14:50:10 +01001936 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001937 *key = slot->attr.id;
Ryan Everettb69118e2024-01-02 15:54:32 +00001938 status = psa_key_slot_state_transition(slot, PSA_SLOT_FILLING,
1939 PSA_SLOT_FULL);
Gilles Peskine449bd832023-01-11 14:50:10 +01001940 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01001941 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001942 }
Ronald Cron81709fc2020-11-14 12:10:32 +01001943 }
Ronald Cron50972942020-11-14 11:28:25 +01001944
Gilles Peskine449bd832023-01-11 14:50:10 +01001945 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02001946}
1947
1948/** Abort the creation of a key.
1949 *
1950 * You may call this function after calling psa_start_key_creation(),
1951 * or after psa_finish_key_creation() fails. In other circumstances, this
1952 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001953 * See the documentation of psa_start_key_creation() for the intended use
Ryan Everettb69118e2024-01-02 15:54:32 +00001954 * of this function. Sets the slot's state to PSA_SLOT_EMPTY.
Gilles Peskine4747d192019-04-17 15:05:45 +02001955 *
Gilles Peskine011e4282019-06-26 18:34:38 +02001956 * \param[in,out] slot Pointer to the slot with key material.
1957 * \param[in] driver The secure element driver for the key,
1958 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02001959 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001960static void psa_fail_key_creation(psa_key_slot_t *slot,
1961 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02001962{
Gilles Peskine011e4282019-06-26 18:34:38 +02001963 (void) driver;
1964
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02001966 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01001967 }
Gilles Peskine011e4282019-06-26 18:34:38 +02001968
1969#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01001970 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02001971 * element, and the failure happened later (when saving metadata
1972 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001973 * element.
1974 * https://github.com/ARMmbed/mbed-crypto/issues/217
1975 */
Gilles Peskinefc762652019-07-22 19:30:34 +02001976
Gilles Peskined7729582019-08-05 15:55:54 +02001977 /* Abort the ongoing transaction if any (there may not be one if
1978 * the creation process failed before starting one, or if the
1979 * key creation is a registration of a key in a secure element).
1980 * Earlier functions must already have done what it takes to undo any
1981 * partial creation. All that's left is to update the transaction data
1982 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02001984#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1985
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02001987}
1988
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001989/** Validate optional attributes during key creation.
1990 *
1991 * Some key attributes are optional during key creation. If they are
1992 * specified in the attributes structure, check that they are consistent
1993 * with the data in the slot.
1994 *
1995 * This function should be called near the end of key creation, after
1996 * the slot in memory is fully populated but before saving persistent data.
1997 */
1998static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02001999 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002001{
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 if (attributes->core.type != 0) {
2003 if (attributes->core.type != slot->attr.type) {
2004 return PSA_ERROR_INVALID_ARGUMENT;
2005 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002006 }
2007
Gilles Peskine449bd832023-01-11 14:50:10 +01002008 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02002009#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
2010 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002011 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
2012 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02002013 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002014 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002015 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002016
Ronald Cron90857082020-11-25 14:58:33 +01002017 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01002018 slot->attr.type,
2019 slot->key.data,
2020 slot->key.bytes,
2021 &rsa);
2022 if (status != PSA_SUCCESS) {
2023 return status;
2024 }
Steven Cooreman75b74362020-07-28 14:30:13 +02002025
Gilles Peskine449bd832023-01-11 14:50:10 +01002026 mbedtls_mpi_init(&actual);
2027 mbedtls_mpi_init(&required);
2028 ret = mbedtls_rsa_export(rsa,
2029 NULL, NULL, NULL, NULL, &actual);
2030 mbedtls_rsa_free(rsa);
2031 mbedtls_free(rsa);
2032 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002033 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002034 }
2035 ret = mbedtls_mpi_read_binary(&required,
2036 attributes->domain_parameters,
2037 attributes->domain_parameters_size);
2038 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002039 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002040 }
2041 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002042 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01002043 }
2044rsa_exit:
2045 mbedtls_mpi_free(&actual);
2046 mbedtls_mpi_free(&required);
2047 if (ret != 0) {
2048 return mbedtls_to_psa_error(ret);
2049 }
2050 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02002051#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
2052 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08002053 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002054 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002055 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002056 }
2057 }
2058
Gilles Peskine449bd832023-01-11 14:50:10 +01002059 if (attributes->core.bits != 0) {
2060 if (attributes->core.bits != slot->attr.bits) {
2061 return PSA_ERROR_INVALID_ARGUMENT;
2062 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002063 }
2064
Gilles Peskine449bd832023-01-11 14:50:10 +01002065 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002066}
2067
Gilles Peskine449bd832023-01-11 14:50:10 +01002068psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
Ryan Everettf028fe12024-01-08 17:14:44 +00002069 const uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 size_t data_length,
2071 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002072{
2073 psa_status_t status;
Ryan Everettf028fe12024-01-08 17:14:44 +00002074 LOCAL_INPUT_DECLARE(data_external, data);
Gilles Peskine4747d192019-04-17 15:05:45 +02002075 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002076 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002077 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302078 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002079
Ronald Cron81709fc2020-11-14 12:10:32 +01002080 *key = MBEDTLS_SVC_KEY_ID_INIT;
2081
Gilles Peskine0f84d622019-09-12 19:03:13 +02002082 /* Reject zero-length symmetric keys (including raw data key objects).
2083 * This also rejects any key which might be encoded as an empty string,
2084 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 if (data_length == 0) {
2086 return PSA_ERROR_INVALID_ARGUMENT;
2087 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002088
Archana449608b2021-09-08 15:36:05 +05302089 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002090 if (data_length > SIZE_MAX / 8) {
2091 return PSA_ERROR_NOT_SUPPORTED;
2092 }
Archana6ed4bda2021-08-04 10:47:15 +05302093
Ryan Everettf028fe12024-01-08 17:14:44 +00002094 LOCAL_INPUT_ALLOC(data_external, data_length, data);
2095
Gilles Peskine449bd832023-01-11 14:50:10 +01002096 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2097 &slot, &driver);
2098 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002099 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002100 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002101
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002102 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302103 * storage ( thus not in the case of importing a key in a secure element
2104 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2105 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 if (slot->key.data == NULL) {
2107 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302108 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002109 attributes, data, data_length, &storage_size);
2110 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302111 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 }
Archanad8a83dc2021-06-14 10:04:16 +05302113 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002114 status = psa_allocate_buffer_to_slot(slot, storage_size);
2115 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002116 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002118 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002119
2120 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 status = psa_driver_wrapper_import_key(attributes,
2122 data, data_length,
2123 slot->key.data,
2124 slot->key.bytes,
2125 &slot->key.bytes, &bits);
2126 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002127 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002129
Gilles Peskine449bd832023-01-11 14:50:10 +01002130 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002131 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002133 status = PSA_ERROR_INVALID_ARGUMENT;
2134 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002135 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002136
Archana6ed4bda2021-08-04 10:47:15 +05302137 /* Enforce a size limit, and in particular ensure that the bit
2138 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002139 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302140 status = PSA_ERROR_NOT_SUPPORTED;
2141 goto exit;
2142 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002143 status = psa_validate_optional_attributes(slot, attributes);
2144 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002145 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002146 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002147
Gilles Peskine449bd832023-01-11 14:50:10 +01002148 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002149exit:
Ryan Everettf028fe12024-01-08 17:14:44 +00002150 LOCAL_INPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 if (status != PSA_SUCCESS) {
2152 psa_fail_key_creation(slot, driver);
2153 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002154
Gilles Peskine449bd832023-01-11 14:50:10 +01002155 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002156}
2157
Gilles Peskined7729582019-08-05 15:55:54 +02002158#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2159psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002160 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002161{
2162 psa_status_t status;
2163 psa_key_slot_t *slot = NULL;
2164 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002165 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002166
2167 /* Leaving attributes unspecified is not currently supported.
2168 * It could make sense to query the key type and size from the
2169 * secure element, but not all secure elements support this
2170 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002171 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2172 return PSA_ERROR_NOT_SUPPORTED;
2173 }
2174 if (psa_get_key_bits(attributes) == 0) {
2175 return PSA_ERROR_NOT_SUPPORTED;
2176 }
Gilles Peskined7729582019-08-05 15:55:54 +02002177
Gilles Peskine449bd832023-01-11 14:50:10 +01002178 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2179 &slot, &driver);
2180 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002181 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002182 }
Gilles Peskined7729582019-08-05 15:55:54 +02002183
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002185
2186exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002187 if (status != PSA_SUCCESS) {
2188 psa_fail_key_creation(slot, driver);
2189 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002190
Gilles Peskined7729582019-08-05 15:55:54 +02002191 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002192 psa_close_key(key);
2193 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002194}
2195#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2196
Gilles Peskine449bd832023-01-11 14:50:10 +01002197psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2198 const psa_key_attributes_t *specified_attributes,
2199 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002200{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002201 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002202 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002203 psa_key_slot_t *source_slot = NULL;
2204 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002205 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002206 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302207 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002208
Ronald Cron81709fc2020-11-14 12:10:32 +01002209 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2210
Archana8a180362021-07-05 02:18:48 +05302211 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002212 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2213 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002214 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002215 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002216
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 status = psa_validate_optional_attributes(source_slot,
2218 specified_attributes);
2219 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002220 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002221 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002222
Archana9d17bf42021-09-10 06:22:44 +05302223 /* The target key type and number of bits have been validated by
2224 * psa_validate_optional_attributes() to be either equal to zero or
2225 * equal to the ones of the source key. So it is safe to inherit
2226 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302227 * */
Archana9d17bf42021-09-10 06:22:44 +05302228 actual_attributes.core.bits = source_slot->attr.bits;
2229 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302230
2231
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 status = psa_restrict_key_policy(source_slot->attr.type,
2233 &actual_attributes.core.policy,
2234 &source_slot->attr.policy);
2235 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002236 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002237 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002238
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2240 &target_slot, &driver);
2241 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002242 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 }
2244 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2245 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302246 /*
Archana9d17bf42021-09-10 06:22:44 +05302247 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302248 * the source key would need to be exported as plaintext and re-imported
2249 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302250 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302251 * appropriate API invocations from the application, if needed.
2252 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002253 status = PSA_ERROR_NOT_SUPPORTED;
2254 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002255 }
Archana8a180362021-07-05 02:18:48 +05302256 /*
2257 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302258 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302259 * - For opaque keys this translates to an invocation of the drivers'
2260 * copy_key entry point through the dispatch layer.
2261 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2263 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2264 &storage_size);
2265 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302266 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 }
Archana374fe5b2021-09-08 15:50:28 +05302268
Gilles Peskine449bd832023-01-11 14:50:10 +01002269 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2270 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302271 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002272 }
Archana374fe5b2021-09-08 15:50:28 +05302273
Gilles Peskine449bd832023-01-11 14:50:10 +01002274 status = psa_driver_wrapper_copy_key(&actual_attributes,
2275 source_slot->key.data,
2276 source_slot->key.bytes,
2277 target_slot->key.data,
2278 target_slot->key.bytes,
2279 &target_slot->key.bytes);
2280 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302281 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 }
2283 } else {
2284 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302285 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 source_slot->key.bytes);
2287 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302288 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002289 }
Archana8a180362021-07-05 02:18:48 +05302290 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002292exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002293 if (status != PSA_SUCCESS) {
2294 psa_fail_key_creation(target_slot, driver);
2295 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002296
Ryan Everett1b70a072024-01-04 10:32:49 +00002297 unlock_status = psa_unregister_read(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002298
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002300}
2301
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002302
2303
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002304/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002305/* Message digests */
2306/****************************************************************/
2307
Gilles Peskine449bd832023-01-11 14:50:10 +01002308psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002309{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002310 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002311 if (operation->id == 0) {
2312 return PSA_SUCCESS;
2313 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002314
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002316 operation->id = 0;
2317
Gilles Peskine449bd832023-01-11 14:50:10 +01002318 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002319}
2320
Gilles Peskine449bd832023-01-11 14:50:10 +01002321psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2322 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002323{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002324 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002325
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002326 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002328 status = PSA_ERROR_BAD_STATE;
2329 goto exit;
2330 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002331
Gilles Peskine449bd832023-01-11 14:50:10 +01002332 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002333 status = PSA_ERROR_INVALID_ARGUMENT;
2334 goto exit;
2335 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002336
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002337 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2338 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002339 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002340
Gilles Peskine449bd832023-01-11 14:50:10 +01002341 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002342
2343exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 if (status != PSA_SUCCESS) {
2345 psa_hash_abort(operation);
2346 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002347
2348 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002349}
2350
Gilles Peskine449bd832023-01-11 14:50:10 +01002351psa_status_t psa_hash_update(psa_hash_operation_t *operation,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002352 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002354{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002355 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002356 LOCAL_INPUT_DECLARE(input_external, input);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002357
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002359 status = PSA_ERROR_BAD_STATE;
2360 goto exit;
2361 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002362
Steven Cooremanc8288352021-03-04 14:02:19 +01002363 /* Don't require hash implementations to behave correctly on a
2364 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 if (input_length == 0) {
2366 return PSA_SUCCESS;
2367 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002368
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002369 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002370 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002371
2372exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 if (status != PSA_SUCCESS) {
2374 psa_hash_abort(operation);
2375 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002376
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002377 LOCAL_INPUT_FREE(input_external, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002378 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002379}
2380
Thomas Daubney31d8c0b2024-01-18 15:26:59 +00002381static psa_status_t psa_hash_finish_internal(psa_hash_operation_t *operation,
Thomas Daubneyd2411562024-01-25 17:25:07 +00002382 uint8_t *hash,
2383 size_t hash_size,
2384 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002385{
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002386 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2387
Steven Cooremanfbe09282021-03-08 18:41:12 +01002388 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 if (operation->id == 0) {
2390 return PSA_ERROR_BAD_STATE;
2391 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002392
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002393 status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 operation, hash, hash_size, hash_length);
2395 psa_hash_abort(operation);
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002396
2397 return status;
2398}
2399
2400psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2401 uint8_t *hash_external,
2402 size_t hash_size,
2403 size_t *hash_length)
2404{
2405 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2406 LOCAL_OUTPUT_DECLARE(hash_external, hash);
2407
2408 LOCAL_OUTPUT_ALLOC(hash_external, hash_size, hash);
2409 status = psa_hash_finish_internal(operation, hash, hash_size, hash_length);
2410
Thomas Daubneydedd1002024-01-25 16:52:50 +00002411#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002412exit:
Thomas Daubneydedd1002024-01-25 16:52:50 +00002413#endif
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002414 LOCAL_OUTPUT_FREE(hash_external, hash);
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002416}
2417
Gilles Peskine449bd832023-01-11 14:50:10 +01002418psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002419 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002421{
Ronald Cron69a63422021-10-18 09:47:58 +02002422 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002423 size_t actual_hash_length;
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002424 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2425 LOCAL_INPUT_DECLARE(hash_external, hash);
2426
2427 status = psa_hash_finish_internal(
Gilles Peskine449bd832023-01-11 14:50:10 +01002428 operation,
2429 actual_hash, sizeof(actual_hash),
2430 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002431
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002433 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002435
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002437 status = PSA_ERROR_INVALID_SIGNATURE;
2438 goto exit;
2439 }
2440
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002441 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
Dave Rodgman78701152023-08-29 14:20:18 +01002442 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002443 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002445
2446exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2448 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002449 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002450 }
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002451 LOCAL_INPUT_FREE(hash_external, hash);
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002453}
2454
Gilles Peskine449bd832023-01-11 14:50:10 +01002455psa_status_t psa_hash_compute(psa_algorithm_t alg,
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002456 const uint8_t *input_external, size_t input_length,
2457 uint8_t *hash_external, size_t hash_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002459{
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002460 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2461 LOCAL_INPUT_DECLARE(input_external, input);
2462 LOCAL_OUTPUT_DECLARE(hash_external, hash);
2463
Steven Cooremanfbe09282021-03-08 18:41:12 +01002464 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 if (!PSA_ALG_IS_HASH(alg)) {
2466 return PSA_ERROR_INVALID_ARGUMENT;
2467 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002468
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002469 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2470 LOCAL_OUTPUT_ALLOC(hash_external, hash_size, hash);
2471 status = psa_driver_wrapper_hash_compute(alg, input, input_length,
Thomas Daubneyd2411562024-01-25 17:25:07 +00002472 hash, hash_size, hash_length);
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002473
Thomas Daubneydedd1002024-01-25 16:52:50 +00002474#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002475exit:
Thomas Daubneydedd1002024-01-25 16:52:50 +00002476#endif
Thomas Daubney1c5118e2024-01-12 16:50:26 +00002477 LOCAL_INPUT_FREE(input_external, input);
2478 LOCAL_OUTPUT_FREE(hash_external, hash);
2479 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002480}
2481
Gilles Peskine449bd832023-01-11 14:50:10 +01002482psa_status_t psa_hash_compare(psa_algorithm_t alg,
Thomas Daubney51ffac92024-01-18 15:46:26 +00002483 const uint8_t *input_external, size_t input_length,
2484 const uint8_t *hash_external, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002485{
Ronald Cron69a63422021-10-18 09:47:58 +02002486 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002487 size_t actual_hash_length;
Thomas Daubney51ffac92024-01-18 15:46:26 +00002488 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2489
2490 LOCAL_INPUT_DECLARE(input_external, input);
2491 LOCAL_INPUT_DECLARE(hash_external, hash);
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002492
Gilles Peskine449bd832023-01-11 14:50:10 +01002493 if (!PSA_ALG_IS_HASH(alg)) {
Thomas Daubney51ffac92024-01-18 15:46:26 +00002494 status = PSA_ERROR_INVALID_ARGUMENT;
2495 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002496 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002497
Thomas Daubney51ffac92024-01-18 15:46:26 +00002498 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2499 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002500 alg, input, input_length,
2501 actual_hash, sizeof(actual_hash),
2502 &actual_hash_length);
2503 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002504 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002505 }
2506 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002507 status = PSA_ERROR_INVALID_SIGNATURE;
2508 goto exit;
2509 }
Thomas Daubney51ffac92024-01-18 15:46:26 +00002510
2511 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
Dave Rodgman78701152023-08-29 14:20:18 +01002512 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002513 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002515
2516exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002517 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
Thomas Daubney51ffac92024-01-18 15:46:26 +00002518
2519 LOCAL_INPUT_FREE(input_external, input);
2520 LOCAL_INPUT_FREE(hash_external, hash);
2521
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002523}
2524
Gilles Peskine449bd832023-01-11 14:50:10 +01002525psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2526 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002527{
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 if (source_operation->id == 0 ||
2529 target_operation->id != 0) {
2530 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002531 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002532
Gilles Peskine449bd832023-01-11 14:50:10 +01002533 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2534 target_operation);
2535 if (status != PSA_SUCCESS) {
2536 psa_hash_abort(target_operation);
2537 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002538
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002540}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002541
2542
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002543/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002544/* MAC */
2545/****************************************************************/
2546
Gilles Peskine449bd832023-01-11 14:50:10 +01002547psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002548{
Steven Cooremane6804192021-03-19 18:28:56 +01002549 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 if (operation->id == 0) {
2551 return PSA_SUCCESS;
2552 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002553
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002555 operation->mac_size = 0;
2556 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002557 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002558
Gilles Peskine449bd832023-01-11 14:50:10 +01002559 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002560}
2561
Ronald Cron2dff3b22021-06-17 16:33:22 +02002562static psa_status_t psa_mac_finalize_alg_and_key_validation(
2563 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002564 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002566{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002567 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 psa_key_type_t key_type = psa_get_key_type(attributes);
2569 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002570
Gilles Peskine449bd832023-01-11 14:50:10 +01002571 if (!PSA_ALG_IS_MAC(alg)) {
2572 return PSA_ERROR_INVALID_ARGUMENT;
2573 }
Steven Cooremane6804192021-03-19 18:28:56 +01002574
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002575 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002576 status = psa_mac_key_can_do(alg, key_type);
2577 if (status != PSA_SUCCESS) {
2578 return status;
2579 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002580
Steven Cooremand1a68f12021-05-10 11:13:41 +02002581 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002582 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002583
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002585 /* A very short MAC is too short for security since it can be
2586 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2587 * so we make this our minimum, even though 32 bits is still
2588 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002590 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002591
Gilles Peskine449bd832023-01-11 14:50:10 +01002592 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2593 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002594 /* It's impossible to "truncate" to a larger length than the full length
2595 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002596 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002597 }
2598
Gilles Peskine449bd832023-01-11 14:50:10 +01002599 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002600 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2601 * that is disabled in the compile-time configuration. The result can
2602 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2603 * configuration into account. In this case, force a return of
2604 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2605 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2606 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2607 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2608 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002610 }
2611
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002613}
2614
Gilles Peskine449bd832023-01-11 14:50:10 +01002615static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2616 mbedtls_svc_key_id_t key,
2617 psa_algorithm_t alg,
2618 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002619{
2620 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2621 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002622 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002623 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002624
2625 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002626 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002627 status = PSA_ERROR_BAD_STATE;
2628 goto exit;
2629 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002630
2631 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002632 key,
2633 &slot,
2634 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2635 alg);
2636 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002637 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002638 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002639
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002640 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002641 .core = slot->attr
2642 };
2643
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2645 &operation->mac_size);
2646 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002647 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002648 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002649
2650 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002651 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002652 if (is_sign) {
2653 status = psa_driver_wrapper_mac_sign_setup(operation,
2654 &attributes,
2655 slot->key.data,
2656 slot->key.bytes,
2657 alg);
2658 } else {
2659 status = psa_driver_wrapper_mac_verify_setup(operation,
2660 &attributes,
2661 slot->key.data,
2662 slot->key.bytes,
2663 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002664 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002665
Gilles Peskinefbfac682018-07-08 20:51:54 +02002666exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002667 if (status != PSA_SUCCESS) {
2668 psa_mac_abort(operation);
2669 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002670
Ryan Everett1b70a072024-01-04 10:32:49 +00002671 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002672
Gilles Peskine449bd832023-01-11 14:50:10 +01002673 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002674}
2675
Gilles Peskine449bd832023-01-11 14:50:10 +01002676psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2677 mbedtls_svc_key_id_t key,
2678 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002679{
Gilles Peskine449bd832023-01-11 14:50:10 +01002680 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002681}
2682
Gilles Peskine449bd832023-01-11 14:50:10 +01002683psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2684 mbedtls_svc_key_id_t key,
2685 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002686{
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002688}
2689
Gilles Peskine449bd832023-01-11 14:50:10 +01002690psa_status_t psa_mac_update(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002691 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002692 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002693{
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002694 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2695 LOCAL_INPUT_DECLARE(input_external, input);
2696
Gilles Peskine449bd832023-01-11 14:50:10 +01002697 if (operation->id == 0) {
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002698 status = PSA_ERROR_BAD_STATE;
2699 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002701
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002702 /* Don't require hash implementations to behave correctly on a
2703 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002704 if (input_length == 0) {
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002705 status = PSA_SUCCESS;
2706 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002707 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002708
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002709 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2710 status = psa_driver_wrapper_mac_update(operation, input, input_length);
2711
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 if (status != PSA_SUCCESS) {
2713 psa_mac_abort(operation);
2714 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002715
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002716#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002717exit:
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002718#endif
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002719 LOCAL_INPUT_FREE(input_external, input);
2720
Gilles Peskine449bd832023-01-11 14:50:10 +01002721 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002722}
2723
Gilles Peskine449bd832023-01-11 14:50:10 +01002724psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002725 uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 size_t mac_size,
2727 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002728{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002729 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2730 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002731 LOCAL_OUTPUT_DECLARE(mac_external, mac);
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002732 LOCAL_OUTPUT_ALLOC(mac_external, mac_size, mac);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002733
Gilles Peskine449bd832023-01-11 14:50:10 +01002734 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002735 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002736 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002737 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002738
Gilles Peskine449bd832023-01-11 14:50:10 +01002739 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002740 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002741 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002742 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002743
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002744 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2745 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002746 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002747 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002748 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002749 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002750
Gilles Peskine449bd832023-01-11 14:50:10 +01002751 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002752 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002753 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002754 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002755
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002756
Gilles Peskine449bd832023-01-11 14:50:10 +01002757 status = psa_driver_wrapper_mac_sign_finish(operation,
2758 mac, operation->mac_size,
2759 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002760
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002761exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002762 /* In case of success, set the potential excess room in the output buffer
2763 * to an invalid value, to avoid potentially leaking a longer MAC.
2764 * In case of error, set the output length and content to a safe default,
2765 * such that in case the caller misses an error check, the output would be
2766 * an unachievable MAC.
2767 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002768 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002769 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002770 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002771 }
mohammad16036df908f2018-04-02 08:34:15 -07002772
Thomas Daubney03f1ea32024-02-01 16:16:27 +00002773 if (mac != NULL) {
Thomas Daubney1ffc5cb2024-01-31 18:09:36 +00002774 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
2775 }
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002776
Gilles Peskine449bd832023-01-11 14:50:10 +01002777 abort_status = psa_mac_abort(operation);
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002778 LOCAL_OUTPUT_FREE(mac_external, mac);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002779
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002781}
2782
Gilles Peskine449bd832023-01-11 14:50:10 +01002783psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002784 const uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002785 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002786{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002787 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2788 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002789 LOCAL_INPUT_DECLARE(mac_external, mac);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002790
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002792 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002793 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002794 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002795
Gilles Peskine449bd832023-01-11 14:50:10 +01002796 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002797 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002798 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002799 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002800
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002802 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002803 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002804 }
2805
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002806 LOCAL_INPUT_ALLOC(mac_external, mac_length, mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 status = psa_driver_wrapper_mac_verify_finish(operation,
2808 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002809
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002810exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002811 abort_status = psa_mac_abort(operation);
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002812 LOCAL_INPUT_FREE(mac_external, mac);
mohammad16036df908f2018-04-02 08:34:15 -07002813
Gilles Peskine449bd832023-01-11 14:50:10 +01002814 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002815}
2816
Gilles Peskine449bd832023-01-11 14:50:10 +01002817static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2818 psa_algorithm_t alg,
2819 const uint8_t *input,
2820 size_t input_length,
2821 uint8_t *mac,
2822 size_t mac_size,
2823 size_t *mac_length,
2824 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002825{
2826 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002827 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2828 psa_key_slot_t *slot;
2829 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002830 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002831
Ronald Cron51131b52021-06-17 17:17:20 +02002832 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002833 key,
2834 &slot,
2835 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2836 alg);
2837 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002838 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002839 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002840
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002841 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002842 .core = slot->attr
2843 };
2844
Gilles Peskine449bd832023-01-11 14:50:10 +01002845 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2846 &operation_mac_size);
2847 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002848 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002849 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002850
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002852 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002853 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002854 }
2855
2856 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002857 &attributes,
2858 slot->key.data, slot->key.bytes,
2859 alg,
2860 input, input_length,
2861 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002862
2863exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002864 /* In case of success, set the potential excess room in the output buffer
2865 * to an invalid value, to avoid potentially leaking a longer MAC.
2866 * In case of error, set the output length and content to a safe default,
2867 * such that in case the caller misses an error check, the output would be
2868 * an unachievable MAC.
2869 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002870 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002871 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002872 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002873 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002874
2875 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002876
Ryan Everett1b70a072024-01-04 10:32:49 +00002877 unlock_status = psa_unregister_read(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002878
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002880}
2881
Gilles Peskine449bd832023-01-11 14:50:10 +01002882psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002883 psa_algorithm_t alg,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002884 const uint8_t *input_external,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002885 size_t input_length,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002886 uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 size_t mac_size,
2888 size_t *mac_length)
2889{
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002890 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2891 LOCAL_INPUT_DECLARE(input_external, input);
2892 LOCAL_OUTPUT_DECLARE(mac_external, mac);
2893
2894 LOCAL_INPUT_ALLOC(input_external, input_length, input);
2895 LOCAL_OUTPUT_ALLOC(mac_external, mac_size, mac);
2896 status = psa_mac_compute_internal(key, alg,
Thomas Daubney7480a742024-01-30 11:29:47 +00002897 input, input_length,
2898 mac, mac_size, mac_length, 1);
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002899
2900#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002901exit:
Thomas Daubneyc6705c62024-01-30 11:21:47 +00002902#endif
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002903 LOCAL_INPUT_FREE(input_external, input);
2904 LOCAL_OUTPUT_FREE(mac_external, mac);
2905
2906 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002907}
2908
2909psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2910 psa_algorithm_t alg,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002911 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002912 size_t input_length,
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002913 const uint8_t *mac_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002914 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002915{
2916 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002917 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2918 size_t actual_mac_length;
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002919 LOCAL_INPUT_DECLARE(input_external, input);
2920 LOCAL_INPUT_DECLARE(mac_external, mac);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002921
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002922 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gilles Peskine449bd832023-01-11 14:50:10 +01002923 status = psa_mac_compute_internal(key, alg,
2924 input, input_length,
2925 actual_mac, sizeof(actual_mac),
2926 &actual_mac_length, 0);
2927 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002928 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002929 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002930
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002932 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002933 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002934 }
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002935
2936 LOCAL_INPUT_ALLOC(mac_external, mac_length, mac);
Dave Rodgman78701152023-08-29 14:20:18 +01002937 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002938 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002939 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002940 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002941
2942exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002943 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
Thomas Daubney8db8d1a2024-01-18 13:18:58 +00002944 LOCAL_INPUT_FREE(input_external, input);
2945 LOCAL_INPUT_FREE(mac_external, mac);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002946
Gilles Peskine449bd832023-01-11 14:50:10 +01002947 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002948}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002949
Gilles Peskinee59236f2018-01-27 23:32:46 +01002950/****************************************************************/
2951/* Asymmetric cryptography */
2952/****************************************************************/
2953
Gilles Peskine449bd832023-01-11 14:50:10 +01002954static psa_status_t psa_sign_verify_check_alg(int input_is_message,
2955 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002956{
Gilles Peskine449bd832023-01-11 14:50:10 +01002957 if (input_is_message) {
2958 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
2959 return PSA_ERROR_INVALID_ARGUMENT;
2960 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002961
Gilles Peskine449bd832023-01-11 14:50:10 +01002962 if (PSA_ALG_IS_SIGN_HASH(alg)) {
2963 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
2964 return PSA_ERROR_INVALID_ARGUMENT;
2965 }
2966 }
2967 } else {
2968 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
2969 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002970 }
2971 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002972
Gilles Peskine449bd832023-01-11 14:50:10 +01002973 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002974}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002975
Gilles Peskine449bd832023-01-11 14:50:10 +01002976static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
2977 int input_is_message,
2978 psa_algorithm_t alg,
2979 const uint8_t *input,
2980 size_t input_length,
2981 uint8_t *signature,
2982 size_t signature_size,
2983 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002984{
2985 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2986 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2987 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002988 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002989
2990 *signature_length = 0;
2991
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 status = psa_sign_verify_check_alg(input_is_message, alg);
2993 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02002994 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01002995 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02002996
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002997 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02002998 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02002999 * buffer can in principle be empty since it doesn't actually have
3000 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 if (signature_size == 0) {
3002 return PSA_ERROR_BUFFER_TOO_SMALL;
3003 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003004
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003005 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003006 key, &slot,
3007 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
3008 PSA_KEY_USAGE_SIGN_HASH,
3009 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003010
Gilles Peskine449bd832023-01-11 14:50:10 +01003011 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003012 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003013 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003014
Gilles Peskine449bd832023-01-11 14:50:10 +01003015 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003016 status = PSA_ERROR_INVALID_ARGUMENT;
3017 goto exit;
3018 }
3019
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003020 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003022 };
3023
Gilles Peskine449bd832023-01-11 14:50:10 +01003024 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003025 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003026 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003027 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003028 signature, signature_size, signature_length);
3029 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003030
3031 status = psa_driver_wrapper_sign_hash(
3032 &attributes, slot->key.data, slot->key.bytes,
3033 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003034 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003035 }
3036
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003037
3038exit:
Paul Elliott59200a22023-02-21 15:07:40 +00003039 psa_wipe_tag_output_buffer(signature, status, signature_size,
3040 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003041
Ryan Everett1b70a072024-01-04 10:32:49 +00003042 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003043
Gilles Peskine449bd832023-01-11 14:50:10 +01003044 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003045}
3046
Gilles Peskine449bd832023-01-11 14:50:10 +01003047static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
3048 int input_is_message,
3049 psa_algorithm_t alg,
3050 const uint8_t *input,
3051 size_t input_length,
3052 const uint8_t *signature,
3053 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003054{
3055 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3056 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3057 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003058
Gilles Peskine449bd832023-01-11 14:50:10 +01003059 status = psa_sign_verify_check_alg(input_is_message, alg);
3060 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003061 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003062 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003063
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003064 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003065 key, &slot,
3066 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
3067 PSA_KEY_USAGE_VERIFY_HASH,
3068 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003069
Gilles Peskine449bd832023-01-11 14:50:10 +01003070 if (status != PSA_SUCCESS) {
3071 return status;
3072 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003073
3074 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01003075 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003076 };
3077
Gilles Peskine449bd832023-01-11 14:50:10 +01003078 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003079 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003080 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003081 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 signature, signature_length);
3083 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003084 status = psa_driver_wrapper_verify_hash(
3085 &attributes, slot->key.data, slot->key.bytes,
3086 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003087 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003088 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003089
Ryan Everett1b70a072024-01-04 10:32:49 +00003090 unlock_status = psa_unregister_read(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003091
Gilles Peskine449bd832023-01-11 14:50:10 +01003092 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003093
3094}
3095
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003096psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003097 const psa_key_attributes_t *attributes,
3098 const uint8_t *key_buffer,
3099 size_t key_buffer_size,
3100 psa_algorithm_t alg,
3101 const uint8_t *input,
3102 size_t input_length,
3103 uint8_t *signature,
3104 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01003105 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003106{
3107 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003108
Gilles Peskine449bd832023-01-11 14:50:10 +01003109 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003110 size_t hash_length;
3111 uint8_t hash[PSA_HASH_MAX_SIZE];
3112
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003113 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003114 PSA_ALG_SIGN_GET_HASH(alg),
3115 input, input_length,
3116 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003117
Gilles Peskine449bd832023-01-11 14:50:10 +01003118 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003119 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003120 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003121
3122 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003123 attributes, key_buffer, key_buffer_size,
3124 alg, hash, hash_length,
3125 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003126 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003127
Gilles Peskine449bd832023-01-11 14:50:10 +01003128 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003129}
3130
Gilles Peskine449bd832023-01-11 14:50:10 +01003131psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3132 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003133 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003134 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003135 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003136 size_t signature_size,
3137 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003138{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003139 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3140 LOCAL_INPUT_DECLARE(input_external, input);
3141 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3142
3143 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3144 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3145 status = psa_sign_internal(key, 1, alg, input, input_length, signature,
3146 signature_size, signature_length);
3147
Thomas Daubney3e65f522024-01-30 12:37:25 +00003148#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003149exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003150#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003151 LOCAL_INPUT_FREE(input_external, input);
3152 LOCAL_OUTPUT_FREE(signature_external, signature);
3153 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003154}
3155
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003156psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003157 const psa_key_attributes_t *attributes,
3158 const uint8_t *key_buffer,
3159 size_t key_buffer_size,
3160 psa_algorithm_t alg,
3161 const uint8_t *input,
3162 size_t input_length,
3163 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003164 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003165{
3166 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003167
Gilles Peskine449bd832023-01-11 14:50:10 +01003168 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003169 size_t hash_length;
3170 uint8_t hash[PSA_HASH_MAX_SIZE];
3171
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003172 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003173 PSA_ALG_SIGN_GET_HASH(alg),
3174 input, input_length,
3175 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003176
Gilles Peskine449bd832023-01-11 14:50:10 +01003177 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003178 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003179 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003180
3181 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003182 attributes, key_buffer, key_buffer_size,
3183 alg, hash, hash_length,
3184 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003185 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003186
Gilles Peskine449bd832023-01-11 14:50:10 +01003187 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003188}
3189
Gilles Peskine449bd832023-01-11 14:50:10 +01003190psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3191 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003192 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003193 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003194 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003195 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003196{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003197 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3198 LOCAL_INPUT_DECLARE(input_external, input);
3199 LOCAL_INPUT_DECLARE(signature_external, signature);
3200
3201 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3202 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3203 status = psa_verify_internal(key, 1, alg, input, input_length, signature,
3204 signature_length);
3205
Thomas Daubney3e65f522024-01-30 12:37:25 +00003206#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003207exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003208#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003209 LOCAL_INPUT_FREE(input_external, input);
3210 LOCAL_INPUT_FREE(signature_external, signature);
3211
3212 return status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003213}
3214
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003215psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003216 const psa_key_attributes_t *attributes,
3217 const uint8_t *key_buffer, size_t key_buffer_size,
3218 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003219 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003220{
Gilles Peskine449bd832023-01-11 14:50:10 +01003221 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3222 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3223 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003224#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003225 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3226 return mbedtls_psa_rsa_sign_hash(
3227 attributes,
3228 key_buffer, key_buffer_size,
3229 alg, hash, hash_length,
3230 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003231#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3232 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003233 } else {
3234 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003235 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003236 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3237 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003238#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003239 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3240 return mbedtls_psa_ecdsa_sign_hash(
3241 attributes,
3242 key_buffer, key_buffer_size,
3243 alg, hash, hash_length,
3244 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003245#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3246 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003247 } else {
3248 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003249 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003250 }
Ronald Cron4501c982021-03-19 20:09:32 +01003251
Gilles Peskine449bd832023-01-11 14:50:10 +01003252 (void) key_buffer;
3253 (void) key_buffer_size;
3254 (void) hash;
3255 (void) hash_length;
3256 (void) signature;
3257 (void) signature_size;
3258 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003259
Gilles Peskine449bd832023-01-11 14:50:10 +01003260 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003261}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003262
Gilles Peskine449bd832023-01-11 14:50:10 +01003263psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3264 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003265 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003266 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003267 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003268 size_t signature_size,
3269 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003270{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003271 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3272 LOCAL_INPUT_DECLARE(hash_external, hash);
3273 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3274
3275 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3276 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3277 status = psa_sign_internal(key, 0, alg, hash, hash_length, signature,
3278 signature_size, signature_length);
3279
Thomas Daubney3e65f522024-01-30 12:37:25 +00003280#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003281exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003282#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003283 LOCAL_INPUT_FREE(hash_external, hash);
3284 LOCAL_OUTPUT_FREE(signature_external, signature);
3285
3286 return status;
itayzafrir5c753392018-05-08 11:18:38 +03003287}
3288
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003289psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003290 const psa_key_attributes_t *attributes,
3291 const uint8_t *key_buffer, size_t key_buffer_size,
3292 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003293 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003294{
Gilles Peskine449bd832023-01-11 14:50:10 +01003295 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3296 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3297 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003298#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003299 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3300 return mbedtls_psa_rsa_verify_hash(
3301 attributes,
3302 key_buffer, key_buffer_size,
3303 alg, hash, hash_length,
3304 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003305#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3306 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003307 } else {
3308 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003309 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003310 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3311 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003312#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003313 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3314 return mbedtls_psa_ecdsa_verify_hash(
3315 attributes,
3316 key_buffer, key_buffer_size,
3317 alg, hash, hash_length,
3318 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003319#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3320 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003321 } else {
3322 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003323 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003324 }
Ronald Cron4501c982021-03-19 20:09:32 +01003325
Gilles Peskine449bd832023-01-11 14:50:10 +01003326 (void) key_buffer;
3327 (void) key_buffer_size;
3328 (void) hash;
3329 (void) hash_length;
3330 (void) signature;
3331 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003332
Gilles Peskine449bd832023-01-11 14:50:10 +01003333 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003334}
3335
Gilles Peskine449bd832023-01-11 14:50:10 +01003336psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3337 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003338 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003339 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003340 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003341 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003342{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003343 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3344 LOCAL_INPUT_DECLARE(hash_external, hash);
3345 LOCAL_INPUT_DECLARE(signature_external, signature);
3346
3347 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3348 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3349 status = psa_verify_internal(key, 0, alg, hash, hash_length, signature,
3350 signature_length);
3351
Thomas Daubney3e65f522024-01-30 12:37:25 +00003352#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003353exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003354#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003355 LOCAL_INPUT_FREE(hash_external, hash);
3356 LOCAL_INPUT_FREE(signature_external, signature);
3357
3358 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01003359}
3360
Gilles Peskine449bd832023-01-11 14:50:10 +01003361psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3362 psa_algorithm_t alg,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003363 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003364 size_t input_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003365 const uint8_t *salt_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003366 size_t salt_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003367 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003368 size_t output_size,
3369 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003370{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003371 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003372 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003373 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003374 psa_key_attributes_t attributes;
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003375 LOCAL_INPUT_DECLARE(input_external, input);
3376 LOCAL_INPUT_DECLARE(salt_external, salt);
3377 LOCAL_OUTPUT_DECLARE(output_external, output);
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003378
Darryl Green5cc689a2018-07-24 15:34:10 +01003379 (void) input;
3380 (void) input_length;
3381 (void) salt;
3382 (void) output;
3383 (void) output_size;
3384
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003385 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003386
Gilles Peskine449bd832023-01-11 14:50:10 +01003387 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3388 return PSA_ERROR_INVALID_ARGUMENT;
3389 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003390
Valerio Setti5bb454a2024-01-15 10:43:16 +01003391 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003392 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3393 if (status != PSA_SUCCESS) {
3394 return status;
3395 }
3396 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3397 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003398 status = PSA_ERROR_INVALID_ARGUMENT;
3399 goto exit;
3400 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003401
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003402 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003403 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003404 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003405
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003406 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3407 LOCAL_INPUT_ALLOC(salt_external, salt_length, salt);
3408 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003409 status = psa_driver_wrapper_asymmetric_encrypt(
3410 &attributes, slot->key.data, slot->key.bytes,
3411 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003412 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003413exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003414 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003415
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003416 LOCAL_INPUT_FREE(input_external, input);
3417 LOCAL_INPUT_FREE(salt_external, salt);
3418 LOCAL_OUTPUT_FREE(output_external, output);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003419
Gilles Peskine449bd832023-01-11 14:50:10 +01003420 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003421}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003422
Gilles Peskine449bd832023-01-11 14:50:10 +01003423psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3424 psa_algorithm_t alg,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003425 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003426 size_t input_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003427 const uint8_t *salt_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003428 size_t salt_length,
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003429 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003430 size_t output_size,
3431 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003432{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003433 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003434 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003435 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003436 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003437
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003438 LOCAL_INPUT_DECLARE(input_external, input);
3439 LOCAL_INPUT_DECLARE(salt_external, salt);
3440 LOCAL_OUTPUT_DECLARE(output_external, output);
3441
Darryl Green5cc689a2018-07-24 15:34:10 +01003442 (void) input;
3443 (void) input_length;
3444 (void) salt;
3445 (void) output;
3446 (void) output_size;
3447
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003448 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003449
Gilles Peskine449bd832023-01-11 14:50:10 +01003450 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3451 return PSA_ERROR_INVALID_ARGUMENT;
3452 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003453
Valerio Setti5bb454a2024-01-15 10:43:16 +01003454 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003455 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3456 if (status != PSA_SUCCESS) {
3457 return status;
3458 }
3459 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003460 status = PSA_ERROR_INVALID_ARGUMENT;
3461 goto exit;
3462 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003463
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003464 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003465 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003466 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003467
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003468 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3469 LOCAL_INPUT_ALLOC(salt_external, salt_length, salt);
3470 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003471 status = psa_driver_wrapper_asymmetric_decrypt(
3472 &attributes, slot->key.data, slot->key.bytes,
3473 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003474 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003475
3476exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00003477 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003478
Thomas Daubney6adbb2a2024-01-18 18:10:32 +00003479 LOCAL_INPUT_FREE(input_external, input);
3480 LOCAL_INPUT_FREE(salt_external, salt);
3481 LOCAL_OUTPUT_FREE(output_external, output);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003482
Gilles Peskine449bd832023-01-11 14:50:10 +01003483 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003484}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003485
Paul Elliott9fe12f62022-11-30 19:16:02 +00003486/****************************************************************/
3487/* Asymmetric interruptible cryptography */
3488/****************************************************************/
3489
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003490static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3491
Paul Elliott9fe12f62022-11-30 19:16:02 +00003492void psa_interruptible_set_max_ops(uint32_t max_ops)
3493{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003494 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003495}
3496
3497uint32_t psa_interruptible_get_max_ops(void)
3498{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003499 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003500}
3501
Paul Elliott9fe12f62022-11-30 19:16:02 +00003502uint32_t psa_sign_hash_get_num_ops(
3503 const psa_sign_hash_interruptible_operation_t *operation)
3504{
Paul Elliott296ede92022-12-15 17:00:30 +00003505 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003506}
3507
3508uint32_t psa_verify_hash_get_num_ops(
3509 const psa_verify_hash_interruptible_operation_t *operation)
3510{
Paul Elliott296ede92022-12-15 17:00:30 +00003511 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003512}
3513
Paul Elliott59ad9452022-12-18 15:09:02 +00003514static psa_status_t psa_sign_hash_abort_internal(
3515 psa_sign_hash_interruptible_operation_t *operation)
3516{
3517 if (operation->id == 0) {
3518 /* The object has (apparently) been initialized but it is not (yet)
3519 * in use. It's ok to call abort on such an object, and there's
3520 * nothing to do. */
3521 return PSA_SUCCESS;
3522 }
3523
3524 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3525
3526 status = psa_driver_wrapper_sign_hash_abort(operation);
3527
3528 operation->id = 0;
3529
Paul Elliotte6145dc2023-02-07 12:51:21 +00003530 /* Do not clear either the error_occurred or num_ops elements here as they
3531 * only want to be cleared by the application calling abort, not by abort
3532 * being called at completion of an operation. */
3533
Paul Elliott59ad9452022-12-18 15:09:02 +00003534 return status;
3535}
3536
Paul Elliott9fe12f62022-11-30 19:16:02 +00003537psa_status_t psa_sign_hash_start(
3538 psa_sign_hash_interruptible_operation_t *operation,
3539 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
David Horstmann4a523a62024-03-11 13:32:16 +00003540 const uint8_t *hash_external, size_t hash_length)
Paul Elliott9fe12f62022-11-30 19:16:02 +00003541{
3542 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3543 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3544 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003545 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003546
David Horstmann4a523a62024-03-11 13:32:16 +00003547 LOCAL_INPUT_DECLARE(hash_external, hash);
3548
Paul Elliottc9774412023-02-06 15:14:07 +00003549 /* Check that start has not been previously called, or operation has not
3550 * previously errored. */
3551 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003552 return PSA_ERROR_BAD_STATE;
3553 }
3554
Paul Elliott9fe12f62022-11-30 19:16:02 +00003555 status = psa_sign_verify_check_alg(0, alg);
3556 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003557 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003558 return status;
3559 }
3560
3561 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3562 PSA_KEY_USAGE_SIGN_HASH,
3563 alg);
3564
3565 if (status != PSA_SUCCESS) {
3566 goto exit;
3567 }
3568
3569 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3570 status = PSA_ERROR_INVALID_ARGUMENT;
3571 goto exit;
3572 }
3573
David Horstmann4a523a62024-03-11 13:32:16 +00003574 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3575
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003576 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003577 .core = slot->attr
3578 };
3579
Paul Elliott296ede92022-12-15 17:00:30 +00003580 /* Ensure ops count gets reset, in case of operation re-use. */
3581 operation->num_ops = 0;
3582
Paul Elliott9fe12f62022-11-30 19:16:02 +00003583 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3584 slot->key.data,
3585 slot->key.bytes, alg,
3586 hash, hash_length);
3587exit:
3588
3589 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003590 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003591 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003592 }
3593
Ryan Everett1b70a072024-01-04 10:32:49 +00003594 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003595
Paul Elliottc9774412023-02-06 15:14:07 +00003596 if (unlock_status != PSA_SUCCESS) {
3597 operation->error_occurred = 1;
3598 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003599
David Horstmann4a523a62024-03-11 13:32:16 +00003600 LOCAL_INPUT_FREE(hash_external, hash);
3601
Paul Elliottc9774412023-02-06 15:14:07 +00003602 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003603}
3604
3605
3606psa_status_t psa_sign_hash_complete(
3607 psa_sign_hash_interruptible_operation_t *operation,
David Horstmann4a523a62024-03-11 13:32:16 +00003608 uint8_t *signature_external, size_t signature_size,
Paul Elliott9fe12f62022-11-30 19:16:02 +00003609 size_t *signature_length)
3610{
3611 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3612
David Horstmann4a523a62024-03-11 13:32:16 +00003613 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3614
Paul Elliott9fe12f62022-11-30 19:16:02 +00003615 *signature_length = 0;
3616
Paul Elliottc9774412023-02-06 15:14:07 +00003617 /* Check that start has been called first, and that operation has not
3618 * previously errored. */
3619 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003620 status = PSA_ERROR_BAD_STATE;
3621 goto exit;
3622 }
3623
Paul Elliott096abc42023-02-03 18:33:23 +00003624 /* Immediately reject a zero-length signature buffer. This guarantees that
3625 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003626 if (signature_size == 0) {
3627 status = PSA_ERROR_BUFFER_TOO_SMALL;
3628 goto exit;
3629 }
3630
David Horstmann4a523a62024-03-11 13:32:16 +00003631 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3632
Paul Elliott9fe12f62022-11-30 19:16:02 +00003633 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3634 signature_size,
3635 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003636
Paul Elliott296ede92022-12-15 17:00:30 +00003637 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003638 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003639
Paul Elliottebe225c2023-02-10 14:32:53 +00003640exit:
3641
David Horstmannc5064c82024-03-11 17:02:03 +00003642 if (signature != NULL) {
3643 psa_wipe_tag_output_buffer(signature, status, signature_size,
3644 *signature_length);
3645 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003646
Paul Elliott53bb3122023-02-10 14:22:22 +00003647 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003648 if (status != PSA_SUCCESS) {
3649 operation->error_occurred = 1;
3650 }
3651
Paul Elliott59ad9452022-12-18 15:09:02 +00003652 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003653 }
3654
David Horstmann4a523a62024-03-11 13:32:16 +00003655 LOCAL_OUTPUT_FREE(signature_external, signature);
3656
Paul Elliott9fe12f62022-11-30 19:16:02 +00003657 return status;
3658}
3659
3660psa_status_t psa_sign_hash_abort(
3661 psa_sign_hash_interruptible_operation_t *operation)
3662{
Paul Elliott59ad9452022-12-18 15:09:02 +00003663 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3664
3665 status = psa_sign_hash_abort_internal(operation);
3666
3667 /* We clear the number of ops done here, so that it is not cleared when
3668 * the operation fails or succeeds, only on manual abort. */
3669 operation->num_ops = 0;
3670
Paul Elliottc9774412023-02-06 15:14:07 +00003671 /* Likewise, failure state. */
3672 operation->error_occurred = 0;
3673
Paul Elliott59ad9452022-12-18 15:09:02 +00003674 return status;
3675}
3676
3677static psa_status_t psa_verify_hash_abort_internal(
3678 psa_verify_hash_interruptible_operation_t *operation)
3679{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003680 if (operation->id == 0) {
3681 /* The object has (apparently) been initialized but it is not (yet)
3682 * in use. It's ok to call abort on such an object, and there's
3683 * nothing to do. */
3684 return PSA_SUCCESS;
3685 }
3686
Paul Elliott59ad9452022-12-18 15:09:02 +00003687 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3688
3689 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003690
3691 operation->id = 0;
3692
Paul Elliotte6145dc2023-02-07 12:51:21 +00003693 /* Do not clear either the error_occurred or num_ops elements here as they
3694 * only want to be cleared by the application calling abort, not by abort
3695 * being called at completion of an operation. */
3696
Paul Elliott59ad9452022-12-18 15:09:02 +00003697 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003698}
3699
3700psa_status_t psa_verify_hash_start(
3701 psa_verify_hash_interruptible_operation_t *operation,
3702 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
David Horstmann0fea6a52024-03-11 13:41:05 +00003703 const uint8_t *hash_external, size_t hash_length,
3704 const uint8_t *signature_external, size_t signature_length)
Paul Elliott9fe12f62022-11-30 19:16:02 +00003705{
3706 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3707 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3708 psa_key_slot_t *slot;
3709
David Horstmann0fea6a52024-03-11 13:41:05 +00003710 LOCAL_INPUT_DECLARE(hash_external, hash);
3711 LOCAL_INPUT_DECLARE(signature_external, signature);
3712
Paul Elliottc9774412023-02-06 15:14:07 +00003713 /* Check that start has not been previously called, or operation has not
3714 * previously errored. */
3715 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003716 return PSA_ERROR_BAD_STATE;
3717 }
3718
3719 status = psa_sign_verify_check_alg(0, alg);
3720 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003721 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003722 return status;
3723 }
3724
3725 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3726 PSA_KEY_USAGE_VERIFY_HASH,
3727 alg);
3728
3729 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003730 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003731 return status;
3732 }
3733
David Horstmann0fea6a52024-03-11 13:41:05 +00003734 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3735 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3736
Paul Elliott9fe12f62022-11-30 19:16:02 +00003737 psa_key_attributes_t attributes = {
3738 .core = slot->attr
3739 };
3740
Paul Elliott296ede92022-12-15 17:00:30 +00003741 /* Ensure ops count gets reset, in case of operation re-use. */
3742 operation->num_ops = 0;
3743
Paul Elliott9fe12f62022-11-30 19:16:02 +00003744 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3745 slot->key.data,
3746 slot->key.bytes,
3747 alg, hash, hash_length,
3748 signature, signature_length);
David Horstmann0fea6a52024-03-11 13:41:05 +00003749#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
3750exit:
3751#endif
Paul Elliott9fe12f62022-11-30 19:16:02 +00003752
3753 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003754 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003755 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003756 }
3757
Ryan Everett1b70a072024-01-04 10:32:49 +00003758 unlock_status = psa_unregister_read(slot);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003759
Paul Elliottc9774412023-02-06 15:14:07 +00003760 if (unlock_status != PSA_SUCCESS) {
3761 operation->error_occurred = 1;
3762 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003763
David Horstmann0fea6a52024-03-11 13:41:05 +00003764 LOCAL_INPUT_FREE(hash_external, hash);
3765 LOCAL_INPUT_FREE(signature_external, signature);
3766
Paul Elliottc9774412023-02-06 15:14:07 +00003767 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003768}
3769
3770psa_status_t psa_verify_hash_complete(
3771 psa_verify_hash_interruptible_operation_t *operation)
3772{
3773 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3774
Paul Elliottc9774412023-02-06 15:14:07 +00003775 /* Check that start has been called first, and that operation has not
3776 * previously errored. */
3777 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003778 status = PSA_ERROR_BAD_STATE;
3779 goto exit;
3780 }
3781
3782 status = psa_driver_wrapper_verify_hash_complete(operation);
3783
Paul Elliott296ede92022-12-15 17:00:30 +00003784 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003785 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003786 operation);
3787
Paul Elliottebe225c2023-02-10 14:32:53 +00003788exit:
3789
Paul Elliott9fe12f62022-11-30 19:16:02 +00003790 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003791 if (status != PSA_SUCCESS) {
3792 operation->error_occurred = 1;
3793 }
3794
Paul Elliott59ad9452022-12-18 15:09:02 +00003795 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003796 }
3797
3798 return status;
3799}
3800
3801psa_status_t psa_verify_hash_abort(
3802 psa_verify_hash_interruptible_operation_t *operation)
3803{
Paul Elliott59ad9452022-12-18 15:09:02 +00003804 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003805
Paul Elliott59ad9452022-12-18 15:09:02 +00003806 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003807
Paul Elliott59ad9452022-12-18 15:09:02 +00003808 /* We clear the number of ops done here, so that it is not cleared when
3809 * the operation fails or succeeds, only on manual abort. */
3810 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003811
Paul Elliottc9774412023-02-06 15:14:07 +00003812 /* Likewise, failure state. */
3813 operation->error_occurred = 0;
3814
Paul Elliott59ad9452022-12-18 15:09:02 +00003815 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003816}
3817
Paul Elliott588f8ed2022-12-02 18:10:26 +00003818/****************************************************************/
3819/* Asymmetric interruptible cryptography internal */
3820/* implementations */
3821/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003822
Paul Elliott588f8ed2022-12-02 18:10:26 +00003823void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3824{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003825
Paul Elliott588f8ed2022-12-02 18:10:26 +00003826#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3827 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3828 defined(MBEDTLS_ECP_RESTARTABLE)
3829
3830 /* Internal implementation uses zero to indicate infinite number max ops,
3831 * therefore avoid this value, and set to minimum possible. */
3832 if (max_ops == 0) {
3833 max_ops = 1;
3834 }
3835
Paul Elliott588f8ed2022-12-02 18:10:26 +00003836 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003837#else
3838 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003839#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3840 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3841 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3842}
3843
Paul Elliott588f8ed2022-12-02 18:10:26 +00003844uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003845 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003846{
3847#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3848 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3849 defined(MBEDTLS_ECP_RESTARTABLE)
3850
Paul Elliott93d9ca82023-02-15 18:14:21 +00003851 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003852#else
3853 (void) operation;
3854 return 0;
3855#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3856 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3857 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3858}
3859
3860uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003861 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003862{
3863 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3864 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3865 defined(MBEDTLS_ECP_RESTARTABLE)
3866
Paul Elliott93d9ca82023-02-15 18:14:21 +00003867 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003868#else
3869 (void) operation;
3870 return 0;
3871#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3872 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3873 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3874}
3875
3876psa_status_t mbedtls_psa_sign_hash_start(
3877 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3878 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3879 size_t key_buffer_size, psa_algorithm_t alg,
3880 const uint8_t *hash, size_t hash_length)
3881{
3882 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003883 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003884
Paul Elliott068fe072023-01-16 13:59:15 +00003885 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3886 return PSA_ERROR_NOT_SUPPORTED;
3887 }
3888
3889 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003890 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003891 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003892
3893#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003894 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3895 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003896
Paul Elliotta1c94092023-02-15 16:38:04 +00003897 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3898
Paul Elliott93d9ca82023-02-15 18:14:21 +00003899 /* Ensure num_ops is zero'ed in case of context re-use. */
3900 operation->num_ops = 0;
3901
Paul Elliott068fe072023-01-16 13:59:15 +00003902 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3903 attributes->core.bits,
3904 key_buffer,
3905 key_buffer_size,
3906 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003907
Paul Elliott068fe072023-01-16 13:59:15 +00003908 if (status != PSA_SUCCESS) {
3909 return status;
3910 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003911
Paul Elliott1bc59df2023-02-05 13:41:57 +00003912 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003913 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003914
Paul Elliott068fe072023-01-16 13:59:15 +00003915 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003916 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003917 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003918
Paul Elliott0290a762023-02-09 14:30:24 +00003919 /* We only need to store the same length of hash as the private key size
3920 * here, it would be truncated by the internal implementation anyway. */
3921 required_hash_length = (hash_length < operation->coordinate_bytes ?
3922 hash_length : operation->coordinate_bytes);
3923
Paul Elliottba70ad42023-02-15 18:23:53 +00003924 if (required_hash_length > sizeof(operation->hash)) {
3925 /* Shouldn't happen, but better safe than sorry. */
3926 return PSA_ERROR_CORRUPTION_DETECTED;
3927 }
3928
Paul Elliott0290a762023-02-09 14:30:24 +00003929 memcpy(operation->hash, hash, required_hash_length);
3930 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003931
3932 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003933
3934#else
Paul Elliott068fe072023-01-16 13:59:15 +00003935 (void) operation;
3936 (void) key_buffer;
3937 (void) key_buffer_size;
3938 (void) alg;
3939 (void) hash;
3940 (void) hash_length;
3941 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003942 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003943
Paul Elliott068fe072023-01-16 13:59:15 +00003944 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003945#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3946 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3947 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003948}
3949
3950psa_status_t mbedtls_psa_sign_hash_complete(
3951 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3952 uint8_t *signature, size_t signature_size,
3953 size_t *signature_length)
3954{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003955#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3956 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3957 defined(MBEDTLS_ECP_RESTARTABLE)
3958
Paul Elliotta1c94092023-02-15 16:38:04 +00003959 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003960 mbedtls_mpi r;
3961 mbedtls_mpi s;
3962
Paul Elliott46845252023-02-03 14:59:11 +00003963 mbedtls_mpi_init(&r);
3964 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003965
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003966 /* Ensure max_ops is set to the current value (or default). */
3967 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3968
Paul Elliotta1c94092023-02-15 16:38:04 +00003969 if (signature_size < 2 * operation->coordinate_bytes) {
3970 status = PSA_ERROR_BUFFER_TOO_SMALL;
3971 goto exit;
3972 }
3973
Paul Elliott588f8ed2022-12-02 18:10:26 +00003974 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003975
Paul Elliott588f8ed2022-12-02 18:10:26 +00003976#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3977 status = mbedtls_to_psa_error(
3978 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003979 &r,
3980 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003981 &operation->ctx->d,
3982 operation->hash,
3983 operation->hash_length,
3984 operation->md_alg,
3985 mbedtls_psa_get_random,
3986 MBEDTLS_PSA_RANDOM_STATE,
3987 &operation->restart_ctx));
3988#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003989 status = PSA_ERROR_NOT_SUPPORTED;
3990 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003991#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3992 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003993 status = mbedtls_to_psa_error(
3994 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003995 &r,
3996 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003997 &operation->ctx->d,
3998 operation->hash,
3999 operation->hash_length,
4000 mbedtls_psa_get_random,
4001 MBEDTLS_PSA_RANDOM_STATE,
4002 mbedtls_psa_get_random,
4003 MBEDTLS_PSA_RANDOM_STATE,
4004 &operation->restart_ctx));
4005 }
4006
Paul Elliottf8e5b562023-02-19 18:43:45 +00004007 /* Hide the fact that the restart context only holds a delta of number of
4008 * ops done during the last operation, not an absolute value. */
4009 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4010
Paul Elliott724bd252023-02-08 12:35:08 +00004011 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00004012 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00004013 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004014 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004015 operation->coordinate_bytes)
4016 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00004017
4018 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00004019 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004020 }
4021
4022 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00004023 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004024 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004025 operation->coordinate_bytes,
4026 operation->coordinate_bytes)
4027 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00004028
4029 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00004030 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004031 }
4032
Paul Elliott1bc59df2023-02-05 13:41:57 +00004033 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004034
Paul Elliott724bd252023-02-08 12:35:08 +00004035 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004036 }
Paul Elliott724bd252023-02-08 12:35:08 +00004037
4038exit:
4039
4040 mbedtls_mpi_free(&r);
4041 mbedtls_mpi_free(&s);
4042 return status;
4043
Paul Elliott588f8ed2022-12-02 18:10:26 +00004044 #else
4045
4046 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004047 (void) signature;
4048 (void) signature_size;
4049 (void) signature_length;
4050
4051 return PSA_ERROR_NOT_SUPPORTED;
4052
4053#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4054 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4055 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4056}
4057
4058psa_status_t mbedtls_psa_sign_hash_abort(
4059 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
4060{
4061
4062#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4063 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4064 defined(MBEDTLS_ECP_RESTARTABLE)
4065
4066 if (operation->ctx) {
4067 mbedtls_ecdsa_free(operation->ctx);
4068 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004069 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004070 }
4071
4072 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4073
Paul Elliott93d9ca82023-02-15 18:14:21 +00004074 operation->num_ops = 0;
4075
Paul Elliott588f8ed2022-12-02 18:10:26 +00004076 return PSA_SUCCESS;
4077
4078#else
4079
4080 (void) operation;
4081
4082 return PSA_ERROR_NOT_SUPPORTED;
4083
4084#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4085 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4086 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4087}
4088
4089psa_status_t mbedtls_psa_verify_hash_start(
4090 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
4091 const psa_key_attributes_t *attributes,
4092 const uint8_t *key_buffer, size_t key_buffer_size,
4093 psa_algorithm_t alg,
4094 const uint8_t *hash, size_t hash_length,
4095 const uint8_t *signature, size_t signature_length)
4096{
4097 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00004098 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00004099 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004100
Paul Elliott068fe072023-01-16 13:59:15 +00004101 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
4102 return PSA_ERROR_NOT_SUPPORTED;
4103 }
4104
4105 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00004106 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00004107 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004108
4109#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00004110 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4111 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00004112
Paul Elliotta1c94092023-02-15 16:38:04 +00004113 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
4114 mbedtls_mpi_init(&operation->r);
4115 mbedtls_mpi_init(&operation->s);
4116
Paul Elliott93d9ca82023-02-15 18:14:21 +00004117 /* Ensure num_ops is zero'ed in case of context re-use. */
4118 operation->num_ops = 0;
4119
Paul Elliott068fe072023-01-16 13:59:15 +00004120 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
4121 attributes->core.bits,
4122 key_buffer,
4123 key_buffer_size,
4124 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004125
Paul Elliott068fe072023-01-16 13:59:15 +00004126 if (status != PSA_SUCCESS) {
4127 return status;
4128 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004129
Paul Elliottc569fc22023-02-10 13:02:54 +00004130 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004131
Paul Elliott1bc59df2023-02-05 13:41:57 +00004132 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004133 return PSA_ERROR_INVALID_SIGNATURE;
4134 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004135
Paul Elliott068fe072023-01-16 13:59:15 +00004136 status = mbedtls_to_psa_error(
4137 mbedtls_mpi_read_binary(&operation->r,
4138 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004139 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004140
Paul Elliott068fe072023-01-16 13:59:15 +00004141 if (status != PSA_SUCCESS) {
4142 return status;
4143 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004144
Paul Elliott068fe072023-01-16 13:59:15 +00004145 status = mbedtls_to_psa_error(
4146 mbedtls_mpi_read_binary(&operation->s,
4147 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004148 coordinate_bytes,
4149 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004150
Paul Elliott068fe072023-01-16 13:59:15 +00004151 if (status != PSA_SUCCESS) {
4152 return status;
4153 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004154
Paul Elliott2c9843f2023-02-15 17:32:42 +00004155 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004156
Paul Elliott2c9843f2023-02-15 17:32:42 +00004157 if (status != PSA_SUCCESS) {
4158 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004159 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004160
Paul Elliott0290a762023-02-09 14:30:24 +00004161 /* We only need to store the same length of hash as the private key size
4162 * here, it would be truncated by the internal implementation anyway. */
4163 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4164 coordinate_bytes);
4165
Paul Elliottba70ad42023-02-15 18:23:53 +00004166 if (required_hash_length > sizeof(operation->hash)) {
4167 /* Shouldn't happen, but better safe than sorry. */
4168 return PSA_ERROR_CORRUPTION_DETECTED;
4169 }
4170
Paul Elliott0290a762023-02-09 14:30:24 +00004171 memcpy(operation->hash, hash, required_hash_length);
4172 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004173
4174 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004175#else
Paul Elliott068fe072023-01-16 13:59:15 +00004176 (void) operation;
4177 (void) key_buffer;
4178 (void) key_buffer_size;
4179 (void) alg;
4180 (void) hash;
4181 (void) hash_length;
4182 (void) signature;
4183 (void) signature_length;
4184 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004185 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004186 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004187
Paul Elliott068fe072023-01-16 13:59:15 +00004188 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004189#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4190 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4191 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004192}
4193
4194psa_status_t mbedtls_psa_verify_hash_complete(
4195 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4196{
4197
4198#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4199 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4200 defined(MBEDTLS_ECP_RESTARTABLE)
4201
Paul Elliottf8e5b562023-02-19 18:43:45 +00004202 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4203
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004204 /* Ensure max_ops is set to the current value (or default). */
4205 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4206
Paul Elliottf8e5b562023-02-19 18:43:45 +00004207 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004208 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4209 operation->hash,
4210 operation->hash_length,
4211 &operation->ctx->Q,
4212 &operation->r,
4213 &operation->s,
4214 &operation->restart_ctx));
4215
Paul Elliottf8e5b562023-02-19 18:43:45 +00004216 /* Hide the fact that the restart context only holds a delta of number of
4217 * ops done during the last operation, not an absolute value. */
4218 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4219
4220 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004221#else
4222 (void) operation;
4223
4224 return PSA_ERROR_NOT_SUPPORTED;
4225
4226#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4227 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4228 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4229}
4230
4231psa_status_t mbedtls_psa_verify_hash_abort(
4232 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4233{
4234
4235#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4236 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4237 defined(MBEDTLS_ECP_RESTARTABLE)
4238
4239 if (operation->ctx) {
4240 mbedtls_ecdsa_free(operation->ctx);
4241 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004242 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004243 }
4244
4245 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4246
Paul Elliott93d9ca82023-02-15 18:14:21 +00004247 operation->num_ops = 0;
4248
Paul Elliott588f8ed2022-12-02 18:10:26 +00004249 mbedtls_mpi_free(&operation->r);
4250 mbedtls_mpi_free(&operation->s);
4251
4252 return PSA_SUCCESS;
4253
4254#else
4255 (void) operation;
4256
4257 return PSA_ERROR_NOT_SUPPORTED;
4258
4259#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4260 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4261 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4262}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004263
David Horstmann6e99bb22024-02-06 15:27:49 +00004264static psa_status_t psa_generate_random_internal(uint8_t *output,
4265 size_t output_size)
4266{
4267 GUARD_MODULE_INITIALIZED;
4268
4269 psa_status_t status;
4270
4271#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
4272
4273 size_t output_length = 0;
4274 status = mbedtls_psa_external_get_random(&global_data.rng,
4275 output, output_size,
4276 &output_length);
4277 if (status != PSA_SUCCESS) {
4278 goto exit;
4279 }
4280 /* Breaking up a request into smaller chunks is currently not supported
4281 * for the external RNG interface. */
4282 if (output_length != output_size) {
4283 status = PSA_ERROR_INSUFFICIENT_ENTROPY;
4284 goto exit;
4285 }
4286 status = PSA_SUCCESS;
4287
4288#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4289
4290 while (output_size > 0) {
4291 size_t request_size =
4292 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
4293 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
4294 output_size);
4295 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
4296 output, request_size);
4297 if (ret != 0) {
4298 status = mbedtls_to_psa_error(ret);
4299 goto exit;
4300 }
4301 output_size -= request_size;
4302 output += request_size;
4303 }
4304 status = PSA_SUCCESS;
4305#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
4306
4307exit:
4308 return status;
4309}
4310
4311
mohammad1603503973b2018-03-12 15:59:30 +02004312/****************************************************************/
4313/* Symmetric cryptography */
4314/****************************************************************/
4315
Gilles Peskine449bd832023-01-11 14:50:10 +01004316static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4317 mbedtls_svc_key_id_t key,
4318 psa_algorithm_t alg,
4319 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004320{
4321 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4322 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004323 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004324 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4325 PSA_KEY_USAGE_ENCRYPT :
4326 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004327 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004328
4329 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004330 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004331 status = PSA_ERROR_BAD_STATE;
4332 goto exit;
4333 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004334
Gilles Peskine449bd832023-01-11 14:50:10 +01004335 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004336 status = PSA_ERROR_INVALID_ARGUMENT;
4337 goto exit;
4338 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004339
Gilles Peskine449bd832023-01-11 14:50:10 +01004340 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4341 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004342 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004343 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004344
Ronald Cron49fafa92021-03-10 08:34:23 +01004345 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004346 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004347 * so we only set it (in the driver wrapper) after resources have been
4348 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004349 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004350 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004351 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004352 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004353 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004354 }
4355 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004356
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004357 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004358 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004359 };
4360
Ronald Cronab99ac22020-10-01 16:38:28 +02004361 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004362 if (cipher_operation == MBEDTLS_ENCRYPT) {
4363 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4364 &attributes,
4365 slot->key.data,
4366 slot->key.bytes,
4367 alg);
4368 } else {
4369 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4370 &attributes,
4371 slot->key.data,
4372 slot->key.bytes,
4373 alg);
4374 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004375
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004376exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004377 if (status != PSA_SUCCESS) {
4378 psa_cipher_abort(operation);
4379 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004380
Ryan Everett1b70a072024-01-04 10:32:49 +00004381 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004382
Gilles Peskine449bd832023-01-11 14:50:10 +01004383 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004384}
4385
Gilles Peskine449bd832023-01-11 14:50:10 +01004386psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4387 mbedtls_svc_key_id_t key,
4388 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004389{
Gilles Peskine449bd832023-01-11 14:50:10 +01004390 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004391}
4392
Gilles Peskine449bd832023-01-11 14:50:10 +01004393psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4394 mbedtls_svc_key_id_t key,
4395 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004396{
Gilles Peskine449bd832023-01-11 14:50:10 +01004397 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004398}
4399
Gilles Peskine449bd832023-01-11 14:50:10 +01004400psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
Gabor Mezei358eb212024-02-07 18:10:13 +01004401 uint8_t *iv_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004402 size_t iv_size,
4403 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004404{
Ronald Cron6d051732020-10-01 14:10:20 +02004405 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Sergeybef1f632023-03-06 15:25:06 -07004406 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004407
Gabor Mezei358eb212024-02-07 18:10:13 +01004408 LOCAL_OUTPUT_DECLARE(iv_external, iv);
4409
Gilles Peskine449bd832023-01-11 14:50:10 +01004410 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004411 status = PSA_ERROR_BAD_STATE;
4412 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004413 }
4414
Gilles Peskine449bd832023-01-11 14:50:10 +01004415 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004416 status = PSA_ERROR_BAD_STATE;
4417 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004418 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004419
Ronald Cron2fb90522021-07-05 12:31:44 +02004420 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004421 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004422 status = PSA_ERROR_BUFFER_TOO_SMALL;
4423 goto exit;
4424 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004425
Gilles Peskine449bd832023-01-11 14:50:10 +01004426 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004427 status = PSA_ERROR_GENERIC_ERROR;
4428 goto exit;
4429 }
4430
Gabor Mezei358eb212024-02-07 18:10:13 +01004431 LOCAL_OUTPUT_ALLOC(iv_external, default_iv_length, iv);
4432
Gabor Mezei1b5b58d2024-03-04 17:15:08 +01004433 status = psa_generate_random_internal(iv, default_iv_length);
Gilles Peskine449bd832023-01-11 14:50:10 +01004434 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004435 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004436 }
Ronald Cron5618a392021-03-26 09:52:26 +01004437
Gilles Peskine449bd832023-01-11 14:50:10 +01004438 status = psa_driver_wrapper_cipher_set_iv(operation,
Gabor Mezei358eb212024-02-07 18:10:13 +01004439 iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004440
4441exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004442 if (status == PSA_SUCCESS) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004443 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004444 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004445 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004446 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004447 psa_cipher_abort(operation);
Gabor Mezei358eb212024-02-07 18:10:13 +01004448 if (iv != NULL) {
4449 mbedtls_platform_zeroize(iv, default_iv_length);
4450 }
Ronald Cron2fb90522021-07-05 12:31:44 +02004451 }
Ronald Cron6d051732020-10-01 14:10:20 +02004452
Gabor Mezei358eb212024-02-07 18:10:13 +01004453 LOCAL_OUTPUT_FREE(iv_external, iv);
Gilles Peskine449bd832023-01-11 14:50:10 +01004454 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004455}
4456
Gilles Peskine449bd832023-01-11 14:50:10 +01004457psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004458 const uint8_t *iv_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004459 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004460{
Ronald Cron6d051732020-10-01 14:10:20 +02004461 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004462
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004463 LOCAL_INPUT_DECLARE(iv_external, iv);
4464
Gilles Peskine449bd832023-01-11 14:50:10 +01004465 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004466 status = PSA_ERROR_BAD_STATE;
4467 goto exit;
4468 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004469
Gilles Peskine449bd832023-01-11 14:50:10 +01004470 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004471 status = PSA_ERROR_BAD_STATE;
4472 goto exit;
4473 }
Ronald Crona0d68172021-03-26 10:15:08 +01004474
Gilles Peskine449bd832023-01-11 14:50:10 +01004475 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004476 status = PSA_ERROR_INVALID_ARGUMENT;
4477 goto exit;
4478 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004479
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004480 LOCAL_INPUT_ALLOC(iv_external, iv_length, iv);
4481
Gilles Peskine449bd832023-01-11 14:50:10 +01004482 status = psa_driver_wrapper_cipher_set_iv(operation,
4483 iv,
4484 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004485
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004486exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004487 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004488 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004489 } else {
4490 psa_cipher_abort(operation);
4491 }
Gabor Mezei7abf8ee2024-02-01 10:39:26 +01004492
4493 LOCAL_INPUT_FREE(iv_external, iv);
4494
Gilles Peskine449bd832023-01-11 14:50:10 +01004495 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004496}
4497
Gilles Peskine449bd832023-01-11 14:50:10 +01004498psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
Gabor Mezei212eb082024-01-24 16:56:00 +01004499 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004500 size_t input_length,
Gabor Mezei212eb082024-01-24 16:56:00 +01004501 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 size_t output_size,
4503 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004504{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004505 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004506
Gabor Mezei212eb082024-01-24 16:56:00 +01004507 LOCAL_INPUT_DECLARE(input_external, input);
4508 LOCAL_OUTPUT_DECLARE(output_external, output);
4509
Gilles Peskine449bd832023-01-11 14:50:10 +01004510 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004511 status = PSA_ERROR_BAD_STATE;
4512 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004513 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004514
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004516 status = PSA_ERROR_BAD_STATE;
4517 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004518 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004519
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004520 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Gabor Mezei0b041162024-02-29 10:08:16 +00004521 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004522
Gilles Peskine449bd832023-01-11 14:50:10 +01004523 status = psa_driver_wrapper_cipher_update(operation,
4524 input,
4525 input_length,
4526 output,
4527 output_size,
4528 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004529
4530exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004531 if (status != PSA_SUCCESS) {
4532 psa_cipher_abort(operation);
4533 }
Ronald Cron6d051732020-10-01 14:10:20 +02004534
Gabor Mezei212eb082024-01-24 16:56:00 +01004535 LOCAL_INPUT_FREE(input_external, input);
4536 LOCAL_OUTPUT_FREE(output_external, output);
4537
Gilles Peskine449bd832023-01-11 14:50:10 +01004538 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004539}
4540
Gilles Peskine449bd832023-01-11 14:50:10 +01004541psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
Gabor Mezei212eb082024-01-24 16:56:00 +01004542 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004543 size_t output_size,
4544 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004545{
David Saadab4ecc272019-02-14 13:48:10 +02004546 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004547
Gabor Mezei212eb082024-01-24 16:56:00 +01004548 LOCAL_OUTPUT_DECLARE(output_external, output);
4549
Gilles Peskine449bd832023-01-11 14:50:10 +01004550 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004551 status = PSA_ERROR_BAD_STATE;
4552 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004553 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004554
Gilles Peskine449bd832023-01-11 14:50:10 +01004555 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004556 status = PSA_ERROR_BAD_STATE;
4557 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004558 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004559
Gabor Mezei0b041162024-02-29 10:08:16 +00004560 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004561
Gilles Peskine449bd832023-01-11 14:50:10 +01004562 status = psa_driver_wrapper_cipher_finish(operation,
4563 output,
4564 output_size,
4565 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004566
4567exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004568 if (status == PSA_SUCCESS) {
Gabor Mezei212eb082024-01-24 16:56:00 +01004569 status = psa_cipher_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01004570 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004571 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004572 (void) psa_cipher_abort(operation);
Steven Cooremanef8575e2020-09-11 11:44:50 +02004573 }
Gabor Mezei212eb082024-01-24 16:56:00 +01004574
4575 LOCAL_OUTPUT_FREE(output_external, output);
4576
4577 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004578}
4579
Gilles Peskine449bd832023-01-11 14:50:10 +01004580psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004581{
Gilles Peskine449bd832023-01-11 14:50:10 +01004582 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004583 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004584 * in use. It's ok to call abort on such an object, and there's
4585 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004586 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004587 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004588
Gilles Peskine449bd832023-01-11 14:50:10 +01004589 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004590
Ronald Cron49fafa92021-03-10 08:34:23 +01004591 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004592 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004593 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004594
Gilles Peskine449bd832023-01-11 14:50:10 +01004595 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004596}
4597
Gilles Peskine449bd832023-01-11 14:50:10 +01004598psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4599 psa_algorithm_t alg,
David Horstmann36df4b22023-12-13 15:55:25 +00004600 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004601 size_t input_length,
David Horstmann36df4b22023-12-13 15:55:25 +00004602 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 size_t output_size,
4604 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004605{
4606 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004607 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004608 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004609 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4610 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004611 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004612
David Horstmann62a56d92023-12-14 18:12:47 +00004613 LOCAL_INPUT_DECLARE(input_external, input);
4614 LOCAL_OUTPUT_DECLARE(output_external, output);
4615
Gilles Peskine449bd832023-01-11 14:50:10 +01004616 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004617 status = PSA_ERROR_INVALID_ARGUMENT;
4618 goto exit;
4619 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004620
Gilles Peskine449bd832023-01-11 14:50:10 +01004621 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4622 PSA_KEY_USAGE_ENCRYPT,
4623 alg);
4624 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004625 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004626 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004627
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004628 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004630 };
4631
Gilles Peskine449bd832023-01-11 14:50:10 +01004632 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4633 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004634 status = PSA_ERROR_GENERIC_ERROR;
4635 goto exit;
4636 }
4637
Gilles Peskine449bd832023-01-11 14:50:10 +01004638 if (default_iv_length > 0) {
4639 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004640 status = PSA_ERROR_BUFFER_TOO_SMALL;
4641 goto exit;
4642 }
4643
David Horstmann6e99bb22024-02-06 15:27:49 +00004644 status = psa_generate_random_internal(local_iv, default_iv_length);
Gilles Peskine449bd832023-01-11 14:50:10 +01004645 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004646 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004648 }
4649
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004650 LOCAL_INPUT_ALLOC(input_external, input_length, input);
4651 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
4652
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004653 status = psa_driver_wrapper_cipher_encrypt(
4654 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004655 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004656 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004658
4659exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004660 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004661 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004662 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004663 }
Ronald Cron23919522021-07-08 19:00:07 +02004664
Gilles Peskine449bd832023-01-11 14:50:10 +01004665 if (status == PSA_SUCCESS) {
4666 if (default_iv_length > 0) {
4667 memcpy(output, local_iv, default_iv_length);
4668 }
4669 *output_length += default_iv_length;
4670 } else {
4671 *output_length = 0;
4672 }
4673
David Horstmann62a56d92023-12-14 18:12:47 +00004674 LOCAL_INPUT_FREE(input_external, input);
4675 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004676
Gilles Peskine449bd832023-01-11 14:50:10 +01004677 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004678}
4679
Gilles Peskine449bd832023-01-11 14:50:10 +01004680psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4681 psa_algorithm_t alg,
Gabor Mezei212eb082024-01-24 16:56:00 +01004682 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004683 size_t input_length,
Gabor Mezei212eb082024-01-24 16:56:00 +01004684 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004685 size_t output_size,
4686 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004687{
4688 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004689 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004690 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004691 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004692
Gabor Mezei212eb082024-01-24 16:56:00 +01004693 LOCAL_INPUT_DECLARE(input_external, input);
4694 LOCAL_OUTPUT_DECLARE(output_external, output);
4695
Gilles Peskine449bd832023-01-11 14:50:10 +01004696 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004697 status = PSA_ERROR_INVALID_ARGUMENT;
4698 goto exit;
4699 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004700
Gilles Peskine449bd832023-01-11 14:50:10 +01004701 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4702 PSA_KEY_USAGE_DECRYPT,
4703 alg);
4704 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004705 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004706 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004707
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004708 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004709 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004710 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004711
Gilles Peskine449bd832023-01-11 14:50:10 +01004712 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4713 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004714 status = PSA_ERROR_INVALID_ARGUMENT;
4715 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004716 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004717 status = PSA_ERROR_INVALID_ARGUMENT;
4718 goto exit;
4719 }
4720
Gabor Mezei8b8e4852024-01-31 17:45:29 +01004721 LOCAL_INPUT_ALLOC(input_external, input_length, input);
4722 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
4723
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004724 status = psa_driver_wrapper_cipher_decrypt(
4725 &attributes, slot->key.data, slot->key.bytes,
4726 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004727 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004728
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004729exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00004730 unlock_status = psa_unregister_read(slot);
Gilles Peskine449bd832023-01-11 14:50:10 +01004731 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004732 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004733 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004734
Gilles Peskine449bd832023-01-11 14:50:10 +01004735 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004736 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004737 }
Ronald Cron23919522021-07-08 19:00:07 +02004738
Gabor Mezei212eb082024-01-24 16:56:00 +01004739 LOCAL_INPUT_FREE(input_external, input);
4740 LOCAL_OUTPUT_FREE(output_external, output);
4741
Gilles Peskine449bd832023-01-11 14:50:10 +01004742 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004743}
4744
4745
mohammad16035955c982018-04-26 00:53:03 +03004746/****************************************************************/
4747/* AEAD */
4748/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004749
Paul Elliottbaff51c2021-09-28 17:44:45 +01004750/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004751static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004752{
Gilles Peskine449bd832023-01-11 14:50:10 +01004753 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004754}
4755
4756/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004757static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4758 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004759{
Gilles Peskine449bd832023-01-11 14:50:10 +01004760 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004761
Gilles Peskine449bd832023-01-11 14:50:10 +01004762 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004763#if defined(PSA_WANT_ALG_GCM)
4764 case PSA_ALG_GCM:
4765 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004766 * arbitrarily large nonces. Please note that we do not generally
4767 * recommend the usage of nonces of greater length than
4768 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4769 * size, which can then lead to collisions if you encrypt a very
4770 * large number of messages.*/
4771 if (nonce_length != 0) {
4772 return PSA_SUCCESS;
4773 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004774 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004775#endif /* PSA_WANT_ALG_GCM */
4776#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004777 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004778 if (nonce_length >= 7 && nonce_length <= 13) {
4779 return PSA_SUCCESS;
4780 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004781 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004782#endif /* PSA_WANT_ALG_CCM */
4783#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004784 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004785 if (nonce_length == 12) {
4786 return PSA_SUCCESS;
4787 } else if (nonce_length == 8) {
4788 return PSA_ERROR_NOT_SUPPORTED;
4789 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004790 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004791#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004792 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004793 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004794 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004795 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004796
Gilles Peskine449bd832023-01-11 14:50:10 +01004797 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004798}
4799
Gilles Peskine449bd832023-01-11 14:50:10 +01004800static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004801{
Gilles Peskine449bd832023-01-11 14:50:10 +01004802 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4803 return PSA_ERROR_INVALID_ARGUMENT;
4804 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004805
Gilles Peskine449bd832023-01-11 14:50:10 +01004806 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004807}
4808
Gilles Peskine449bd832023-01-11 14:50:10 +01004809psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4810 psa_algorithm_t alg,
David Horstmann9d09a022023-11-28 19:25:00 +00004811 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004812 size_t nonce_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004813 const uint8_t *additional_data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004814 size_t additional_data_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004815 const uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 size_t plaintext_length,
David Horstmann9d09a022023-11-28 19:25:00 +00004817 uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004818 size_t ciphertext_size,
4819 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004820{
Ronald Cron215633c2021-03-16 17:15:37 +01004821 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4822 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004823
David Horstmann9d09a022023-11-28 19:25:00 +00004824 LOCAL_INPUT_DECLARE(nonce_external, nonce);
4825 LOCAL_INPUT_DECLARE(additional_data_external, additional_data);
4826 LOCAL_INPUT_DECLARE(plaintext_external, plaintext);
4827 LOCAL_OUTPUT_DECLARE(ciphertext_external, ciphertext);
4828
mohammad1603f08a5502018-06-03 15:05:47 +03004829 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004830
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 status = psa_aead_check_algorithm(alg);
4832 if (status != PSA_SUCCESS) {
4833 return status;
4834 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004835
Ronald Cron9a986162021-03-26 12:40:07 +01004836 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004837 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4838 if (status != PSA_SUCCESS) {
4839 return status;
4840 }
mohammad16035955c982018-04-26 00:53:03 +03004841
Ronald Cron215633c2021-03-16 17:15:37 +01004842 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004843 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004844 };
mohammad16035955c982018-04-26 00:53:03 +03004845
David Horstmann9d09a022023-11-28 19:25:00 +00004846 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
4847 LOCAL_INPUT_ALLOC(additional_data_external, additional_data_length, additional_data);
4848 LOCAL_INPUT_ALLOC(plaintext_external, plaintext_length, plaintext);
4849 LOCAL_OUTPUT_ALLOC(ciphertext_external, ciphertext_size, ciphertext);
4850
Gilles Peskine449bd832023-01-11 14:50:10 +01004851 status = psa_aead_check_nonce_length(alg, nonce_length);
4852 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004853 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004854 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004855
Ronald Cronde822812021-03-17 16:08:20 +01004856 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004857 &attributes, slot->key.data, slot->key.bytes,
4858 alg,
4859 nonce, nonce_length,
4860 additional_data, additional_data_length,
4861 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004862 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004863
Gilles Peskine449bd832023-01-11 14:50:10 +01004864 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4865 memset(ciphertext, 0, ciphertext_size);
4866 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004867
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004868exit:
David Horstmann9d09a022023-11-28 19:25:00 +00004869 LOCAL_INPUT_FREE(nonce_external, nonce);
4870 LOCAL_INPUT_FREE(additional_data_external, additional_data);
4871 LOCAL_INPUT_FREE(plaintext_external, plaintext);
4872 LOCAL_OUTPUT_FREE(ciphertext_external, ciphertext);
4873
Ryan Everett1b70a072024-01-04 10:32:49 +00004874 psa_unregister_read(slot);
mohammad16035955c982018-04-26 00:53:03 +03004875
Gilles Peskine449bd832023-01-11 14:50:10 +01004876 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004877}
4878
Gilles Peskine449bd832023-01-11 14:50:10 +01004879psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4880 psa_algorithm_t alg,
David Horstmann7f2e0402023-11-28 19:43:53 +00004881 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004882 size_t nonce_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004883 const uint8_t *additional_data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004884 size_t additional_data_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004885 const uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004886 size_t ciphertext_length,
David Horstmann7f2e0402023-11-28 19:43:53 +00004887 uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004888 size_t plaintext_size,
4889 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004890{
Ronald Cron215633c2021-03-16 17:15:37 +01004891 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4892 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004893
David Horstmann7f2e0402023-11-28 19:43:53 +00004894 LOCAL_INPUT_DECLARE(nonce_external, nonce);
4895 LOCAL_INPUT_DECLARE(additional_data_external, additional_data);
4896 LOCAL_INPUT_DECLARE(ciphertext_external, ciphertext);
4897 LOCAL_OUTPUT_DECLARE(plaintext_external, plaintext);
4898
Gilles Peskineee652a32018-06-01 19:23:52 +02004899 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004900
Gilles Peskine449bd832023-01-11 14:50:10 +01004901 status = psa_aead_check_algorithm(alg);
4902 if (status != PSA_SUCCESS) {
4903 return status;
4904 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004905
Ronald Cron9a986162021-03-26 12:40:07 +01004906 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4908 if (status != PSA_SUCCESS) {
4909 return status;
4910 }
mohammad16035955c982018-04-26 00:53:03 +03004911
Ronald Cron215633c2021-03-16 17:15:37 +01004912 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004914 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004915
David Horstmann7f2e0402023-11-28 19:43:53 +00004916 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
4917 LOCAL_INPUT_ALLOC(additional_data_external, additional_data_length,
4918 additional_data);
4919 LOCAL_INPUT_ALLOC(ciphertext_external, ciphertext_length, ciphertext);
4920 LOCAL_OUTPUT_ALLOC(plaintext_external, plaintext_size, plaintext);
4921
Gilles Peskine449bd832023-01-11 14:50:10 +01004922 status = psa_aead_check_nonce_length(alg, nonce_length);
4923 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004924 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004925 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004926
Ronald Cronde822812021-03-17 16:08:20 +01004927 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004928 &attributes, slot->key.data, slot->key.bytes,
4929 alg,
4930 nonce, nonce_length,
4931 additional_data, additional_data_length,
4932 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004933 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004934
Gilles Peskine449bd832023-01-11 14:50:10 +01004935 if (status != PSA_SUCCESS && plaintext_size != 0) {
4936 memset(plaintext, 0, plaintext_size);
4937 }
mohammad160360a64d02018-06-03 17:20:42 +03004938
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004939exit:
David Horstmann7f2e0402023-11-28 19:43:53 +00004940 LOCAL_INPUT_FREE(nonce_external, nonce);
4941 LOCAL_INPUT_FREE(additional_data_external, additional_data);
4942 LOCAL_INPUT_FREE(ciphertext_external, ciphertext);
4943 LOCAL_OUTPUT_FREE(plaintext_external, plaintext);
4944
Ryan Everett1b70a072024-01-04 10:32:49 +00004945 psa_unregister_read(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004946
Gilles Peskine449bd832023-01-11 14:50:10 +01004947 return status;
mohammad16035955c982018-04-26 00:53:03 +03004948}
4949
Gilles Peskine449bd832023-01-11 14:50:10 +01004950static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4951{
4952 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004953
Gilles Peskine449bd832023-01-11 14:50:10 +01004954 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004955#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004956 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004957 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004958 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4959 return PSA_ERROR_INVALID_ARGUMENT;
4960 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004961 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004962#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004963
Przemek Stekiel86679c72022-10-06 17:06:56 +02004964#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004965 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004966 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004967 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4968 return PSA_ERROR_INVALID_ARGUMENT;
4969 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004970 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004971#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004972
Przemek Stekiel86679c72022-10-06 17:06:56 +02004973#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004974 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004975 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004976 if (tag_len != 16) {
4977 return PSA_ERROR_INVALID_ARGUMENT;
4978 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004979 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004980#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004981
4982 default:
4983 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004984 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004985 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004986 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004987}
4988
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004989/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004990static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4991 int is_encrypt,
4992 mbedtls_svc_key_id_t key,
4993 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004994{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004995 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4996 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4997 psa_key_slot_t *slot = NULL;
4998 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004999 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005000
Gilles Peskine449bd832023-01-11 14:50:10 +01005001 status = psa_aead_check_algorithm(alg);
5002 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005003 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005004 }
Paul Elliottc2b71442021-06-24 18:17:52 +01005005
Gilles Peskine449bd832023-01-11 14:50:10 +01005006 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005007 status = PSA_ERROR_BAD_STATE;
5008 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01005009 }
5010
Gilles Peskine449bd832023-01-11 14:50:10 +01005011 if (operation->nonce_set || operation->lengths_set ||
5012 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005013 status = PSA_ERROR_BAD_STATE;
5014 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01005015 }
5016
Gilles Peskine449bd832023-01-11 14:50:10 +01005017 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005018 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005019 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005020 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005021 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005022
Gilles Peskine449bd832023-01-11 14:50:10 +01005023 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
5024 alg);
5025 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005026 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005027 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005028
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01005029 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005030 .core = slot->attr
5031 };
5032
Gilles Peskine449bd832023-01-11 14:50:10 +01005033 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02005034 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005035 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02005036
Gilles Peskine449bd832023-01-11 14:50:10 +01005037 if (is_encrypt) {
5038 status = psa_driver_wrapper_aead_encrypt_setup(operation,
5039 &attributes,
5040 slot->key.data,
5041 slot->key.bytes,
5042 alg);
5043 } else {
5044 status = psa_driver_wrapper_aead_decrypt_setup(operation,
5045 &attributes,
5046 slot->key.data,
5047 slot->key.bytes,
5048 alg);
5049 }
5050 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005051 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005052 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005053
Gilles Peskine449bd832023-01-11 14:50:10 +01005054 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005055
5056exit:
Ryan Everett1b70a072024-01-04 10:32:49 +00005057 unlock_status = psa_unregister_read(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005058
Gilles Peskine449bd832023-01-11 14:50:10 +01005059 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005060 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005061 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01005062 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01005063 } else {
5064 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005065 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01005066
Gilles Peskine449bd832023-01-11 14:50:10 +01005067 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01005068}
5069
Paul Elliott302ff6b2021-04-20 18:10:30 +01005070/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005071psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
5072 mbedtls_svc_key_id_t key,
5073 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005074{
Gilles Peskine449bd832023-01-11 14:50:10 +01005075 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005076}
5077
5078/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005079psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
5080 mbedtls_svc_key_id_t key,
5081 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005082{
Gilles Peskine449bd832023-01-11 14:50:10 +01005083 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005084}
5085
David Horstmannfed23772023-12-19 17:49:20 +00005086static psa_status_t psa_aead_set_nonce_internal(psa_aead_operation_t *operation,
5087 const uint8_t *nonce,
5088 size_t nonce_length)
5089{
5090 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5091
5092 if (operation->id == 0) {
5093 status = PSA_ERROR_BAD_STATE;
5094 goto exit;
5095 }
5096
5097 if (operation->nonce_set) {
5098 status = PSA_ERROR_BAD_STATE;
5099 goto exit;
5100 }
5101
5102 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
5103 if (status != PSA_SUCCESS) {
5104 status = PSA_ERROR_INVALID_ARGUMENT;
5105 goto exit;
5106 }
5107
5108 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
5109 nonce_length);
5110
5111exit:
5112 if (status == PSA_SUCCESS) {
5113 operation->nonce_set = 1;
5114 } else {
5115 psa_aead_abort(operation);
5116 }
5117
5118 return status;
5119}
5120
Paul Elliott302ff6b2021-04-20 18:10:30 +01005121/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01005122psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
David Horstmannd3cad8b2023-12-11 14:46:04 +00005123 uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005124 size_t nonce_size,
5125 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005126{
5127 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01005128 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07005129 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005130
David Horstmannd3cad8b2023-12-11 14:46:04 +00005131 LOCAL_OUTPUT_DECLARE(nonce_external, nonce);
5132 LOCAL_OUTPUT_ALLOC(nonce_external, nonce_size, nonce);
5133
Paul Elliott8eb9daf2021-06-04 16:42:21 +01005134 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005135
Gilles Peskine449bd832023-01-11 14:50:10 +01005136 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005137 status = PSA_ERROR_BAD_STATE;
5138 goto exit;
5139 }
5140
Gilles Peskine449bd832023-01-11 14:50:10 +01005141 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005142 status = PSA_ERROR_BAD_STATE;
5143 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005144 }
5145
Paul Elliotte193ea82021-10-01 13:00:16 +01005146 /* For CCM, this size may not be correct according to the PSA
5147 * specification. The PSA Crypto 1.0.1 specification states:
5148 *
5149 * CCM encodes the plaintext length pLen in L octets, with L the smallest
5150 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
5151 *
5152 * However this restriction that L has to be the smallest integer is not
5153 * applied in practice, and it is not implementable here since the
5154 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005155 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
5156 operation->alg);
5157 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005158 status = PSA_ERROR_BUFFER_TOO_SMALL;
5159 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005160 }
5161
David Horstmann6e99bb22024-02-06 15:27:49 +00005162 status = psa_generate_random_internal(local_nonce, required_nonce_size);
Gilles Peskine449bd832023-01-11 14:50:10 +01005163 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005164 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005165 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01005166
David Horstmannfed23772023-12-19 17:49:20 +00005167 status = psa_aead_set_nonce_internal(operation, local_nonce,
5168 required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005169
Paul Elliott39dc6b82021-05-11 19:16:09 +01005170exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005171 if (status == PSA_SUCCESS) {
5172 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005173 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01005174 } else {
5175 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01005176 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005177
David Horstmannd3cad8b2023-12-11 14:46:04 +00005178 LOCAL_OUTPUT_FREE(nonce_external, nonce);
5179
Gilles Peskine449bd832023-01-11 14:50:10 +01005180 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005181}
5182
5183/* Set the nonce for a multipart authenticated encryption or decryption
5184 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005185psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
David Horstmann8f0ef512023-12-11 15:17:11 +00005186 const uint8_t *nonce_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005187 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005188{
David Horstmannfed23772023-12-19 17:49:20 +00005189 psa_status_t status;
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005190
David Horstmann8f0ef512023-12-11 15:17:11 +00005191 LOCAL_INPUT_DECLARE(nonce_external, nonce);
5192 LOCAL_INPUT_ALLOC(nonce_external, nonce_length, nonce);
Paul Elliottcee785c2021-05-20 14:29:20 +01005193
David Horstmannfed23772023-12-19 17:49:20 +00005194 status = psa_aead_set_nonce_internal(operation, nonce, nonce_length);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005195
David Horstmann18dc0322023-12-20 16:16:43 +00005196/* Exit label is only needed for buffer copying, prevent unused warnings. */
5197#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Paul Elliott39dc6b82021-05-11 19:16:09 +01005198exit:
David Horstmann18dc0322023-12-20 16:16:43 +00005199#endif
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005200
David Horstmann8f0ef512023-12-11 15:17:11 +00005201 LOCAL_INPUT_FREE(nonce_external, nonce);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005202
Gilles Peskine449bd832023-01-11 14:50:10 +01005203 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005204}
5205
5206/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005207psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
5208 size_t ad_length,
5209 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005210{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005211 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5212
Gilles Peskine449bd832023-01-11 14:50:10 +01005213 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005214 status = PSA_ERROR_BAD_STATE;
5215 goto exit;
5216 }
5217
Gilles Peskine449bd832023-01-11 14:50:10 +01005218 if (operation->lengths_set || operation->ad_started ||
5219 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005220 status = PSA_ERROR_BAD_STATE;
5221 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005222 }
5223
Gilles Peskine449bd832023-01-11 14:50:10 +01005224 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005225#if defined(PSA_WANT_ALG_GCM)
5226 case PSA_ALG_GCM:
5227 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01005228 * bits. Without the guard this code will generate warnings on 32bit
5229 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01005230#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01005231 if (((uint64_t) ad_length) >> 61 != 0 ||
5232 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005233 status = PSA_ERROR_INVALID_ARGUMENT;
5234 goto exit;
5235 }
Paul Elliott325d3742021-09-27 17:56:28 +01005236#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005237 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005238#endif /* PSA_WANT_ALG_GCM */
5239#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005240 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01005241 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005242 status = PSA_ERROR_INVALID_ARGUMENT;
5243 goto exit;
5244 }
5245 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005246#endif /* PSA_WANT_ALG_CCM */
5247#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005248 case PSA_ALG_CHACHA20_POLY1305:
5249 /* No length restrictions for ChaChaPoly. */
5250 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005251#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005252 default:
5253 break;
5254 }
Paul Elliott325d3742021-09-27 17:56:28 +01005255
Gilles Peskine449bd832023-01-11 14:50:10 +01005256 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
5257 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005258
Paul Elliott39dc6b82021-05-11 19:16:09 +01005259exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005260 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005261 operation->ad_remaining = ad_length;
5262 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01005263 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005264 } else {
5265 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01005266 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005267
Gilles Peskine449bd832023-01-11 14:50:10 +01005268 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005269}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005270
5271/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005272psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
David Horstmann25dac6e2023-12-11 15:23:13 +00005273 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005274 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005275{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005276 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5277
David Horstmann25dac6e2023-12-11 15:23:13 +00005278 LOCAL_INPUT_DECLARE(input_external, input);
5279 LOCAL_INPUT_ALLOC(input_external, input_length, input);
5280
Gilles Peskine449bd832023-01-11 14:50:10 +01005281 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005282 status = PSA_ERROR_BAD_STATE;
5283 goto exit;
5284 }
5285
Gilles Peskine449bd832023-01-11 14:50:10 +01005286 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005287 status = PSA_ERROR_BAD_STATE;
5288 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005289 }
5290
Gilles Peskine449bd832023-01-11 14:50:10 +01005291 if (operation->lengths_set) {
5292 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005293 status = PSA_ERROR_INVALID_ARGUMENT;
5294 goto exit;
5295 }
5296
5297 operation->ad_remaining -= input_length;
5298 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005299#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005300 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005301 status = PSA_ERROR_BAD_STATE;
5302 goto exit;
5303 }
5304#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005305
Gilles Peskine449bd832023-01-11 14:50:10 +01005306 status = psa_driver_wrapper_aead_update_ad(operation, input,
5307 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005308
Paul Elliott39dc6b82021-05-11 19:16:09 +01005309exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005310 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005311 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005312 } else {
5313 psa_aead_abort(operation);
5314 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005315
David Horstmann25dac6e2023-12-11 15:23:13 +00005316 LOCAL_INPUT_FREE(input_external, input);
5317
Gilles Peskine449bd832023-01-11 14:50:10 +01005318 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005319}
5320
5321/* Encrypt or decrypt a message fragment in an active multipart AEAD
5322 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005323psa_status_t psa_aead_update(psa_aead_operation_t *operation,
David Horstmann2914fac2023-12-11 15:28:37 +00005324 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005325 size_t input_length,
David Horstmann2914fac2023-12-11 15:28:37 +00005326 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005327 size_t output_size,
5328 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005329{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005330 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005331
David Horstmann2914fac2023-12-11 15:28:37 +00005332
5333 LOCAL_INPUT_DECLARE(input_external, input);
5334 LOCAL_OUTPUT_DECLARE(output_external, output);
5335
5336 LOCAL_INPUT_ALLOC(input_external, input_length, input);
5337 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
5338
Paul Elliott302ff6b2021-04-20 18:10:30 +01005339 *output_length = 0;
5340
Gilles Peskine449bd832023-01-11 14:50:10 +01005341 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005342 status = PSA_ERROR_BAD_STATE;
5343 goto exit;
5344 }
5345
Gilles Peskine449bd832023-01-11 14:50:10 +01005346 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005347 status = PSA_ERROR_BAD_STATE;
5348 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005349 }
5350
Gilles Peskine449bd832023-01-11 14:50:10 +01005351 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005352 /* Additional data length was supplied, but not all the additional
5353 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005354 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005355 status = PSA_ERROR_INVALID_ARGUMENT;
5356 goto exit;
5357 }
5358
5359 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005360 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005361 status = PSA_ERROR_INVALID_ARGUMENT;
5362 goto exit;
5363 }
5364
5365 operation->body_remaining -= input_length;
5366 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005367#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005368 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005369 status = PSA_ERROR_BAD_STATE;
5370 goto exit;
5371 }
5372#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005373
Gilles Peskine449bd832023-01-11 14:50:10 +01005374 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5375 output, output_size,
5376 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005377
Paul Elliott39dc6b82021-05-11 19:16:09 +01005378exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005379 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005380 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 } else {
5382 psa_aead_abort(operation);
5383 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005384
David Horstmann2914fac2023-12-11 15:28:37 +00005385 LOCAL_INPUT_FREE(input_external, input);
5386 LOCAL_OUTPUT_FREE(output_external, output);
5387
Gilles Peskine449bd832023-01-11 14:50:10 +01005388 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005389}
5390
Gilles Peskine449bd832023-01-11 14:50:10 +01005391static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005392{
Gilles Peskine449bd832023-01-11 14:50:10 +01005393 if (operation->id == 0 || !operation->nonce_set) {
5394 return PSA_ERROR_BAD_STATE;
5395 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005396
Gilles Peskine449bd832023-01-11 14:50:10 +01005397 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5398 operation->body_remaining != 0)) {
5399 return PSA_ERROR_INVALID_ARGUMENT;
5400 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005401
Gilles Peskine449bd832023-01-11 14:50:10 +01005402 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005403}
5404
Paul Elliott302ff6b2021-04-20 18:10:30 +01005405/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005406psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
David Horstmann6db0e732023-12-11 15:35:59 +00005407 uint8_t *ciphertext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005408 size_t ciphertext_size,
5409 size_t *ciphertext_length,
David Horstmann6db0e732023-12-11 15:35:59 +00005410 uint8_t *tag_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005411 size_t tag_size,
5412 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005413{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005414 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5415
David Horstmann6db0e732023-12-11 15:35:59 +00005416 LOCAL_OUTPUT_DECLARE(ciphertext_external, ciphertext);
5417 LOCAL_OUTPUT_DECLARE(tag_external, tag);
5418
5419 LOCAL_OUTPUT_ALLOC(ciphertext_external, ciphertext_size, ciphertext);
5420 LOCAL_OUTPUT_ALLOC(tag_external, tag_size, tag);
5421
Paul Elliott302ff6b2021-04-20 18:10:30 +01005422 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005423 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005424
Gilles Peskine449bd832023-01-11 14:50:10 +01005425 status = psa_aead_final_checks(operation);
5426 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005427 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005428 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005429
Gilles Peskine449bd832023-01-11 14:50:10 +01005430 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005431 status = PSA_ERROR_BAD_STATE;
5432 goto exit;
5433 }
5434
Gilles Peskine449bd832023-01-11 14:50:10 +01005435 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5436 ciphertext_size,
5437 ciphertext_length,
5438 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005439
Paul Elliott39dc6b82021-05-11 19:16:09 +01005440exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005441
5442
Paul Elliottf47b0952021-05-21 18:02:33 +01005443 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005444 * the zero tag size, make sure the tag is set to something implausible.
5445 * Even if the operation succeeds, make sure we clear the rest of the
5446 * buffer to prevent potential leakage of anything previously placed in
5447 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005448 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005449
Gilles Peskine449bd832023-01-11 14:50:10 +01005450 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005451
David Horstmann6db0e732023-12-11 15:35:59 +00005452 LOCAL_OUTPUT_FREE(ciphertext_external, ciphertext);
5453 LOCAL_OUTPUT_FREE(tag_external, tag);
5454
Gilles Peskine449bd832023-01-11 14:50:10 +01005455 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005456}
5457
5458/* Finish authenticating and decrypting a message in a multipart AEAD
5459 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005460psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
David Horstmanne000a0a2023-12-11 16:37:04 +00005461 uint8_t *plaintext_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005462 size_t plaintext_size,
5463 size_t *plaintext_length,
David Horstmanne000a0a2023-12-11 16:37:04 +00005464 const uint8_t *tag_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01005465 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005466{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005467 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5468
David Horstmanne000a0a2023-12-11 16:37:04 +00005469 LOCAL_OUTPUT_DECLARE(plaintext_external, plaintext);
5470 LOCAL_INPUT_DECLARE(tag_external, tag);
5471
5472 LOCAL_OUTPUT_ALLOC(plaintext_external, plaintext_size, plaintext);
5473 LOCAL_INPUT_ALLOC(tag_external, tag_length, tag);
5474
Paul Elliott302ff6b2021-04-20 18:10:30 +01005475 *plaintext_length = 0;
5476
Gilles Peskine449bd832023-01-11 14:50:10 +01005477 status = psa_aead_final_checks(operation);
5478 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005479 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005480 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005481
Gilles Peskine449bd832023-01-11 14:50:10 +01005482 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005483 status = PSA_ERROR_BAD_STATE;
5484 goto exit;
5485 }
5486
Gilles Peskine449bd832023-01-11 14:50:10 +01005487 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5488 plaintext_size,
5489 plaintext_length,
5490 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005491
5492exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005493 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005494
David Horstmanne000a0a2023-12-11 16:37:04 +00005495 LOCAL_OUTPUT_FREE(plaintext_external, plaintext);
5496 LOCAL_INPUT_FREE(tag_external, tag);
5497
Gilles Peskine449bd832023-01-11 14:50:10 +01005498 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005499}
5500
5501/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005502psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005503{
5504 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5505
Gilles Peskine449bd832023-01-11 14:50:10 +01005506 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005507 /* The object has (apparently) been initialized but it is not (yet)
5508 * in use. It's ok to call abort on such an object, and there's
5509 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005510 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005511 }
5512
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005514
Gilles Peskine449bd832023-01-11 14:50:10 +01005515 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005516
Gilles Peskine449bd832023-01-11 14:50:10 +01005517 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005518}
5519
Gilles Peskinee59236f2018-01-27 23:32:46 +01005520/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005521/* Generators */
5522/****************************************************************/
5523
Przemek Stekiel69c46792022-06-10 12:59:51 +02005524#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005525 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005526 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305527 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305528 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005529#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005530#endif /* At least one builtin KDF */
5531
Przemek Stekiel69c46792022-06-10 12:59:51 +02005532#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005533 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5534 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5535static psa_status_t psa_key_derivation_start_hmac(
5536 psa_mac_operation_t *operation,
5537 psa_algorithm_t hash_alg,
5538 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005539 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005540{
5541 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5542 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005543 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5544 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5545 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005546
Steven Cooreman72f736a2021-05-07 14:14:37 +02005547 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005548 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005549
Gilles Peskine449bd832023-01-11 14:50:10 +01005550 status = psa_driver_wrapper_mac_sign_setup(operation,
5551 &attributes,
5552 hmac_key, hmac_key_length,
5553 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005554
Gilles Peskine449bd832023-01-11 14:50:10 +01005555 psa_reset_key_attributes(&attributes);
5556 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005557}
5558#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005559
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005560#define HKDF_STATE_INIT 0 /* no input yet */
5561#define HKDF_STATE_STARTED 1 /* got salt */
5562#define HKDF_STATE_KEYED 2 /* got key */
5563#define HKDF_STATE_OUTPUT 3 /* output started */
5564
Gilles Peskinecbe66502019-05-16 16:59:18 +02005565static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005566 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005567{
Gilles Peskine449bd832023-01-11 14:50:10 +01005568 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5569 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5570 } else {
5571 return operation->alg;
5572 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005573}
5574
Gilles Peskine449bd832023-01-11 14:50:10 +01005575psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005576{
5577 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005578 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5579 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005580 /* The object has (apparently) been initialized but it is not
5581 * in use. It's ok to call abort on such an object, and there's
5582 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005583 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005584#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005585 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5586 mbedtls_free(operation->ctx.hkdf.info);
5587 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5588 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005589#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005590#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5591 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005592 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5593 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5594 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5595 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005596 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005597 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005598 }
5599
Gilles Peskine449bd832023-01-11 14:50:10 +01005600 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005601 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005602 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005603 }
5604
Gilles Peskine449bd832023-01-11 14:50:10 +01005605 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005606 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005607 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005608 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005609#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005610 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005611 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005612 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005613 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005614#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005615 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005616
5617 /* We leave the fields Ai and output_block to be erased safely by the
5618 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005619 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005620#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5621 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005622#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005623 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5624 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5625 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5626 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005627#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305628#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305629 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305630 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005631 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305632 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305633 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305634
5635 status = PSA_SUCCESS;
5636 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305637#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005638 {
5639 status = PSA_ERROR_BAD_STATE;
5640 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005641 mbedtls_platform_zeroize(operation, sizeof(*operation));
5642 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005643}
5644
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005645psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005646 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005647{
Gilles Peskine449bd832023-01-11 14:50:10 +01005648 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005649 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005650 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005651 }
5652
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005653 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005654 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005655}
5656
Gilles Peskine449bd832023-01-11 14:50:10 +01005657psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5658 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005659{
Gilles Peskine449bd832023-01-11 14:50:10 +01005660 if (operation->alg == 0) {
5661 return PSA_ERROR_BAD_STATE;
5662 }
5663 if (capacity > operation->capacity) {
5664 return PSA_ERROR_INVALID_ARGUMENT;
5665 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005666 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005667 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005668}
5669
Przemek Stekiel69c46792022-06-10 12:59:51 +02005670#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005671/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005672static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5673 psa_algorithm_t kdf_alg,
5674 uint8_t *output,
5675 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005676{
Gilles Peskine449bd832023-01-11 14:50:10 +01005677 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5678 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005679 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005680 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005681#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005682 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005683#else
5684 const uint8_t last_block = 0xff;
5685#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005686
Gilles Peskine449bd832023-01-11 14:50:10 +01005687 if (hkdf->state < HKDF_STATE_KEYED ||
5688 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005689#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005690 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005691#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005692 )) {
5693 return PSA_ERROR_BAD_STATE;
5694 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005695 hkdf->state = HKDF_STATE_OUTPUT;
5696
Gilles Peskine449bd832023-01-11 14:50:10 +01005697 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005698 /* Copy what remains of the current block */
5699 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005700 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005701 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005702 }
5703 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005704 output += n;
5705 output_length -= n;
5706 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005707 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005708 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005709 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005710 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005711 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005712 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005713 * object was corrupted or if this function is called directly
5714 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005715 if (hkdf->block_number == last_block) {
5716 return PSA_ERROR_BAD_STATE;
5717 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005718
5719 /* We need a new block */
5720 ++hkdf->block_number;
5721 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005722
Gilles Peskine449bd832023-01-11 14:50:10 +01005723 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5724 hash_alg,
5725 hkdf->prk,
5726 hash_length);
5727 if (status != PSA_SUCCESS) {
5728 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005729 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005730
5731 if (hkdf->block_number != 1) {
5732 status = psa_mac_update(&hkdf->hmac,
5733 hkdf->output_block,
5734 hash_length);
5735 if (status != PSA_SUCCESS) {
5736 return status;
5737 }
5738 }
5739 status = psa_mac_update(&hkdf->hmac,
5740 hkdf->info,
5741 hkdf->info_length);
5742 if (status != PSA_SUCCESS) {
5743 return status;
5744 }
5745 status = psa_mac_update(&hkdf->hmac,
5746 &hkdf->block_number, 1);
5747 if (status != PSA_SUCCESS) {
5748 return status;
5749 }
5750 status = psa_mac_sign_finish(&hkdf->hmac,
5751 hkdf->output_block,
5752 sizeof(hkdf->output_block),
5753 &hmac_output_length);
5754 if (status != PSA_SUCCESS) {
5755 return status;
5756 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005757 }
5758
Gilles Peskine449bd832023-01-11 14:50:10 +01005759 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005760}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005761#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005762
John Durkop07cc04a2020-11-16 22:08:34 -08005763#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5764 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005765static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5766 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005767 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005768{
Gilles Peskine449bd832023-01-11 14:50:10 +01005769 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5770 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005771 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5772 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005773 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005774
Janos Follath7742fee2019-06-17 12:58:10 +01005775 /* We can't be wanting more output after block 0xff, otherwise
5776 * the capacity check in psa_key_derivation_output_bytes() would have
5777 * prevented this call. It could happen only if the operation
5778 * object was corrupted or if this function is called directly
5779 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005780 if (tls12_prf->block_number == 0xff) {
5781 return PSA_ERROR_CORRUPTION_DETECTED;
5782 }
Janos Follath7742fee2019-06-17 12:58:10 +01005783
5784 /* We need a new block */
5785 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005786 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005787
5788 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5789 *
5790 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5791 *
5792 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5793 * HMAC_hash(secret, A(2) + seed) +
5794 * HMAC_hash(secret, A(3) + seed) + ...
5795 *
5796 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005797 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005798 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005799 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005800 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005801 * is currently extracted as `output_block` and where i is
5802 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005803 */
5804
Gilles Peskine449bd832023-01-11 14:50:10 +01005805 status = psa_key_derivation_start_hmac(&hmac,
5806 hash_alg,
5807 tls12_prf->secret,
5808 tls12_prf->secret_length);
5809 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005810 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005811 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005812
5813 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005814 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005815 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5816 * the variable seed and in this instance means it in the context of the
5817 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005818 status = psa_mac_update(&hmac,
5819 tls12_prf->label,
5820 tls12_prf->label_length);
5821 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005822 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005823 }
5824 status = psa_mac_update(&hmac,
5825 tls12_prf->seed,
5826 tls12_prf->seed_length);
5827 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005828 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005829 }
5830 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005831 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005832 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5833 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005834 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005835 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005836 }
5837
Gilles Peskine449bd832023-01-11 14:50:10 +01005838 status = psa_mac_sign_finish(&hmac,
5839 tls12_prf->Ai, hash_length,
5840 &hmac_output_length);
5841 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005842 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005843 }
5844 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005845 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005846 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005847
5848 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005849 status = psa_key_derivation_start_hmac(&hmac,
5850 hash_alg,
5851 tls12_prf->secret,
5852 tls12_prf->secret_length);
5853 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005854 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005855 }
5856 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5857 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005858 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005859 }
5860 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5861 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005862 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005863 }
5864 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5865 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005866 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005867 }
5868 status = psa_mac_sign_finish(&hmac,
5869 tls12_prf->output_block, hash_length,
5870 &hmac_output_length);
5871 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005872 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005873 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005874
Janos Follath7742fee2019-06-17 12:58:10 +01005875
5876cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005877 cleanup_status = psa_mac_abort(&hmac);
5878 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005879 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005880 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005881
Gilles Peskine449bd832023-01-11 14:50:10 +01005882 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005883}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005884
Janos Follath844eb0e2019-06-19 12:10:49 +01005885static psa_status_t psa_key_derivation_tls12_prf_read(
5886 psa_tls12_prf_key_derivation_t *tls12_prf,
5887 psa_algorithm_t alg,
5888 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005889 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005890{
Gilles Peskine449bd832023-01-11 14:50:10 +01005891 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5892 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005893 psa_status_t status;
5894 uint8_t offset, length;
5895
Gilles Peskine449bd832023-01-11 14:50:10 +01005896 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005897 case PSA_TLS12_PRF_STATE_LABEL_SET:
5898 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5899 break;
5900 case PSA_TLS12_PRF_STATE_OUTPUT:
5901 break;
5902 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005903 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005904 }
5905
Gilles Peskine449bd832023-01-11 14:50:10 +01005906 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005907 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005908 if (tls12_prf->left_in_block == 0) {
5909 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5910 alg);
5911 if (status != PSA_SUCCESS) {
5912 return status;
5913 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005914
5915 continue;
5916 }
5917
Gilles Peskine449bd832023-01-11 14:50:10 +01005918 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005919 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005920 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005921 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005922 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005923
5924 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005925 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005926 output += length;
5927 output_length -= length;
5928 tls12_prf->left_in_block -= length;
5929 }
5930
Gilles Peskine449bd832023-01-11 14:50:10 +01005931 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005932}
John Durkop07cc04a2020-11-16 22:08:34 -08005933#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5934 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005935
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005936#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5937static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5938 psa_tls12_ecjpake_to_pms_t *ecjpake,
5939 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005940 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005941{
5942 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005943 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005944
Gilles Peskine449bd832023-01-11 14:50:10 +01005945 if (output_length != 32) {
5946 return PSA_ERROR_INVALID_ARGUMENT;
5947 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005948
Gilles Peskine449bd832023-01-11 14:50:10 +01005949 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5950 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5951 &output_size);
5952 if (status != PSA_SUCCESS) {
5953 return status;
5954 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005955
Gilles Peskine449bd832023-01-11 14:50:10 +01005956 if (output_size != output_length) {
5957 return PSA_ERROR_GENERIC_ERROR;
5958 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005959
Gilles Peskine449bd832023-01-11 14:50:10 +01005960 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005961}
5962#endif
5963
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305964#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305965static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5966 psa_pbkdf2_key_derivation_t *pbkdf2,
5967 psa_algorithm_t prf_alg,
5968 uint8_t prf_output_length,
5969 psa_key_attributes_t *attributes)
5970{
5971 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305972 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305973 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305974 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305975 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305976 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305977 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305978
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305979 mac_operation.is_sign = 1;
5980 mac_operation.mac_size = prf_output_length;
5981 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305982
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305983 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5984 attributes,
5985 pbkdf2->password,
5986 pbkdf2->password_length,
5987 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305988 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305989 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305990 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305991 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5992 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305993 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305994 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305995 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305996 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305997 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305998 }
5999 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
6000 &mac_output_length);
6001 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05306002 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05306003 }
6004
6005 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05306006 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05306007 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05306008 }
6009
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05306010 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306011
6012 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05306013 /* We are passing prf_output_length as mac_size because the driver
6014 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05306015 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306016 status = psa_driver_wrapper_mac_compute(attributes,
6017 pbkdf2->password,
6018 pbkdf2->password_length,
6019 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05306020 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306021 &mac_output_length);
6022 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05306023 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306024 }
6025
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05306026 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306027 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05306028
6029cleanup:
6030 /* Zeroise buffers to clear sensitive data from memory. */
6031 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
6032 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306033}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05306034
6035static psa_status_t psa_key_derivation_pbkdf2_read(
6036 psa_pbkdf2_key_derivation_t *pbkdf2,
6037 psa_algorithm_t kdf_alg,
6038 uint8_t *output,
6039 size_t output_length)
6040{
6041 psa_status_t status;
6042 psa_algorithm_t prf_alg;
6043 uint8_t prf_output_length;
6044 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
6045 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
6046 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
6047
6048 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6049 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
6050 prf_output_length = PSA_HASH_LENGTH(prf_alg);
6051 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05306052 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6053 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306054 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05306055 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05306056 } else {
6057 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05306058 }
6059
6060 switch (pbkdf2->state) {
6061 case PSA_PBKDF2_STATE_PASSWORD_SET:
6062 /* Initially we need a new block so bytes_used is equal to block size*/
6063 pbkdf2->bytes_used = prf_output_length;
6064 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
6065 break;
6066 case PSA_PBKDF2_STATE_OUTPUT:
6067 break;
6068 default:
6069 return PSA_ERROR_BAD_STATE;
6070 }
6071
6072 while (output_length != 0) {
6073 uint8_t n = prf_output_length - pbkdf2->bytes_used;
6074 if (n > output_length) {
6075 n = (uint8_t) output_length;
6076 }
6077 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
6078 output += n;
6079 output_length -= n;
6080 pbkdf2->bytes_used += n;
6081
6082 if (output_length == 0) {
6083 break;
6084 }
6085
6086 /* We need a new block */
6087 pbkdf2->bytes_used = 0;
6088 pbkdf2->block_number++;
6089
6090 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
6091 prf_output_length,
6092 &attributes);
6093 if (status != PSA_SUCCESS) {
6094 return status;
6095 }
6096 }
6097
6098 return PSA_SUCCESS;
6099}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306100#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05306101
Janos Follath6c6c8fc2019-06-17 12:38:20 +01006102psa_status_t psa_key_derivation_output_bytes(
6103 psa_key_derivation_operation_t *operation,
Ryan Everettf943e222024-01-19 14:46:39 +00006104 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006106{
6107 psa_status_t status;
Ryan Everettf943e222024-01-19 14:46:39 +00006108 LOCAL_OUTPUT_DECLARE(output_external, output);
6109
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02006111
Gilles Peskine449bd832023-01-11 14:50:10 +01006112 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006113 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006114 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006115 }
6116
Gilles Peskine449bd832023-01-11 14:50:10 +01006117 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006118 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006119 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02006120 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
6121 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006122 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02006123 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006124 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006125 }
Ryan Everettf943e222024-01-19 14:46:39 +00006126
6127 LOCAL_OUTPUT_ALLOC(output_external, output_length, output);
Ryan Everettda9227d2024-01-25 11:37:22 +00006128 if (output_length > operation->capacity) {
6129 operation->capacity = 0;
6130 /* Go through the error path to wipe all confidential data now
6131 * that the operation object is useless. */
6132 status = PSA_ERROR_INSUFFICIENT_DATA;
6133 goto exit;
6134 }
6135
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006136 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006137
Przemek Stekiel69c46792022-06-10 12:59:51 +02006138#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006139 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
6140 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
6141 output, output_length);
6142 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02006143#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08006144#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6145 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006146 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6147 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6148 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
6149 kdf_alg, output,
6150 output_length);
6151 } else
John Durkop07cc04a2020-11-16 22:08:34 -08006152#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
6153 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006154#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006155 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006156 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01006157 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
6158 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006159#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306160#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05306161 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05306162 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
6163 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05306164 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306165#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006166
Gilles Peskineeab56e42018-07-12 17:12:33 +02006167 {
Steven Cooreman74afe472021-02-10 17:19:22 +01006168 (void) kdf_alg;
Ryan Everettf943e222024-01-19 14:46:39 +00006169 status = PSA_ERROR_BAD_STATE;
6170 LOCAL_OUTPUT_FREE(output_external, output);
6171
6172 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006173 }
6174
6175exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006176 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00006177 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006178 * This allows us to differentiate between exhausted operations and
6179 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
6180 * operations. */
6181 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006182 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006183 operation->alg = alg;
Ryan Everettee5920a2024-02-09 15:09:28 +00006184 if (output != NULL) {
6185 memset(output, '!', output_length);
6186 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006187 }
Ryan Everettda9227d2024-01-25 11:37:22 +00006188
6189 LOCAL_OUTPUT_FREE(output_external, output);
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006191}
6192
David Brown7807bf72021-02-09 16:28:23 -07006193#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006194static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02006195{
Gilles Peskine449bd832023-01-11 14:50:10 +01006196 if (data_size >= 8) {
6197 mbedtls_des_key_set_parity(data);
6198 }
6199 if (data_size >= 16) {
6200 mbedtls_des_key_set_parity(data + 8);
6201 }
6202 if (data_size >= 24) {
6203 mbedtls_des_key_set_parity(data + 16);
6204 }
Gilles Peskine08542d82018-07-19 17:05:42 +02006205}
David Brown7807bf72021-02-09 16:28:23 -07006206#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02006207
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006208/*
Gilles Peskine449bd832023-01-11 14:50:10 +01006209 * ECC keys on a Weierstrass elliptic curve require the generation
6210 * of a private key which is an integer
6211 * in the range [1, N - 1], where N is the boundary of the private key domain:
6212 * N is the prime p for Diffie-Hellman, or the order of the
6213 * curve’s base point for ECC.
6214 *
6215 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
6216 * This function generates the private key using the following process:
6217 *
6218 * 1. Draw a byte string of length ceiling(m/8) bytes.
6219 * 2. If m is not a multiple of 8, set the most significant
6220 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
6221 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
6222 * 4. If k > N - 2, discard the result and return to step 1.
6223 * 5. Output k + 1 as the private key.
6224 *
6225 * This method allows compliance to NIST standards, specifically the methods titled
6226 * Key-Pair Generation by Testing Candidates in the following publications:
6227 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
6228 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
6229 * Diffie-Hellman keys.
6230 *
6231 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
6232 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
6233 *
6234 * Note: Function allocates memory for *data buffer, so given *data should be
6235 * always NULL.
6236 */
Valerio Setti86587ab2023-06-27 13:09:30 +02006237#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
6238#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006239static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006240 psa_key_slot_t *slot,
6241 size_t bits,
6242 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006243 uint8_t **data
6244 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006245{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006246 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006247 mbedtls_mpi k;
6248 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006249 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006250 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006251 size_t m;
6252 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006253
Gilles Peskine449bd832023-01-11 14:50:10 +01006254 mbedtls_mpi_init(&k);
6255 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006256
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006257 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01006258 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006259 mbedtls_ecp_group_id grp_id =
Valerio Settid36c3132023-12-21 14:03:51 +01006260 mbedtls_ecc_group_from_psa(curve, bits);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006261
Gilles Peskine449bd832023-01-11 14:50:10 +01006262 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006263 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01006264 goto cleanup;
6265 }
6266
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006267 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01006268 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006269
Gilles Peskine449bd832023-01-11 14:50:10 +01006270 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006271
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006272 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006273 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006274 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006275
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006276 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006277
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006278 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006279 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006280
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006281 /* Note: This function is always called with *data == NULL and it
6282 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006283 *data = mbedtls_calloc(1, m_bytes);
6284 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006285 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006286 goto cleanup;
6287 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006288
Gilles Peskine449bd832023-01-11 14:50:10 +01006289 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006290 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006291 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006292 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01006293 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006294
6295 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006296 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006297 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006298 * (8 * ceiling(m/8) - m) bits of the first byte in
6299 * the string to zero.
6300 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006301 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006302 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006303 }
6304
6305 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01006306 * big-endian byte string.
6307 */
6308 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006309
6310 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01006311 * Result of comparison is returned. When it indicates error
6312 * then this function is called again.
6313 */
6314 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006315 }
6316
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006317 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006318 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6319 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006320cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006321 if (ret != 0) {
6322 status = mbedtls_to_psa_error(ret);
6323 }
6324 if (status != PSA_SUCCESS) {
6325 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006326 *data = NULL;
6327 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006328 mbedtls_mpi_free(&k);
6329 mbedtls_mpi_free(&diff_N_2);
6330 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006331}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006332
6333/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6334 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6335 *
6336 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6337 * draw a 32-byte string and process it as specified in
6338 * Elliptic Curves for Security [RFC7748] §5.
6339 *
6340 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6341 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6342 *
6343 * Note: Function allocates memory for *data buffer, so given *data should be
6344 * always NULL.
6345 */
6346
6347static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6348 size_t bits,
6349 psa_key_derivation_operation_t *operation,
6350 uint8_t **data
6351 )
6352{
6353 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006354 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006355
Gilles Peskine449bd832023-01-11 14:50:10 +01006356 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006357 case 255:
6358 output_length = 32;
6359 break;
6360 case 448:
6361 output_length = 56;
6362 break;
6363 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006364 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006365 break;
6366 }
6367
Gilles Peskine449bd832023-01-11 14:50:10 +01006368 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006369
Gilles Peskine449bd832023-01-11 14:50:10 +01006370 if (*data == NULL) {
6371 return PSA_ERROR_INSUFFICIENT_MEMORY;
6372 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006373
Gilles Peskine449bd832023-01-11 14:50:10 +01006374 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006375
Gilles Peskine449bd832023-01-11 14:50:10 +01006376 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006377 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006378 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006379
Gilles Peskine449bd832023-01-11 14:50:10 +01006380 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006381 case 255:
6382 (*data)[0] &= 248;
6383 (*data)[31] &= 127;
6384 (*data)[31] |= 64;
6385 break;
6386 case 448:
6387 (*data)[0] &= 252;
6388 (*data)[55] |= 128;
6389 break;
6390 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006391 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006392 break;
6393 }
6394
6395 return status;
6396}
Valerio Setti86587ab2023-06-27 13:09:30 +02006397#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6398static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6399 psa_key_slot_t *slot, size_t bits,
6400 psa_key_derivation_operation_t *operation, uint8_t **data)
6401{
6402 (void) slot;
6403 (void) bits;
6404 (void) operation;
6405 (void) data;
6406 return PSA_ERROR_NOT_SUPPORTED;
6407}
6408
6409static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6410 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6411{
6412 (void) bits;
6413 (void) operation;
6414 (void) data;
6415 return PSA_ERROR_NOT_SUPPORTED;
6416}
6417#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6418#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006419
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006420static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006421 psa_key_slot_t *slot,
6422 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006423 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006424{
6425 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006426 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306427 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006428 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006429 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006430
Gilles Peskine449bd832023-01-11 14:50:10 +01006431 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6432 return PSA_ERROR_INVALID_ARGUMENT;
6433 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006434
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006435#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006436 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006437 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6438 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6439 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006440 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006441 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6442 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006443 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006444 }
6445 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006446 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006447 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6448 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006449 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006450 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006451 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006452 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006453#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006454 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006455 if (key_type_is_raw_bytes(slot->attr.type)) {
6456 if (bits % 8 != 0) {
6457 return PSA_ERROR_INVALID_ARGUMENT;
6458 }
6459 data = mbedtls_calloc(1, bytes);
6460 if (data == NULL) {
6461 return PSA_ERROR_INSUFFICIENT_MEMORY;
6462 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006463
Gilles Peskine449bd832023-01-11 14:50:10 +01006464 status = psa_key_derivation_output_bytes(operation, data, bytes);
6465 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006466 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006467 }
David Brown12ca5032021-02-11 11:02:00 -07006468#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006469 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6470 psa_des_set_key_parity(data, bytes);
6471 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006472#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006473 } else {
6474 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006475 }
Ronald Crondd04d422020-11-28 15:14:42 +01006476
Ronald Cronbf33c932020-11-28 18:06:53 +01006477 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006478 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006479 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006480 };
6481
Gilles Peskine449bd832023-01-11 14:50:10 +01006482 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6483 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6484 &storage_size);
6485 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306486 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006487 }
Archanad8a83dc2021-06-14 10:04:16 +05306488 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006489 status = psa_allocate_buffer_to_slot(slot, storage_size);
6490 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306491 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006492 }
Archanad8a83dc2021-06-14 10:04:16 +05306493
Gilles Peskine449bd832023-01-11 14:50:10 +01006494 status = psa_driver_wrapper_import_key(&attributes,
6495 data, bytes,
6496 slot->key.data,
6497 slot->key.bytes,
6498 &slot->key.bytes, &bits);
6499 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006500 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006501 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006502
6503exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006504 mbedtls_free(data);
6505 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006506}
6507
Gilles Peskine449bd832023-01-11 14:50:10 +01006508psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6509 psa_key_derivation_operation_t *operation,
6510 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006511{
6512 psa_status_t status;
6513 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006514 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006515
Ronald Cron81709fc2020-11-14 12:10:32 +01006516 *key = MBEDTLS_SVC_KEY_ID_INIT;
6517
Gilles Peskine0f84d622019-09-12 19:03:13 +02006518 /* Reject any attempt to create a zero-length key so that we don't
6519 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006520 if (psa_get_key_bits(attributes) == 0) {
6521 return PSA_ERROR_INVALID_ARGUMENT;
6522 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006523
Gilles Peskine449bd832023-01-11 14:50:10 +01006524 if (operation->alg == PSA_ALG_NONE) {
6525 return PSA_ERROR_BAD_STATE;
6526 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006527
Gilles Peskine449bd832023-01-11 14:50:10 +01006528 if (!operation->can_output_key) {
6529 return PSA_ERROR_NOT_PERMITTED;
6530 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006531
Gilles Peskine449bd832023-01-11 14:50:10 +01006532 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6533 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006534#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006535 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006536 /* Deriving a key in a secure element is not implemented yet. */
6537 status = PSA_ERROR_NOT_SUPPORTED;
6538 }
6539#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006540 if (status == PSA_SUCCESS) {
6541 status = psa_generate_derived_key_internal(slot,
6542 attributes->core.bits,
6543 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006544 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006545 if (status == PSA_SUCCESS) {
6546 status = psa_finish_key_creation(slot, driver, key);
6547 }
6548 if (status != PSA_SUCCESS) {
6549 psa_fail_key_creation(slot, driver);
6550 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006551
Gilles Peskine449bd832023-01-11 14:50:10 +01006552 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006553}
6554
Gilles Peskineeab56e42018-07-12 17:12:33 +02006555
6556
6557/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006558/* Key derivation */
6559/****************************************************************/
6560
Steven Cooreman932ffb72021-02-15 12:14:32 +01006561#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006562static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006563{
6564#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006565 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6566 return 1;
6567 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006568#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006569#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006570 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6571 return 1;
6572 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006573#endif
6574#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006575 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6576 return 1;
6577 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006578#endif
6579#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006580 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6581 return 1;
6582 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006583#endif
6584#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006585 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6586 return 1;
6587 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006588#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006589#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006590 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6591 return 1;
6592 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006593#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306594#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6595 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6596 return 1;
6597 }
6598#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306599#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6600 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6601 return 1;
6602 }
6603#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006604 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006605}
6606
Gilles Peskine449bd832023-01-11 14:50:10 +01006607static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006608{
6609 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006610 psa_status_t status = psa_hash_setup(&operation, alg);
6611 psa_hash_abort(&operation);
6612 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006613}
6614
Gilles Peskine969c5d62019-01-16 15:53:06 +01006615static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006616 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006617 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006618{
Janos Follath5fe19732019-06-20 15:09:30 +01006619 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6620 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006621 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006622
Gilles Peskine969c5d62019-01-16 15:53:06 +01006623 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006624 if (!is_kdf_alg_supported(kdf_alg)) {
6625 return PSA_ERROR_NOT_SUPPORTED;
6626 }
John Durkop07cc04a2020-11-16 22:08:34 -08006627
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006628 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306629 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006630 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6631 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306632 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6633 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6634 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306635 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306636 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006637 if (hash_size == 0) {
6638 return PSA_ERROR_NOT_SUPPORTED;
6639 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006640
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006641 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6642 * we might fail later, which is somewhat unfriendly and potentially
6643 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006644 psa_status_t status = psa_hash_try_support(hash_alg);
6645 if (status != PSA_SUCCESS) {
6646 return status;
6647 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006648 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006649
Gilles Peskine449bd832023-01-11 14:50:10 +01006650 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6651 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6652 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6653 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006654 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006655#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006656 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006657 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6658 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006659 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006660 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006661#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6662 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006663 operation->capacity = 255 * hash_size;
6664 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006665}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006666
Gilles Peskine449bd832023-01-11 14:50:10 +01006667static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006668{
6669#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006670 if (alg == PSA_ALG_ECDH) {
6671 return PSA_SUCCESS;
6672 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006673#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006674#if defined(PSA_WANT_ALG_FFDH)
6675 if (alg == PSA_ALG_FFDH) {
6676 return PSA_SUCCESS;
6677 }
6678#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006679 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006680 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006681}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006682
6683static int psa_key_derivation_allows_free_form_secret_input(
6684 psa_algorithm_t kdf_alg)
6685{
6686#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6687 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6688 return 0;
6689 }
6690#endif
6691 (void) kdf_alg;
6692 return 1;
6693}
John Durkop07cc04a2020-11-16 22:08:34 -08006694#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006695
Gilles Peskine449bd832023-01-11 14:50:10 +01006696psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6697 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006698{
6699 psa_status_t status;
6700
Gilles Peskine449bd832023-01-11 14:50:10 +01006701 if (operation->alg != 0) {
6702 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006703 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006704
Gilles Peskine449bd832023-01-11 14:50:10 +01006705 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6706 return PSA_ERROR_INVALID_ARGUMENT;
6707 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6708#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6709 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6710 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6711 status = psa_key_agreement_try_support(ka_alg);
6712 if (status != PSA_SUCCESS) {
6713 return status;
6714 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006715 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6716 return PSA_ERROR_INVALID_ARGUMENT;
6717 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006718 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6719#else
6720 return PSA_ERROR_NOT_SUPPORTED;
6721#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6722 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6723#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6724 status = psa_key_derivation_setup_kdf(operation, alg);
6725#else
6726 return PSA_ERROR_NOT_SUPPORTED;
6727#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6728 } else {
6729 return PSA_ERROR_INVALID_ARGUMENT;
6730 }
6731
6732 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006733 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006734 }
6735 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006736}
6737
Przemek Stekiel69c46792022-06-10 12:59:51 +02006738#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006739static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6740 psa_algorithm_t kdf_alg,
6741 psa_key_derivation_step_t step,
6742 const uint8_t *data,
6743 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006744{
Gilles Peskine449bd832023-01-11 14:50:10 +01006745 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006746 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006747 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006748 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006749#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006750 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6751 return PSA_ERROR_INVALID_ARGUMENT;
6752 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006753#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006754 if (hkdf->state != HKDF_STATE_INIT) {
6755 return PSA_ERROR_BAD_STATE;
6756 } else {
6757 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6758 hash_alg,
6759 data, data_length);
6760 if (status != PSA_SUCCESS) {
6761 return status;
6762 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006763 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006764 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006765 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006766 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006767#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006768 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006769 /* We shouldn't be in different state as HKDF_EXPAND only allows
6770 * two inputs: SECRET (this case) and INFO which does not modify
6771 * the state. It could happen only if the hkdf
6772 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006773 if (hkdf->state != HKDF_STATE_INIT) {
6774 return PSA_ERROR_BAD_STATE;
6775 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006776
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006777 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006778 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6779 return PSA_ERROR_INVALID_ARGUMENT;
6780 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006781
Gilles Peskine449bd832023-01-11 14:50:10 +01006782 memcpy(hkdf->prk, data, data_length);
6783 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006784#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006785 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006786 /* HKDF: If no salt was provided, use an empty salt.
6787 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006788 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006789#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006790 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6791 return PSA_ERROR_BAD_STATE;
6792 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006793#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006794 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6795 hash_alg,
6796 NULL, 0);
6797 if (status != PSA_SUCCESS) {
6798 return status;
6799 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006800 hkdf->state = HKDF_STATE_STARTED;
6801 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006802 if (hkdf->state != HKDF_STATE_STARTED) {
6803 return PSA_ERROR_BAD_STATE;
6804 }
6805 status = psa_mac_update(&hkdf->hmac,
6806 data, data_length);
6807 if (status != PSA_SUCCESS) {
6808 return status;
6809 }
6810 status = psa_mac_sign_finish(&hkdf->hmac,
6811 hkdf->prk,
6812 sizeof(hkdf->prk),
6813 &data_length);
6814 if (status != PSA_SUCCESS) {
6815 return status;
6816 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006817 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006818
Gilles Peskine2b522db2019-04-12 15:11:49 +02006819 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006820 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006821#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006822 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006823 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006824 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006825 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006826 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006827#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006828 {
6829 /* Block 0 is empty, and the next block will be
6830 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006831 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006832 }
6833
Gilles Peskine449bd832023-01-11 14:50:10 +01006834 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006835 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006836#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006837 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6838 return PSA_ERROR_INVALID_ARGUMENT;
6839 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006840#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006841#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006842 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6843 hkdf->state == HKDF_STATE_INIT) {
6844 return PSA_ERROR_BAD_STATE;
6845 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006846#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006847 if (hkdf->state == HKDF_STATE_OUTPUT) {
6848 return PSA_ERROR_BAD_STATE;
6849 }
6850 if (hkdf->info_set) {
6851 return PSA_ERROR_BAD_STATE;
6852 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006853 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006854 if (data_length != 0) {
6855 hkdf->info = mbedtls_calloc(1, data_length);
6856 if (hkdf->info == NULL) {
6857 return PSA_ERROR_INSUFFICIENT_MEMORY;
6858 }
6859 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006860 }
6861 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006862 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006863 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006864 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006865 }
6866}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006867#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006868
John Durkop07cc04a2020-11-16 22:08:34 -08006869#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6870 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006871static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6872 const uint8_t *data,
6873 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006874{
Gilles Peskine449bd832023-01-11 14:50:10 +01006875 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6876 return PSA_ERROR_BAD_STATE;
6877 }
Janos Follathf08e2652019-06-13 09:05:41 +01006878
Gilles Peskine449bd832023-01-11 14:50:10 +01006879 if (data_length != 0) {
6880 prf->seed = mbedtls_calloc(1, data_length);
6881 if (prf->seed == NULL) {
6882 return PSA_ERROR_INSUFFICIENT_MEMORY;
6883 }
Janos Follathf08e2652019-06-13 09:05:41 +01006884
Gilles Peskine449bd832023-01-11 14:50:10 +01006885 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006886 prf->seed_length = data_length;
6887 }
Janos Follathf08e2652019-06-13 09:05:41 +01006888
Gilles Peskine43f958b2020-12-13 14:55:14 +01006889 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006890
Gilles Peskine449bd832023-01-11 14:50:10 +01006891 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006892}
6893
Gilles Peskine449bd832023-01-11 14:50:10 +01006894static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6895 const uint8_t *data,
6896 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006897{
Gilles Peskine449bd832023-01-11 14:50:10 +01006898 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6899 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6900 return PSA_ERROR_BAD_STATE;
6901 }
Janos Follath81550542019-06-13 14:26:34 +01006902
Gilles Peskine449bd832023-01-11 14:50:10 +01006903 if (data_length != 0) {
6904 prf->secret = mbedtls_calloc(1, data_length);
6905 if (prf->secret == NULL) {
6906 return PSA_ERROR_INSUFFICIENT_MEMORY;
6907 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006908
Gilles Peskine449bd832023-01-11 14:50:10 +01006909 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006910 prf->secret_length = data_length;
6911 }
Janos Follath81550542019-06-13 14:26:34 +01006912
Gilles Peskine43f958b2020-12-13 14:55:14 +01006913 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006914
Gilles Peskine449bd832023-01-11 14:50:10 +01006915 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006916}
6917
Gilles Peskine449bd832023-01-11 14:50:10 +01006918static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6919 const uint8_t *data,
6920 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006921{
Gilles Peskine449bd832023-01-11 14:50:10 +01006922 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6923 return PSA_ERROR_BAD_STATE;
6924 }
Janos Follath63028dd2019-06-13 09:15:47 +01006925
Gilles Peskine449bd832023-01-11 14:50:10 +01006926 if (data_length != 0) {
6927 prf->label = mbedtls_calloc(1, data_length);
6928 if (prf->label == NULL) {
6929 return PSA_ERROR_INSUFFICIENT_MEMORY;
6930 }
Janos Follath63028dd2019-06-13 09:15:47 +01006931
Gilles Peskine449bd832023-01-11 14:50:10 +01006932 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006933 prf->label_length = data_length;
6934 }
Janos Follath63028dd2019-06-13 09:15:47 +01006935
Gilles Peskine43f958b2020-12-13 14:55:14 +01006936 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006937
Gilles Peskine449bd832023-01-11 14:50:10 +01006938 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006939}
6940
Gilles Peskine449bd832023-01-11 14:50:10 +01006941static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6942 psa_key_derivation_step_t step,
6943 const uint8_t *data,
6944 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006945{
Gilles Peskine449bd832023-01-11 14:50:10 +01006946 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006947 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006948 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006949 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006950 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006951 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006952 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006953 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006954 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006955 }
6956}
John Durkop07cc04a2020-11-16 22:08:34 -08006957#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6958 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6959
6960#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6961static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6962 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006963 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006964 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006965{
6966 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006967 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6968 4 + data_length + prf->other_secret_length :
6969 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006970
Gilles Peskine449bd832023-01-11 14:50:10 +01006971 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6972 return PSA_ERROR_INVALID_ARGUMENT;
6973 }
John Durkop07cc04a2020-11-16 22:08:34 -08006974
Gilles Peskine449bd832023-01-11 14:50:10 +01006975 uint8_t *pms = mbedtls_calloc(1, pms_len);
6976 if (pms == NULL) {
6977 return PSA_ERROR_INSUFFICIENT_MEMORY;
6978 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006979 uint8_t *cur = pms;
6980
6981 /* pure-PSK:
6982 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006983 *
6984 * The premaster secret is formed as follows: if the PSK is N octets
6985 * long, concatenate a uint16 with the value N, N zero octets, a second
6986 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006987 *
6988 * mixed-PSK:
6989 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6990 * follows: concatenate a uint16 with the length of the other secret,
6991 * the other secret itself, uint16 with the length of PSK, and the
6992 * PSK itself.
6993 * For details please check:
6994 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6995 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6996 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006997 */
6998
Gilles Peskine449bd832023-01-11 14:50:10 +01006999 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
7000 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
7001 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
7002 if (prf->other_secret_length != 0) {
7003 memcpy(cur, prf->other_secret, prf->other_secret_length);
7004 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02007005 cur += prf->other_secret_length;
7006 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007007 } else {
7008 *cur++ = MBEDTLS_BYTE_1(data_length);
7009 *cur++ = MBEDTLS_BYTE_0(data_length);
7010 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02007011 cur += data_length;
7012 }
7013
Gilles Peskine449bd832023-01-11 14:50:10 +01007014 *cur++ = MBEDTLS_BYTE_1(data_length);
7015 *cur++ = MBEDTLS_BYTE_0(data_length);
7016 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08007017 cur += data_length;
7018
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00007019 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08007020
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01007021 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01007022 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08007023}
Janos Follath6660f0e2019-06-17 08:44:03 +01007024
Przemek Stekiele47201b2022-04-19 13:53:28 +02007025static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
7026 psa_tls12_prf_key_derivation_t *prf,
7027 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007028 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02007029{
Gilles Peskine449bd832023-01-11 14:50:10 +01007030 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
7031 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02007032 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007033
7034 if (data_length != 0) {
7035 prf->other_secret = mbedtls_calloc(1, data_length);
7036 if (prf->other_secret == NULL) {
7037 return PSA_ERROR_INSUFFICIENT_MEMORY;
7038 }
7039
7040 memcpy(prf->other_secret, data, data_length);
7041 prf->other_secret_length = data_length;
7042 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02007043 prf->other_secret_length = 0;
7044 }
7045
7046 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
7047
Gilles Peskine449bd832023-01-11 14:50:10 +01007048 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02007049}
7050
Janos Follath6660f0e2019-06-17 08:44:03 +01007051static psa_status_t psa_tls12_prf_psk_to_ms_input(
7052 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01007053 psa_key_derivation_step_t step,
7054 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007055 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01007056{
Gilles Peskine449bd832023-01-11 14:50:10 +01007057 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02007058 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007059 return psa_tls12_prf_psk_to_ms_set_key(prf,
7060 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02007061 break;
7062 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007063 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
7064 data,
7065 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02007066 break;
7067 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01007068 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02007069 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01007070
Przemek Stekiele47201b2022-04-19 13:53:28 +02007071 }
Janos Follath6660f0e2019-06-17 08:44:03 +01007072}
John Durkop07cc04a2020-11-16 22:08:34 -08007073#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007074
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007075#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
7076static psa_status_t psa_tls12_ecjpake_to_pms_input(
7077 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04007078 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007079 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007080 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007081{
Gilles Peskine449bd832023-01-11 14:50:10 +01007082 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
7083 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
7084 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04007085 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007086
7087 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01007088 if (data[0] != 0x04) {
7089 return PSA_ERROR_INVALID_ARGUMENT;
7090 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007091
7092 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007093 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007094
Gilles Peskine449bd832023-01-11 14:50:10 +01007095 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007096}
7097#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307098
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307099#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307100static psa_status_t psa_pbkdf2_set_input_cost(
7101 psa_pbkdf2_key_derivation_t *pbkdf2,
7102 psa_key_derivation_step_t step,
7103 uint64_t data)
7104{
7105 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
7106 return PSA_ERROR_INVALID_ARGUMENT;
7107 }
7108
7109 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
7110 return PSA_ERROR_BAD_STATE;
7111 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307112
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05307113 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307114 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307115 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05307116
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307117 if (data == 0) {
7118 return PSA_ERROR_INVALID_ARGUMENT;
7119 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05307120
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307121 pbkdf2->input_cost = data;
7122 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
7123
7124 return PSA_SUCCESS;
7125}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307126
7127static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
7128 const uint8_t *data,
7129 size_t data_length)
7130{
Gilles Peskineead17662023-08-20 22:02:51 +02007131 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
7132 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
7133 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
7134 /* Appending to existing salt. No state change. */
7135 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307136 return PSA_ERROR_BAD_STATE;
7137 }
7138
Gilles Peskineca57d782023-07-20 19:08:06 +02007139 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02007140 /* Appending an empty string, nothing to do. */
7141 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307142 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05307143
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307144 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
7145 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05307146 return PSA_ERROR_INSUFFICIENT_MEMORY;
7147 }
7148
Gilles Peskineead17662023-08-20 22:02:51 +02007149 if (pbkdf2->salt_length != 0) {
7150 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
7151 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307152 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05307153 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05307154 mbedtls_free(pbkdf2->salt);
7155 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307156 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05307157 return PSA_SUCCESS;
7158}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307159
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307160#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307161static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307162 const uint8_t *input,
7163 size_t input_len,
7164 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05307165 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307166{
7167 psa_status_t status = PSA_SUCCESS;
7168 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
Ryan Everett5d2e82f2024-02-07 17:24:59 +00007169 return psa_hash_compute(hash_alg, input, input_len, output,
7170 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
7171 } else if (input_len > 0) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307172 memcpy(output, input, input_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307173 }
Ryan Everett5d2e82f2024-02-07 17:24:59 +00007174 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307175 return status;
7176}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307177#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307178
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307179#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307180static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
7181 size_t input_len,
7182 uint8_t *output,
7183 size_t *output_len)
7184{
7185 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307186 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307187 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05307188 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307189 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
7190 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
7191 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307192 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05307193 * mac_size as the driver function sets mac_output_length = mac_size
7194 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307195 status = psa_driver_wrapper_mac_compute(&attributes,
7196 zeros, sizeof(zeros),
7197 PSA_ALG_CMAC, input, input_len,
7198 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307199 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
7200 128U,
7201 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307202 output_len);
7203 } else {
7204 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307205 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307206 }
7207 return status;
7208}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307209#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307210
7211static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307212 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307213 const uint8_t *data,
7214 size_t data_length)
7215{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307216 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307217 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
7218 return PSA_ERROR_BAD_STATE;
7219 }
7220
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307221#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307222 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
7223 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
7224 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
7225 pbkdf2->password,
7226 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307227 } else
7228#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
7229#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
7230 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307231 status = psa_pbkdf2_cmac_set_password(data, data_length,
7232 pbkdf2->password,
7233 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307234 } else
7235#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
7236 {
7237 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307238 }
7239
7240 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
7241
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307242 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307243}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307244
7245static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307246 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307247 psa_key_derivation_step_t step,
7248 const uint8_t *data,
7249 size_t data_length)
7250{
7251 switch (step) {
7252 case PSA_KEY_DERIVATION_INPUT_SALT:
7253 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
7254 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307255 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307256 default:
7257 return PSA_ERROR_INVALID_ARGUMENT;
7258 }
7259}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307260#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307261
Gilles Peskineb8965192019-09-24 16:21:10 +02007262/** Check whether the given key type is acceptable for the given
7263 * input step of a key derivation.
7264 *
7265 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
7266 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
7267 * Both secret and non-secret inputs can alternatively have the type
7268 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
7269 * that the input was passed as a buffer rather than via a key object.
7270 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02007271static int psa_key_derivation_check_input_type(
7272 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007273 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02007274{
Gilles Peskine449bd832023-01-11 14:50:10 +01007275 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007276 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007277 if (key_type == PSA_KEY_TYPE_DERIVE) {
7278 return PSA_SUCCESS;
7279 }
7280 if (key_type == PSA_KEY_TYPE_NONE) {
7281 return PSA_SUCCESS;
7282 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007283 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02007284 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007285 if (key_type == PSA_KEY_TYPE_DERIVE) {
7286 return PSA_SUCCESS;
7287 }
7288 if (key_type == PSA_KEY_TYPE_NONE) {
7289 return PSA_SUCCESS;
7290 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02007291 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007292 case PSA_KEY_DERIVATION_INPUT_LABEL:
7293 case PSA_KEY_DERIVATION_INPUT_SALT:
7294 case PSA_KEY_DERIVATION_INPUT_INFO:
7295 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01007296 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
7297 return PSA_SUCCESS;
7298 }
7299 if (key_type == PSA_KEY_TYPE_NONE) {
7300 return PSA_SUCCESS;
7301 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007302 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307303 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
7304 if (key_type == PSA_KEY_TYPE_PASSWORD) {
7305 return PSA_SUCCESS;
7306 }
7307 if (key_type == PSA_KEY_TYPE_DERIVE) {
7308 return PSA_SUCCESS;
7309 }
7310 if (key_type == PSA_KEY_TYPE_NONE) {
7311 return PSA_SUCCESS;
7312 }
7313 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007314 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007315 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007316}
7317
Janos Follathb80a94e2019-06-12 15:54:46 +01007318static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007319 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007320 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007321 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007322 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007323 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007324{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007325 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007326 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007327
Gilles Peskine449bd832023-01-11 14:50:10 +01007328 status = psa_key_derivation_check_input_type(step, key_type);
7329 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007330 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007331 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007332
Przemek Stekiel69c46792022-06-10 12:59:51 +02007333#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007334 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7335 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7336 step, data, data_length);
7337 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007338#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007339#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007340 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7341 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7342 step, data, data_length);
7343 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007344#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7345#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007346 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7347 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7348 step, data, data_length);
7349 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007350#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007351#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007352 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007353 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007354 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7355 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007356#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307357#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307358 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307359 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7360 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307361 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307362#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007363 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007364 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007365 (void) data;
7366 (void) data_length;
7367 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007368 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007369 }
7370
Gilles Peskine224b0d62019-09-23 18:13:17 +02007371exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007372 if (status != PSA_SUCCESS) {
7373 psa_key_derivation_abort(operation);
7374 }
7375 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007376}
7377
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307378static psa_status_t psa_key_derivation_input_integer_internal(
7379 psa_key_derivation_operation_t *operation,
7380 psa_key_derivation_step_t step,
7381 uint64_t value)
7382{
7383 psa_status_t status;
7384 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7385
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307386#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307387 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307388 status = psa_pbkdf2_set_input_cost(
7389 &operation->ctx.pbkdf2, step, value);
7390 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307391#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307392 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307393 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307394 (void) value;
7395 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307396 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307397 }
7398
7399 if (status != PSA_SUCCESS) {
7400 psa_key_derivation_abort(operation);
7401 }
7402 return status;
7403}
7404
Janos Follath51f4a0f2019-06-14 11:35:55 +01007405psa_status_t psa_key_derivation_input_bytes(
7406 psa_key_derivation_operation_t *operation,
7407 psa_key_derivation_step_t step,
Ryan Everettd1e398c2024-01-19 14:46:00 +00007408 const uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007409 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007410{
Ryan Everettd1e398c2024-01-19 14:46:00 +00007411 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
7412 LOCAL_INPUT_DECLARE(data_external, data);
7413
7414 LOCAL_INPUT_ALLOC(data_external, data_length, data);
7415
7416 status = psa_key_derivation_input_internal(operation, step,
7417 PSA_KEY_TYPE_NONE,
7418 data, data_length);
Ryan Everettb41c3c92024-01-25 11:56:35 +00007419#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Ryan Everettd1e398c2024-01-19 14:46:00 +00007420exit:
Ryan Everettb41c3c92024-01-25 11:56:35 +00007421#endif
Ryan Everettd1e398c2024-01-19 14:46:00 +00007422 LOCAL_INPUT_FREE(data_external, data);
7423 return status;
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007424}
7425
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307426psa_status_t psa_key_derivation_input_integer(
7427 psa_key_derivation_operation_t *operation,
7428 psa_key_derivation_step_t step,
7429 uint64_t value)
7430{
7431 return psa_key_derivation_input_integer_internal(operation, step, value);
7432}
7433
Janos Follath51f4a0f2019-06-14 11:35:55 +01007434psa_status_t psa_key_derivation_input_key(
7435 psa_key_derivation_operation_t *operation,
7436 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007437 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007438{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007439 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007440 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007441 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007442
Ronald Cron5c522922020-11-14 16:35:34 +01007443 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007444 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7445 if (status != PSA_SUCCESS) {
7446 psa_key_derivation_abort(operation);
7447 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007448 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007449
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307450 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7451 * permission to output to a key object. */
7452 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7453 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007454 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007455 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007456
Gilles Peskine449bd832023-01-11 14:50:10 +01007457 status = psa_key_derivation_input_internal(operation,
7458 step, slot->attr.type,
7459 slot->key.data,
7460 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007461
Ryan Everett1b70a072024-01-04 10:32:49 +00007462 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007463
Gilles Peskine449bd832023-01-11 14:50:10 +01007464 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007465}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007466
7467
7468
7469/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007470/* Key agreement */
7471/****************************************************************/
7472
Gilles Peskine449bd832023-01-11 14:50:10 +01007473psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7474 const uint8_t *key_buffer,
7475 size_t key_buffer_size,
7476 psa_algorithm_t alg,
7477 const uint8_t *peer_key,
7478 size_t peer_key_length,
7479 uint8_t *shared_secret,
7480 size_t shared_secret_size,
7481 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007482{
Gilles Peskine449bd832023-01-11 14:50:10 +01007483 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007484#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007485 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7487 key_buffer_size, alg,
7488 peer_key, peer_key_length,
7489 shared_secret,
7490 shared_secret_size,
7491 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007492#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007493
7494#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7495 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007496 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007497 peer_key,
7498 peer_key_length,
7499 key_buffer,
7500 key_buffer_size,
7501 shared_secret,
7502 shared_secret_size,
7503 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007504#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7505
Gilles Peskine01d718c2018-09-18 12:01:02 +02007506 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007507 (void) attributes;
7508 (void) key_buffer;
7509 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007510 (void) peer_key;
7511 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007512 (void) shared_secret;
7513 (void) shared_secret_size;
7514 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007515 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007516 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007517}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007518
Aditya Deshpande17845b82022-10-13 17:21:01 +01007519/** Internal function for raw key agreement
7520 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007521 * to the driver's implementation if a driver is present.
7522 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007523 * (psa_key_agreement_raw_builtin).
7524 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007525static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7526 psa_key_slot_t *private_key,
7527 const uint8_t *peer_key,
7528 size_t peer_key_length,
7529 uint8_t *shared_secret,
7530 size_t shared_secret_size,
7531 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007532{
Gilles Peskine449bd832023-01-11 14:50:10 +01007533 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7534 return PSA_ERROR_NOT_SUPPORTED;
7535 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007536
7537 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007538 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007539 };
7540
Gilles Peskine449bd832023-01-11 14:50:10 +01007541 return psa_driver_wrapper_key_agreement(&attributes,
7542 private_key->key.data,
7543 private_key->key.bytes, alg,
7544 peer_key, peer_key_length,
7545 shared_secret,
7546 shared_secret_size,
7547 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007548}
7549
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007550/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007551 * to potentially free embedded data structures and wipe confidential data.
7552 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007553static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7554 psa_key_derivation_step_t step,
7555 psa_key_slot_t *private_key,
7556 const uint8_t *peer_key,
7557 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007558{
7559 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007560 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007561 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007562 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007563
7564 /* Step 1: run the secret agreement algorithm to generate the shared
7565 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007566 status = psa_key_agreement_raw_internal(ka_alg,
7567 private_key,
7568 peer_key, peer_key_length,
7569 shared_secret,
7570 sizeof(shared_secret),
7571 &shared_secret_length);
7572 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007573 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007574 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007575
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007576 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007577 * the shared secret. A shared secret is permitted wherever a key
7578 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007579 status = psa_key_derivation_input_internal(operation, step,
7580 PSA_KEY_TYPE_DERIVE,
7581 shared_secret,
7582 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007583exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007584 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7585 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007586}
7587
Gilles Peskine449bd832023-01-11 14:50:10 +01007588psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7589 psa_key_derivation_step_t step,
7590 mbedtls_svc_key_id_t private_key,
Thomas Daubney9739ac02024-02-15 13:15:47 +00007591 const uint8_t *peer_key_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007592 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007593{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007594 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007595 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007596 psa_key_slot_t *slot;
Thomas Daubney9739ac02024-02-15 13:15:47 +00007597 LOCAL_INPUT_DECLARE(peer_key_external, peer_key);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007598
Gilles Peskine449bd832023-01-11 14:50:10 +01007599 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7600 return PSA_ERROR_INVALID_ARGUMENT;
7601 }
Ronald Cron5c522922020-11-14 16:35:34 +01007602 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007603 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7604 if (status != PSA_SUCCESS) {
7605 return status;
7606 }
Thomas Daubney9739ac02024-02-15 13:15:47 +00007607
Thomas Daubney692fb3c2024-03-12 16:20:41 +00007608 LOCAL_INPUT_ALLOC(peer_key_external, peer_key_length, peer_key);
Gilles Peskine449bd832023-01-11 14:50:10 +01007609 status = psa_key_agreement_internal(operation, step,
7610 slot,
7611 peer_key, peer_key_length);
Thomas Daubney9739ac02024-02-15 13:15:47 +00007612
Thomas Daubney50f58fc2024-02-15 14:24:03 +00007613#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney9739ac02024-02-15 13:15:47 +00007614exit:
Thomas Daubney50f58fc2024-02-15 14:24:03 +00007615#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01007616 if (status != PSA_SUCCESS) {
7617 psa_key_derivation_abort(operation);
7618 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007619 /* If a private key has been added as SECRET, we allow the derived
7620 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007621 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007622 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007623 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007624 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007625
Ryan Everett1b70a072024-01-04 10:32:49 +00007626 unlock_status = psa_unregister_read(slot);
Thomas Daubney9739ac02024-02-15 13:15:47 +00007627 LOCAL_INPUT_FREE(peer_key_external, peer_key);
Gilles Peskine449bd832023-01-11 14:50:10 +01007628 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007629}
7630
Gilles Peskine449bd832023-01-11 14:50:10 +01007631psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7632 mbedtls_svc_key_id_t private_key,
Thomas Daubney81899ab2024-02-15 12:57:26 +00007633 const uint8_t *peer_key_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007634 size_t peer_key_length,
Thomas Daubney81899ab2024-02-15 12:57:26 +00007635 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007636 size_t output_size,
7637 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007638{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007639 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007640 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007641 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007642 size_t expected_length;
Thomas Daubney81899ab2024-02-15 12:57:26 +00007643 LOCAL_INPUT_DECLARE(peer_key_external, peer_key);
7644 LOCAL_OUTPUT_DECLARE(output_external, output);
Thomas Daubney89d8c2a2024-02-21 11:16:16 +00007645 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007646
Gilles Peskine449bd832023-01-11 14:50:10 +01007647 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007648 status = PSA_ERROR_INVALID_ARGUMENT;
7649 goto exit;
7650 }
Ronald Cron5c522922020-11-14 16:35:34 +01007651 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007652 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7653 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007654 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007655 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007656
Gilles Peskine3e561302022-04-14 00:17:15 +02007657 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7658 * for the output size. The PSA specification only guarantees that this
7659 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7660 * but it might be nice to allow smaller buffers if the output fits.
7661 * At the time of writing this comment, with only ECDH implemented,
7662 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7663 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7664 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007665 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007666 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7667 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007668 status = PSA_ERROR_BUFFER_TOO_SMALL;
7669 goto exit;
7670 }
7671
Thomas Daubney81899ab2024-02-15 12:57:26 +00007672 LOCAL_INPUT_ALLOC(peer_key_external, peer_key_length, peer_key);
Gilles Peskine449bd832023-01-11 14:50:10 +01007673 status = psa_key_agreement_raw_internal(alg, slot,
7674 peer_key, peer_key_length,
7675 output, output_size,
7676 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007677
7678exit:
Thomas Daubney5390aca2024-02-22 11:06:04 +00007679 /* Check for successful allocation of output,
7680 * with an unsuccessful status. */
Thomas Daubney0576a6a2024-02-21 15:15:00 +00007681 if (output != NULL && status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007682 /* If an error happens and is not handled properly, the output
7683 * may be used as a key to protect sensitive data. Arrange for such
7684 * a key to be random, which is likely to result in decryption or
7685 * verification errors. This is better than filling the buffer with
7686 * some constant data such as zeros, which would result in the data
7687 * being protected with a reproducible, easily knowable key.
7688 */
David Horstmann6e99bb22024-02-06 15:27:49 +00007689 psa_generate_random_internal(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007690 *output_length = output_size;
7691 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007692
Thomas Daubney5390aca2024-02-22 11:06:04 +00007693 if (output == NULL) {
Thomas Daubney89d8c2a2024-02-21 11:16:16 +00007694 /* output allocation failed. */
7695 *output_length = 0;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007696 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007697
Ryan Everett1b70a072024-01-04 10:32:49 +00007698 unlock_status = psa_unregister_read(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007699
Thomas Daubney81899ab2024-02-15 12:57:26 +00007700 LOCAL_INPUT_FREE(peer_key_external, peer_key);
7701 LOCAL_OUTPUT_FREE(output_external, output);
Gilles Peskine449bd832023-01-11 14:50:10 +01007702 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007703}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007704
7705
7706/****************************************************************/
7707/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007708/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007709
Gilles Peskine672a7712023-04-28 21:00:28 +02007710#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7711#include "entropy_poll.h"
7712#endif
7713
Gilles Peskine30524eb2020-11-13 17:02:26 +01007714/** Initialize the PSA random generator.
7715 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007716static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007717{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007718#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007719 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007720#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7721
Gilles Peskine30524eb2020-11-13 17:02:26 +01007722 /* Set default configuration if
7723 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007724 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007725 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007726 }
7727 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007728 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007729 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007730
Gilles Peskine449bd832023-01-11 14:50:10 +01007731 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007732#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7733 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7734 /* The PSA entropy injection feature depends on using NV seed as an entropy
7735 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007736 mbedtls_entropy_add_source(&rng->entropy,
7737 mbedtls_nv_seed_poll, NULL,
7738 MBEDTLS_ENTROPY_BLOCK_SIZE,
7739 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007740#endif
7741
Gilles Peskine449bd832023-01-11 14:50:10 +01007742 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007743#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007744}
7745
7746/** Deinitialize the PSA random generator.
7747 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007748static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007749{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007750#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007751 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007752#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine449bd832023-01-11 14:50:10 +01007753 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7754 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007755#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007756}
7757
7758/** Seed the PSA random generator.
7759 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007760static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007761{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007762#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7763 /* Do nothing: the external RNG seeds itself. */
7764 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007765 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007766#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007767 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007768 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7769 drbg_seed, sizeof(drbg_seed) - 1);
7770 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007771#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007772}
7773
David Horstmann6e99bb22024-02-06 15:27:49 +00007774psa_status_t psa_generate_random(uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01007775 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007776{
David Horstmann6e99bb22024-02-06 15:27:49 +00007777 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007778
David Horstmann6e99bb22024-02-06 15:27:49 +00007779 LOCAL_OUTPUT_DECLARE(output_external, output);
7780 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007781
David Horstmann6e99bb22024-02-06 15:27:49 +00007782 status = psa_generate_random_internal(output, output_size);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007783
David Horstmanne097bbd2024-02-28 14:17:10 +00007784#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
David Horstmann6e99bb22024-02-06 15:27:49 +00007785exit:
David Horstmanne097bbd2024-02-28 14:17:10 +00007786#endif
David Horstmann6e99bb22024-02-06 15:27:49 +00007787 LOCAL_OUTPUT_FREE(output_external, output);
7788 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007789}
7790
Gilles Peskine8814fc42020-12-14 15:33:44 +01007791/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007792 *
7793 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7794 * `psa_generate_random(...)`. The state parameter is ignored since the
7795 * PSA API doesn't support passing an explicit state.
7796 *
7797 * In the non-external case, psa_generate_random() calls an
7798 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7799 * and semantics as mbedtls_psa_get_random(). As an optimization,
7800 * instead of doing this back-and-forth between the PSA API and the
7801 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7802 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007803 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007804#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7805int mbedtls_psa_get_random(void *p_rng,
7806 unsigned char *output,
7807 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007808{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007809 /* This function takes a pointer to the RNG state because that's what
7810 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7811 * its own state internally and doesn't let the caller access that state.
7812 * So we just ignore the state parameter, and in practice we'll pass
7813 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007814 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007815 psa_status_t status = psa_generate_random(output, output_size);
7816 if (status == PSA_SUCCESS) {
7817 return 0;
7818 } else {
7819 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7820 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007821}
7822#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7823
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007824#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007825psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7826 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007827{
Gilles Peskine449bd832023-01-11 14:50:10 +01007828 if (global_data.initialized) {
7829 return PSA_ERROR_NOT_PERMITTED;
7830 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007831
Gilles Peskine449bd832023-01-11 14:50:10 +01007832 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7833 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7834 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7835 return PSA_ERROR_INVALID_ARGUMENT;
7836 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007837
Gilles Peskine449bd832023-01-11 14:50:10 +01007838 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007839}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007840#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007841
Ronald Cron3772afe2021-02-08 16:10:05 +01007842/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007843 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007844 * \param type The key type
7845 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007846 *
7847 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007848 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007849 * \retval #PSA_ERROR_INVALID_ARGUMENT
7850 * The size in bits of the key is not valid.
7851 * \retval #PSA_ERROR_NOT_SUPPORTED
7852 * The type and/or the size in bits of the key or the combination of
7853 * the two is not supported.
7854 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007855static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007856 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007857{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007858 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007859
Gilles Peskine449bd832023-01-11 14:50:10 +01007860 if (key_type_is_raw_bytes(type)) {
7861 status = psa_validate_unstructured_key_bit_size(type, bits);
7862 if (status != PSA_SUCCESS) {
7863 return status;
7864 }
7865 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007866#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007867 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7868 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7869 return PSA_ERROR_NOT_SUPPORTED;
7870 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007871 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007872 return PSA_ERROR_NOT_SUPPORTED;
7873 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007874
Ronald Cron01b2aba2020-10-05 09:42:02 +02007875 /* Accept only byte-aligned keys, for the same reasons as
7876 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007877 if (bits % 8 != 0) {
7878 return PSA_ERROR_NOT_SUPPORTED;
7879 }
7880 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007881#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007882
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007883#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007884 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007885 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007886 return PSA_SUCCESS;
7887 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007888#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007889
Valerio Settia55f0422023-07-10 15:34:41 +02007890#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007891 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007892 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007893 return PSA_ERROR_NOT_SUPPORTED;
7894 }
7895 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007896#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007897 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007898 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007899 }
7900
Gilles Peskine449bd832023-01-11 14:50:10 +01007901 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007902}
7903
Ronald Cron55ed0592020-10-05 10:30:40 +02007904psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007905 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007906 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007907{
7908 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007909 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007910
Gilles Peskine449bd832023-01-11 14:50:10 +01007911 if ((attributes->domain_parameters == NULL) &&
7912 (attributes->domain_parameters_size != 0)) {
7913 return PSA_ERROR_INVALID_ARGUMENT;
7914 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007915
Gilles Peskine449bd832023-01-11 14:50:10 +01007916 if (key_type_is_raw_bytes(type)) {
7917 status = psa_generate_random(key_buffer, key_buffer_size);
7918 if (status != PSA_SUCCESS) {
7919 return status;
7920 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007921
David Brown12ca5032021-02-11 11:02:00 -07007922#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007923 if (type == PSA_KEY_TYPE_DES) {
7924 psa_des_set_key_parity(key_buffer, key_buffer_size);
7925 }
David Brown8107e312021-02-12 08:08:46 -07007926#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007927 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007928
Valerio Setti76df8c12023-07-11 14:11:28 +02007929#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007930 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7931 return mbedtls_psa_rsa_generate_key(attributes,
7932 key_buffer,
7933 key_buffer_size,
7934 key_buffer_length);
7935 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007936#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007937
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007938#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007939 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7940 return mbedtls_psa_ecp_generate_key(attributes,
7941 key_buffer,
7942 key_buffer_size,
7943 key_buffer_length);
7944 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007945#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007946
Valerio Settia55f0422023-07-10 15:34:41 +02007947#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007948 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7949 return mbedtls_psa_ffdh_generate_key(attributes,
7950 key_buffer,
7951 key_buffer_size,
7952 key_buffer_length);
7953 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007954#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007955 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007956 (void) key_buffer_length;
7957 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007958 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007959
Gilles Peskine449bd832023-01-11 14:50:10 +01007960 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007961}
Darryl Green0c6575a2018-11-07 16:05:30 +00007962
Gilles Peskine449bd832023-01-11 14:50:10 +01007963psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7964 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007965{
7966 psa_status_t status;
7967 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007968 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007969 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007970
Ronald Cron81709fc2020-11-14 12:10:32 +01007971 *key = MBEDTLS_SVC_KEY_ID_INIT;
7972
Gilles Peskine0f84d622019-09-12 19:03:13 +02007973 /* Reject any attempt to create a zero-length key so that we don't
7974 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007975 if (psa_get_key_bits(attributes) == 0) {
7976 return PSA_ERROR_INVALID_ARGUMENT;
7977 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007978
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007979 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007980 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7981 return PSA_ERROR_INVALID_ARGUMENT;
7982 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007983
Gilles Peskine449bd832023-01-11 14:50:10 +01007984 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7985 &slot, &driver);
7986 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007987 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007988 }
Gilles Peskine11792082019-08-06 18:36:36 +02007989
Ronald Cron977c2472020-10-13 08:32:21 +02007990 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307991 * storage ( thus not in the case of generating a key in a secure element
7992 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7993 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007994 if (slot->key.data == NULL) {
7995 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7996 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007997 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007998 attributes->core.type, attributes->core.bits);
7999 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01008000 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008001 }
Ronald Cron3772afe2021-02-08 16:10:05 +01008002
8003 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01008004 attributes->core.type,
8005 attributes->core.bits);
8006 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02008007 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01008008 attributes, &key_buffer_size);
8009 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01008010 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008011 }
Ronald Cron977c2472020-10-13 08:32:21 +02008012 }
Ronald Cron977c2472020-10-13 08:32:21 +02008013
Gilles Peskine449bd832023-01-11 14:50:10 +01008014 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
8015 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02008016 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008017 }
Ronald Cron977c2472020-10-13 08:32:21 +02008018 }
8019
Gilles Peskine449bd832023-01-11 14:50:10 +01008020 status = psa_driver_wrapper_generate_key(attributes,
8021 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02008022
Gilles Peskine449bd832023-01-11 14:50:10 +01008023 if (status != PSA_SUCCESS) {
8024 psa_remove_key_data_from_memory(slot);
8025 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02008026
Gilles Peskine11792082019-08-06 18:36:36 +02008027exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008028 if (status == PSA_SUCCESS) {
8029 status = psa_finish_key_creation(slot, driver, key);
8030 }
8031 if (status != PSA_SUCCESS) {
8032 psa_fail_key_creation(slot, driver);
8033 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02008034
Gilles Peskine449bd832023-01-11 14:50:10 +01008035 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008036}
8037
Gilles Peskinee59236f2018-01-27 23:32:46 +01008038/****************************************************************/
8039/* Module setup */
8040/****************************************************************/
8041
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01008042#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01008043psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01008044 void (* entropy_init)(mbedtls_entropy_context *ctx),
8045 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01008046{
Gilles Peskine449bd832023-01-11 14:50:10 +01008047 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
8048 return PSA_ERROR_BAD_STATE;
8049 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01008050 global_data.rng.entropy_init = entropy_init;
8051 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01008052 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01008053}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01008054#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01008055
Gilles Peskine449bd832023-01-11 14:50:10 +01008056void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01008057{
Gilles Peskine449bd832023-01-11 14:50:10 +01008058 psa_wipe_all_key_slots();
8059 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
8060 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01008061 }
8062 /* Wipe all remaining data, including configuration.
8063 * In particular, this sets all state indicator to the value
8064 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01008065 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02008066
8067 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01008068 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01008069}
8070
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008071#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
8072/** Recover a transaction that was interrupted by a power failure.
8073 *
8074 * This function is called during initialization, before psa_crypto_init()
8075 * returns. If this function returns a failure status, the initialization
8076 * fails.
8077 */
8078static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01008079 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008080{
Gilles Peskine449bd832023-01-11 14:50:10 +01008081 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008082 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
8083 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01008084 /* TODO - fall through to the failure case until this
8085 * is implemented.
8086 * https://github.com/ARMmbed/mbed-crypto/issues/218
8087 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008088 default:
8089 /* We found an unsupported transaction in the storage.
8090 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008091 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008092 }
8093}
8094#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
8095
Gilles Peskine449bd832023-01-11 14:50:10 +01008096psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01008097{
Gilles Peskine66fb1262018-12-10 16:29:04 +01008098 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008099
Gilles Peskinec6b69072018-11-20 21:42:52 +01008100 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008101 if (global_data.initialized != 0) {
8102 return PSA_SUCCESS;
8103 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01008104
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01008105 /* Init drivers */
8106 status = psa_driver_wrapper_init();
8107 if (status != PSA_SUCCESS) {
8108 goto exit;
8109 }
8110 global_data.drivers_initialized = 1;
8111
Valerio Setti402cfba2023-11-13 10:24:32 +01008112 status = psa_initialize_key_slots();
8113 if (status != PSA_SUCCESS) {
8114 goto exit;
8115 }
8116
Gilles Peskine30524eb2020-11-13 17:02:26 +01008117 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01008118 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01008119 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01008120 status = mbedtls_psa_random_seed(&global_data.rng);
8121 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01008122 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008123 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01008124 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008125
Gilles Peskine4b734222019-07-24 15:56:31 +02008126#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01008127 status = psa_crypto_load_transaction();
8128 if (status == PSA_SUCCESS) {
8129 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
8130 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02008131 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01008132 }
8133 status = psa_crypto_stop_transaction();
8134 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02008135 /* There's no transaction to complete. It's all good. */
8136 status = PSA_SUCCESS;
8137 }
Gilles Peskine4b734222019-07-24 15:56:31 +02008138#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02008139
Gilles Peskinec6b69072018-11-20 21:42:52 +01008140 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01008141 global_data.initialized = 1;
8142
8143exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01008144 if (status != PSA_SUCCESS) {
8145 mbedtls_psa_crypto_free();
8146 }
8147 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01008148}
8149
Yanray Wangffc3c482023-07-11 12:01:04 +08008150#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008151psa_status_t psa_crypto_driver_pake_get_password_len(
8152 const psa_crypto_driver_pake_inputs_t *inputs,
8153 size_t *password_len)
8154{
8155 if (inputs->password_len == 0) {
8156 return PSA_ERROR_BAD_STATE;
8157 }
8158
8159 *password_len = inputs->password_len;
8160
8161 return PSA_SUCCESS;
8162}
8163
8164psa_status_t psa_crypto_driver_pake_get_password(
8165 const psa_crypto_driver_pake_inputs_t *inputs,
8166 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
8167{
8168 if (inputs->password_len == 0) {
8169 return PSA_ERROR_BAD_STATE;
8170 }
8171
8172 if (buffer_size < inputs->password_len) {
8173 return PSA_ERROR_BUFFER_TOO_SMALL;
8174 }
8175
8176 memcpy(buffer, inputs->password, inputs->password_len);
8177 *buffer_length = inputs->password_len;
8178
8179 return PSA_SUCCESS;
8180}
8181
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008182psa_status_t psa_crypto_driver_pake_get_user_len(
8183 const psa_crypto_driver_pake_inputs_t *inputs,
8184 size_t *user_len)
8185{
8186 if (inputs->user_len == 0) {
8187 return PSA_ERROR_BAD_STATE;
8188 }
8189
8190 *user_len = inputs->user_len;
8191
8192 return PSA_SUCCESS;
8193}
8194
8195psa_status_t psa_crypto_driver_pake_get_user(
8196 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008197 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008198{
8199 if (inputs->user_len == 0) {
8200 return PSA_ERROR_BAD_STATE;
8201 }
8202
Przemek Stekielc0e62502023-03-14 11:49:36 +01008203 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008204 return PSA_ERROR_BUFFER_TOO_SMALL;
8205 }
8206
Przemek Stekielc0e62502023-03-14 11:49:36 +01008207 memcpy(user_id, inputs->user, inputs->user_len);
8208 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008209
8210 return PSA_SUCCESS;
8211}
8212
8213psa_status_t psa_crypto_driver_pake_get_peer_len(
8214 const psa_crypto_driver_pake_inputs_t *inputs,
8215 size_t *peer_len)
8216{
8217 if (inputs->peer_len == 0) {
8218 return PSA_ERROR_BAD_STATE;
8219 }
8220
8221 *peer_len = inputs->peer_len;
8222
8223 return PSA_SUCCESS;
8224}
8225
8226psa_status_t psa_crypto_driver_pake_get_peer(
8227 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008228 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008229{
8230 if (inputs->peer_len == 0) {
8231 return PSA_ERROR_BAD_STATE;
8232 }
8233
Przemek Stekielc0e62502023-03-14 11:49:36 +01008234 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008235 return PSA_ERROR_BUFFER_TOO_SMALL;
8236 }
8237
Przemek Stekielc0e62502023-03-14 11:49:36 +01008238 memcpy(peer_id, inputs->peer, inputs->peer_len);
8239 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008240
8241 return PSA_SUCCESS;
8242}
8243
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008244psa_status_t psa_crypto_driver_pake_get_cipher_suite(
8245 const psa_crypto_driver_pake_inputs_t *inputs,
8246 psa_pake_cipher_suite_t *cipher_suite)
8247{
8248 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
8249 return PSA_ERROR_BAD_STATE;
8250 }
8251
8252 *cipher_suite = inputs->cipher_suite;
8253
8254 return PSA_SUCCESS;
8255}
8256
Neil Armstronga7d08c32022-06-01 18:21:20 +02008257psa_status_t psa_pake_setup(
8258 psa_pake_operation_t *operation,
8259 const psa_pake_cipher_suite_t *cipher_suite)
8260{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008261 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008262
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008263 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008264 status = PSA_ERROR_BAD_STATE;
8265 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008266 }
8267
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008268 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01008269 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008270 status = PSA_ERROR_INVALID_ARGUMENT;
8271 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008272 }
8273
Przemek Stekiel51eac532022-12-07 11:04:51 +01008274 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
8275
Przemek Stekiele12ed362022-12-21 12:54:46 +01008276 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01008277 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
8278 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008279 operation->data.inputs.cipher_suite = *cipher_suite;
8280
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008281#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008282 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008283 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01008284 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008285
David Horstmann16f01512023-06-14 17:21:07 +01008286 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01008287 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008288 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008289#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008290 {
8291 status = PSA_ERROR_NOT_SUPPORTED;
8292 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008293 }
8294
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008295 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
8296
Przemek Stekiel51eac532022-12-07 11:04:51 +01008297 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008298exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008299 psa_pake_abort(operation);
8300 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008301}
8302
8303psa_status_t psa_pake_set_password_key(
8304 psa_pake_operation_t *operation,
8305 mbedtls_svc_key_id_t password)
8306{
Neil Armstrong5ae60962022-09-15 11:29:46 +02008307 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01008308 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
8309 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008310 psa_key_attributes_t attributes;
8311 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008312
Przemek Stekiel51eac532022-12-07 11:04:51 +01008313 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008314 status = PSA_ERROR_BAD_STATE;
8315 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008316 }
8317
Przemek Stekiel6c764412022-11-22 14:05:12 +01008318 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
8319 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008320 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008321 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008322 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008323 }
8324
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008325 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01008326 .core = slot->attr
8327 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02008328
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008329 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008330
Przemek Stekiel51eac532022-12-07 11:04:51 +01008331 if (type != PSA_KEY_TYPE_PASSWORD &&
8332 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8333 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008334 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008335 }
8336
Przemek Stekiel51eac532022-12-07 11:04:51 +01008337 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8338 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008339 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008340 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008341 }
8342
8343 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8344 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01008345 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008346exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008347 if (status != PSA_SUCCESS) {
8348 psa_pake_abort(operation);
8349 }
Ryan Everett1b70a072024-01-04 10:32:49 +00008350 unlock_status = psa_unregister_read(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008351 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008352}
8353
8354psa_status_t psa_pake_set_user(
8355 psa_pake_operation_t *operation,
David Horstmann4f534ae2024-01-22 17:35:59 +00008356 const uint8_t *user_id_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008357 size_t user_id_len)
8358{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008359 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
David Horstmann4f534ae2024-01-22 17:35:59 +00008360 LOCAL_INPUT_DECLARE(user_id_external, user_id);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008361
8362 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008363 status = PSA_ERROR_BAD_STATE;
8364 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008365 }
8366
Przemek Stekiel51eac532022-12-07 11:04:51 +01008367 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008368 status = PSA_ERROR_INVALID_ARGUMENT;
8369 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008370 }
8371
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008372 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008373 status = PSA_ERROR_BAD_STATE;
8374 goto exit;
8375 }
8376
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008377 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8378 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008379 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8380 goto exit;
8381 }
8382
David Horstmann4f534ae2024-01-22 17:35:59 +00008383 LOCAL_INPUT_ALLOC(user_id_external, user_id_len, user_id);
8384
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008385 memcpy(operation->data.inputs.user, user_id, user_id_len);
8386 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008387
David Horstmann4f534ae2024-01-22 17:35:59 +00008388 status = PSA_SUCCESS;
8389
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008390exit:
David Horstmann4f534ae2024-01-22 17:35:59 +00008391 LOCAL_INPUT_FREE(user_id_external, user_id);
8392 if (status != PSA_SUCCESS) {
8393 psa_pake_abort(operation);
8394 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008395 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008396}
8397
8398psa_status_t psa_pake_set_peer(
8399 psa_pake_operation_t *operation,
David Horstmann4f534ae2024-01-22 17:35:59 +00008400 const uint8_t *peer_id_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008401 size_t peer_id_len)
8402{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008403 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
David Horstmann4f534ae2024-01-22 17:35:59 +00008404 LOCAL_INPUT_DECLARE(peer_id_external, peer_id);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008405
8406 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008407 status = PSA_ERROR_BAD_STATE;
8408 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008409 }
8410
Przemek Stekiel51eac532022-12-07 11:04:51 +01008411 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008412 status = PSA_ERROR_INVALID_ARGUMENT;
8413 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008414 }
8415
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008416 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008417 status = PSA_ERROR_BAD_STATE;
8418 goto exit;
8419 }
8420
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008421 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8422 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008423 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8424 goto exit;
8425 }
8426
David Horstmann4f534ae2024-01-22 17:35:59 +00008427 LOCAL_INPUT_ALLOC(peer_id_external, peer_id_len, peer_id);
8428
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008429 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8430 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008431
David Horstmann4f534ae2024-01-22 17:35:59 +00008432 status = PSA_SUCCESS;
8433
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008434exit:
David Horstmann4f534ae2024-01-22 17:35:59 +00008435 LOCAL_INPUT_FREE(peer_id_external, peer_id);
8436 if (status != PSA_SUCCESS) {
8437 psa_pake_abort(operation);
8438 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008439 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008440}
8441
8442psa_status_t psa_pake_set_role(
8443 psa_pake_operation_t *operation,
8444 psa_pake_role_t role)
8445{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008446 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008447
Przemek Stekiel51eac532022-12-07 11:04:51 +01008448 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008449 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008450 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008451 }
8452
Przemek Stekiel09104b82023-03-06 14:11:51 +01008453 switch (operation->alg) {
8454#if defined(PSA_WANT_ALG_JPAKE)
8455 case PSA_ALG_JPAKE:
8456 if (role == PSA_PAKE_ROLE_NONE) {
8457 return PSA_SUCCESS;
8458 }
8459 status = PSA_ERROR_INVALID_ARGUMENT;
8460 break;
8461#endif
8462 default:
8463 (void) role;
8464 status = PSA_ERROR_NOT_SUPPORTED;
8465 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008466 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008467exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008468 psa_pake_abort(operation);
8469 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008470}
8471
David Horstmanne7f21e62023-05-12 18:17:21 +01008472/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008473#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008474static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008475 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008476{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008477 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008478 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008479 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008480
David Horstmann024e5c52023-06-14 15:48:21 +01008481 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008482 is_x1 = (stage->outputs < 1);
8483 } else {
8484 is_x1 = (stage->inputs < 1);
8485 }
8486
David Horstmann74a3d8c2023-06-14 18:28:19 +01008487 key_share_step = is_x1 ?
8488 PSA_JPAKE_X1_STEP_KEY_SHARE :
8489 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008490 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008491 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8492 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8493 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8494 } else {
8495 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008496 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008497 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008498}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008499#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008500
Przemek Stekiel2797d372022-12-22 11:19:22 +01008501static psa_status_t psa_pake_complete_inputs(
8502 psa_pake_operation_t *operation)
8503{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008504 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008505 /* Create copy of the inputs on stack as inputs share memory
8506 with the driver context which will be setup by the driver. */
8507 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008508
Przemek Stekielfde11282023-03-13 16:06:09 +01008509 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008510 return PSA_ERROR_BAD_STATE;
8511 }
8512
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008513 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008514 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8515 return PSA_ERROR_BAD_STATE;
8516 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008517 }
8518
Przemek Stekiel18620a32023-01-17 16:34:52 +01008519 /* Clear driver context */
8520 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8521
8522 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008523
8524 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008525 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008526
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008527 /* User and peer are translated to role. */
8528 mbedtls_free(inputs.user);
8529 mbedtls_free(inputs.peer);
8530
Przemek Stekiel2797d372022-12-22 11:19:22 +01008531 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008532#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008533 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008534 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008535 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008536#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008537 {
8538 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008539 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008540 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008541 return status;
8542}
8543
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008544#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008545static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008546 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008547 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008548 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008549{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008550 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8551 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8552 step != PSA_PAKE_STEP_ZK_PROOF) {
8553 return PSA_ERROR_INVALID_ARGUMENT;
8554 }
8555
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008556 psa_jpake_computation_stage_t *computation_stage =
8557 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008558
David Horstmann5da95602023-06-08 15:37:12 +01008559 if (computation_stage->round != PSA_JPAKE_FIRST &&
8560 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008561 return PSA_ERROR_BAD_STATE;
8562 }
8563
David Horstmanne7f21e62023-05-12 18:17:21 +01008564 /* Check that the step we are given is the one we were expecting */
8565 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008566 return PSA_ERROR_BAD_STATE;
8567 }
8568
David Horstmanne7f21e62023-05-12 18:17:21 +01008569 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8570 computation_stage->inputs == 0 &&
8571 computation_stage->outputs == 0) {
8572 /* Start of the round, so function decides whether we are inputting
8573 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008574 computation_stage->io_mode = io_mode;
8575 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008576 /* Middle of the round so the mode we are in must match the function
8577 * called by the user */
8578 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008579 }
8580
8581 return PSA_SUCCESS;
8582}
8583
David Horstmanne7f21e62023-05-12 18:17:21 +01008584static psa_status_t psa_jpake_epilogue(
8585 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008586 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008587{
David Horstmanne7f21e62023-05-12 18:17:21 +01008588 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008589 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008590
David Horstmanne7f21e62023-05-12 18:17:21 +01008591 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8592 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008593 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008594 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008595 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008596 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008597 }
8598 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008599 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008600 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008601 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008602 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008603 }
8604 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008605 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8606 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008607 /* End of a round, move to the next round */
8608 stage->inputs = 0;
8609 stage->outputs = 0;
8610 stage->round++;
8611 }
8612 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008613 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008614 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008615 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008616 return PSA_SUCCESS;
8617}
David Horstmanne7f21e62023-05-12 18:17:21 +01008618
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008619#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008620
Neil Armstronga7d08c32022-06-01 18:21:20 +02008621psa_status_t psa_pake_output(
8622 psa_pake_operation_t *operation,
8623 psa_pake_step_t step,
David Horstmannc75639d2024-01-22 17:56:39 +00008624 uint8_t *output_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008625 size_t output_size,
8626 size_t *output_length)
8627{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008628 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008629 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
David Horstmannc75639d2024-01-22 17:56:39 +00008630 LOCAL_OUTPUT_DECLARE(output_external, output);
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008631 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008632
8633 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008634 status = psa_pake_complete_inputs(operation);
8635 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008636 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008637 }
8638 }
8639
8640 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008641 status = PSA_ERROR_BAD_STATE;
8642 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008643 }
8644
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008645 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008646 status = PSA_ERROR_INVALID_ARGUMENT;
8647 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008648 }
8649
Przemek Stekiele12ed362022-12-21 12:54:46 +01008650 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008651#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008652 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008653 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008654 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008655 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008656 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008657 driver_step = convert_jpake_computation_stage_to_driver_step(
8658 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008659 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008660#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008661 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008662 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008663 status = PSA_ERROR_NOT_SUPPORTED;
8664 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008665 }
8666
David Horstmannc75639d2024-01-22 17:56:39 +00008667 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
8668
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008669 status = psa_driver_wrapper_pake_output(operation, driver_step,
8670 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008671
8672 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008673 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008674 }
8675
8676 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008677#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008678 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008679 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008680 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008681 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008682 }
8683 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008684#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008685 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008686 status = PSA_ERROR_NOT_SUPPORTED;
8687 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008688 }
8689
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008690exit:
David Horstmannc75639d2024-01-22 17:56:39 +00008691 LOCAL_OUTPUT_FREE(output_external, output);
8692 if (status != PSA_SUCCESS) {
8693 psa_pake_abort(operation);
8694 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008695 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008696}
8697
8698psa_status_t psa_pake_input(
8699 psa_pake_operation_t *operation,
8700 psa_pake_step_t step,
David Horstmannc75639d2024-01-22 17:56:39 +00008701 const uint8_t *input_external,
Neil Armstronga7d08c32022-06-01 18:21:20 +02008702 size_t input_length)
8703{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008704 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008705 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008706 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8707 operation->primitive,
8708 step);
David Horstmannc75639d2024-01-22 17:56:39 +00008709 LOCAL_INPUT_DECLARE(input_external, input);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008710
8711 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008712 status = psa_pake_complete_inputs(operation);
8713 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008714 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008715 }
8716 }
8717
8718 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008719 status = PSA_ERROR_BAD_STATE;
8720 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008721 }
8722
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008723 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008724 status = PSA_ERROR_INVALID_ARGUMENT;
8725 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008726 }
8727
Przemek Stekiele12ed362022-12-21 12:54:46 +01008728 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008729#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008730 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008731 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008732 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008733 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008734 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008735 driver_step = convert_jpake_computation_stage_to_driver_step(
8736 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008737 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008738#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008739 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008740 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008741 status = PSA_ERROR_NOT_SUPPORTED;
8742 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008743 }
8744
David Horstmannc75639d2024-01-22 17:56:39 +00008745 LOCAL_INPUT_ALLOC(input_external, input_length, input);
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008746 status = psa_driver_wrapper_pake_input(operation, driver_step,
8747 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008748
8749 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008750 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008751 }
8752
8753 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008754#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008755 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008756 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008757 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008758 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008759 }
8760 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008761#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008762 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008763 status = PSA_ERROR_NOT_SUPPORTED;
8764 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008765 }
8766
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008767exit:
David Horstmannc75639d2024-01-22 17:56:39 +00008768 LOCAL_INPUT_FREE(input_external, input);
8769 if (status != PSA_SUCCESS) {
8770 psa_pake_abort(operation);
8771 }
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008772 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008773}
8774
8775psa_status_t psa_pake_get_implicit_key(
8776 psa_pake_operation_t *operation,
8777 psa_key_derivation_operation_t *output)
8778{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008779 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008780 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008781 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008782 size_t shared_key_len = 0;
8783
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008784 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008785 status = PSA_ERROR_BAD_STATE;
8786 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008787 }
8788
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008789#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008790 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008791 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008792 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008793 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008794 status = PSA_ERROR_BAD_STATE;
8795 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008796 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008797 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008798#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008799 {
8800 status = PSA_ERROR_NOT_SUPPORTED;
8801 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008802 }
8803
Przemek Stekiel0c781802022-11-29 14:53:13 +01008804 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8805 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008806 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008807 &shared_key_len);
8808
8809 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008810 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008811 }
8812
8813 status = psa_key_derivation_input_bytes(output,
8814 PSA_KEY_DERIVATION_INPUT_SECRET,
8815 shared_key,
8816 shared_key_len);
8817
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008818 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008819exit:
8820 abort_status = psa_pake_abort(operation);
8821 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008822}
8823
8824psa_status_t psa_pake_abort(
8825 psa_pake_operation_t *operation)
8826{
Przemek Stekield69dca92023-01-31 19:59:20 +01008827 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008828
Przemek Stekield69dca92023-01-31 19:59:20 +01008829 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008830 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008831 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008832
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008833 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8834 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008835 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008836 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008837 }
8838 if (operation->data.inputs.user != NULL) {
8839 mbedtls_free(operation->data.inputs.user);
8840 }
8841 if (operation->data.inputs.peer != NULL) {
8842 mbedtls_free(operation->data.inputs.peer);
8843 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008844 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008845 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008846
Przemek Stekield69dca92023-01-31 19:59:20 +01008847 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008848}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008849#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008850
David Horstmann00d7a042023-12-07 18:39:17 +00008851/* Memory copying test hooks. These are called before input copy, after input
8852 * copy, before output copy and after output copy, respectively.
8853 * They are used by memory-poisoning tests to temporarily unpoison buffers
8854 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00008855#if defined(MBEDTLS_TEST_HOOKS)
8856void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8857void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8858void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8859void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8860#endif
David Horstmannfde97392023-10-30 20:29:43 +00008861
David Horstmann1b7279a2023-11-15 15:18:30 +00008862/** Copy from an input buffer to a local copy.
8863 *
8864 * \param[in] input Pointer to input buffer.
8865 * \param[in] input_len Length of the input buffer.
8866 * \param[out] input_copy Pointer to a local copy in which to store the input data.
8867 * \param[out] input_copy_len Length of the local copy buffer.
8868 * \return #PSA_SUCCESS, if the buffer was successfully
8869 * copied.
8870 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
8871 * copy is too small to hold contents of the
8872 * input buffer.
8873 */
8874MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00008875psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
8876 uint8_t *input_copy, size_t input_copy_len)
8877{
8878 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00008879 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00008880 }
8881
David Horstmann372b8bb2023-11-24 16:21:04 +00008882#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008883 if (psa_input_pre_copy_hook != NULL) {
8884 psa_input_pre_copy_hook(input, input_len);
8885 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008886#endif
8887
David Horstmann777e7412023-11-15 17:33:47 +00008888 if (input_len > 0) {
8889 memcpy(input_copy, input, input_len);
8890 }
David Horstmannfde97392023-10-30 20:29:43 +00008891
David Horstmann372b8bb2023-11-24 16:21:04 +00008892#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008893 if (psa_input_post_copy_hook != NULL) {
8894 psa_input_post_copy_hook(input, input_len);
8895 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008896#endif
8897
David Horstmannfde97392023-10-30 20:29:43 +00008898 return PSA_SUCCESS;
8899}
8900
David Horstmann1b7279a2023-11-15 15:18:30 +00008901/** Copy from a local output buffer into a user-supplied one.
8902 *
8903 * \param[in] output_copy Pointer to a local buffer containing the output.
8904 * \param[in] output_copy_len Length of the local buffer.
8905 * \param[out] output Pointer to user-supplied output buffer.
8906 * \param[out] output_len Length of the user-supplied output buffer.
8907 * \return #PSA_SUCCESS, if the buffer was successfully
8908 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00008909 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00008910 * user-supplied output buffer is too small to
8911 * hold the contents of the local buffer.
8912 */
8913MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00008914psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
8915 uint8_t *output, size_t output_len)
8916{
8917 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00008918 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00008919 }
David Horstmann777e7412023-11-15 17:33:47 +00008920
David Horstmann372b8bb2023-11-24 16:21:04 +00008921#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008922 if (psa_output_pre_copy_hook != NULL) {
8923 psa_output_pre_copy_hook(output, output_len);
8924 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008925#endif
8926
David Horstmann777e7412023-11-15 17:33:47 +00008927 if (output_copy_len > 0) {
8928 memcpy(output, output_copy, output_copy_len);
8929 }
8930
David Horstmann372b8bb2023-11-24 16:21:04 +00008931#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008932 if (psa_output_post_copy_hook != NULL) {
8933 psa_output_post_copy_hook(output, output_len);
8934 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008935#endif
8936
David Horstmann8978f5c2023-10-30 20:37:12 +00008937 return PSA_SUCCESS;
8938}
8939
David Horstmannf1734052023-11-20 17:15:32 +00008940psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
8941 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00008942{
8943 psa_status_t status;
8944
David Horstmann9db14482023-11-23 15:50:37 +00008945 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00008946
David Horstmannc5cc1c32023-11-15 18:11:26 +00008947 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00008948 return PSA_SUCCESS;
8949 }
8950
David Horstmannf1734052023-11-20 17:15:32 +00008951 local_input->buffer = mbedtls_calloc(input_len, 1);
8952 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00008953 /* Since we dealt with the zero-length case above, we know that
8954 * a NULL return value means a failure of allocation. */
8955 return PSA_ERROR_INSUFFICIENT_MEMORY;
8956 }
David Horstmannf1734052023-11-20 17:15:32 +00008957 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00008958
David Horstmannf1734052023-11-20 17:15:32 +00008959 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00008960
8961 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00008962 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00008963 if (status != PSA_SUCCESS) {
8964 goto error;
8965 }
8966
8967 return PSA_SUCCESS;
8968
8969error:
David Horstmannf1734052023-11-20 17:15:32 +00008970 mbedtls_free(local_input->buffer);
8971 local_input->buffer = NULL;
8972 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00008973 return status;
8974}
8975
David Horstmannf1734052023-11-20 17:15:32 +00008976void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00008977{
David Horstmannf1734052023-11-20 17:15:32 +00008978 mbedtls_free(local_input->buffer);
8979 local_input->buffer = NULL;
8980 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00008981}
8982
David Horstmann89875a42023-11-20 12:54:09 +00008983psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
8984 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00008985{
David Horstmann9db14482023-11-23 15:50:37 +00008986 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00008987
David Horstmannc5cc1c32023-11-15 18:11:26 +00008988 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008989 return PSA_SUCCESS;
8990 }
David Horstmann89875a42023-11-20 12:54:09 +00008991 local_output->buffer = mbedtls_calloc(output_len, 1);
8992 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008993 /* Since we dealt with the zero-length case above, we know that
8994 * a NULL return value means a failure of allocation. */
8995 return PSA_ERROR_INSUFFICIENT_MEMORY;
8996 }
David Horstmann89875a42023-11-20 12:54:09 +00008997 local_output->length = output_len;
8998 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00008999
9000 return PSA_SUCCESS;
9001}
9002
David Horstmann89875a42023-11-20 12:54:09 +00009003psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00009004{
David Horstmannc335a4e2023-11-15 15:57:32 +00009005 psa_status_t status;
9006
David Horstmann89875a42023-11-20 12:54:09 +00009007 if (local_output->buffer == NULL) {
9008 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00009009 return PSA_SUCCESS;
9010 }
David Horstmann89875a42023-11-20 12:54:09 +00009011 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00009012 /* We have an internal copy but nothing to copy back to. */
9013 return PSA_ERROR_CORRUPTION_DETECTED;
9014 }
9015
David Horstmann89875a42023-11-20 12:54:09 +00009016 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
9017 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00009018 if (status != PSA_SUCCESS) {
9019 return status;
9020 }
David Horstmann9467ea32023-11-08 17:44:18 +00009021
David Horstmann89875a42023-11-20 12:54:09 +00009022 mbedtls_free(local_output->buffer);
9023 local_output->buffer = NULL;
9024 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00009025
9026 return PSA_SUCCESS;
9027}
9028
Gilles Peskinee59236f2018-01-27 23:32:46 +01009029#endif /* MBEDTLS_PSA_CRYPTO_C */