blob: da70db08f8c468a406e945f325dfc9810e74be3d [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"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020073#include "md_psa.h"
Gilles Peskinea5905292018-02-07 20:59:33 +010074
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020075#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF) || \
76 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
77 defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Przemek Stekiel69c46792022-06-10 12:59:51 +020078#define BUILTIN_ALG_ANY_HKDF 1
Przemek Stekiel75fe3fb2022-06-09 14:44:55 +020079#endif
80
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +010081/****************************************************************/
82/* Global data, support functions and library management */
83/****************************************************************/
84
Gilles Peskine449bd832023-01-11 14:50:10 +010085static int key_type_is_raw_bytes(psa_key_type_t type)
Gilles Peskine48c0ea12018-06-21 14:15:31 +020086{
Gilles Peskine449bd832023-01-11 14:50:10 +010087 return PSA_KEY_TYPE_IS_UNSTRUCTURED(type);
Gilles Peskine48c0ea12018-06-21 14:15:31 +020088}
89
Gilles Peskine5a3c50e2018-12-04 12:27:09 +010090/* Values for psa_global_data_t::rng_state */
91#define RNG_NOT_INITIALIZED 0
92#define RNG_INITIALIZED 1
93#define RNG_SEEDED 2
Gilles Peskinec6b69072018-11-20 21:42:52 +010094
Gilles Peskine449bd832023-01-11 14:50:10 +010095typedef struct {
Dave Rodgman864f5942023-08-16 18:04:44 +010096 uint8_t initialized;
97 uint8_t rng_state;
98 uint8_t drivers_initialized;
Gilles Peskine2d8a1822021-11-08 22:20:03 +010099 mbedtls_psa_random_context_t rng;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100100} psa_global_data_t;
101
102static psa_global_data_t global_data;
103
Gilles Peskine5894e8e2020-12-14 14:54:06 +0100104#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
105mbedtls_psa_drbg_context_t *const mbedtls_psa_random_state =
106 &global_data.rng.drbg;
107#endif
108
itayzafrir0adf0fc2018-09-06 16:24:41 +0300109#define GUARD_MODULE_INITIALIZED \
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 if (global_data.initialized == 0) \
111 return PSA_ERROR_BAD_STATE;
itayzafrir0adf0fc2018-09-06 16:24:41 +0300112
David Horstmann513101b2023-11-29 17:24:08 +0000113#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
David Horstmann36df4b22023-12-13 15:55:25 +0000114
David Horstmann62a56d92023-12-14 18:12:47 +0000115/* Declare a local copy of an input buffer and a variable that will be used
116 * to store a pointer to the start of the buffer.
David Horstmann36df4b22023-12-13 15:55:25 +0000117 *
118 * Note: This macro must be called before any operations which may jump to
119 * the exit label, so that the local input copy object is safe to be freed.
120 *
121 * Assumptions:
122 * - input is the name of a pointer to the buffer to be copied
123 * - The name LOCAL_INPUT_COPY_OF_input is unused in the current scope
David Horstmann62a56d92023-12-14 18:12:47 +0000124 * - input_copy_name is a name that is unused in the current scope
David Horstmann36df4b22023-12-13 15:55:25 +0000125 */
David Horstmann62a56d92023-12-14 18:12:47 +0000126#define LOCAL_INPUT_DECLARE(input, input_copy_name) \
127 psa_crypto_local_input_t LOCAL_INPUT_COPY_OF_##input = PSA_CRYPTO_LOCAL_INPUT_INIT; \
128 const uint8_t *input_copy_name = NULL;
David Horstmann36df4b22023-12-13 15:55:25 +0000129
David Horstmann62a56d92023-12-14 18:12:47 +0000130/* Allocate a copy of the buffer input and set the pointer input_copy to
131 * point to the start of the copy.
David Horstmann36df4b22023-12-13 15:55:25 +0000132 *
David Horstmanne9a88ab2023-11-29 17:07:13 +0000133 * Assumptions:
134 * - psa_status_t status exists
135 * - An exit label is declared
David Horstmann36df4b22023-12-13 15:55:25 +0000136 * - input is the name of a pointer to the buffer to be copied
David Horstmann62a56d92023-12-14 18:12:47 +0000137 * - LOCAL_INPUT_DECLARE(input, input_copy) has previously been called
David Horstmanne9a88ab2023-11-29 17:07:13 +0000138 */
David Horstmann62a56d92023-12-14 18:12:47 +0000139#define LOCAL_INPUT_ALLOC(input, length, input_copy) \
David Horstmann36df4b22023-12-13 15:55:25 +0000140 status = psa_crypto_local_input_alloc(input, length, \
141 &LOCAL_INPUT_COPY_OF_##input); \
David Horstmanne9a88ab2023-11-29 17:07:13 +0000142 if (status != PSA_SUCCESS) { \
143 goto exit; \
144 } \
David Horstmann62a56d92023-12-14 18:12:47 +0000145 input_copy = LOCAL_INPUT_COPY_OF_##input.buffer;
David Horstmanne9a88ab2023-11-29 17:07:13 +0000146
David Horstmann36df4b22023-12-13 15:55:25 +0000147/* Free the local input copy allocated previously by LOCAL_INPUT_ALLOC()
148 *
David Horstmann3e72db42023-12-08 14:08:18 +0000149 * Assumptions:
David Horstmann62a56d92023-12-14 18:12:47 +0000150 * - input_copy is the name of the input copy pointer set by LOCAL_INPUT_ALLOC()
David Horstmann36df4b22023-12-13 15:55:25 +0000151 * - input is the name of the original buffer that was copied
David Horstmann3e72db42023-12-08 14:08:18 +0000152 */
David Horstmann62a56d92023-12-14 18:12:47 +0000153#define LOCAL_INPUT_FREE(input, input_copy) \
154 input_copy = NULL; \
David Horstmann36df4b22023-12-13 15:55:25 +0000155 psa_crypto_local_input_free(&LOCAL_INPUT_COPY_OF_##input);
David Horstmanne9a88ab2023-11-29 17:07:13 +0000156
David Horstmann62a56d92023-12-14 18:12:47 +0000157/* Declare a local copy of an output buffer and a variable that will be used
158 * to store a pointer to the start of the buffer.
David Horstmann36df4b22023-12-13 15:55:25 +0000159 *
160 * Note: This macro must be called before any operations which may jump to
161 * the exit label, so that the local output copy object is safe to be freed.
162 *
163 * Assumptions:
164 * - output is the name of a pointer to the buffer to be copied
165 * - The name LOCAL_OUTPUT_COPY_OF_output is unused in the current scope
David Horstmann62a56d92023-12-14 18:12:47 +0000166 * - output_copy_name is a name that is unused in the current scope
David Horstmann36df4b22023-12-13 15:55:25 +0000167 */
David Horstmann62a56d92023-12-14 18:12:47 +0000168#define LOCAL_OUTPUT_DECLARE(output, output_copy_name) \
169 psa_crypto_local_output_t LOCAL_OUTPUT_COPY_OF_##output = PSA_CRYPTO_LOCAL_OUTPUT_INIT; \
170 uint8_t *output_copy_name = NULL;
David Horstmann36df4b22023-12-13 15:55:25 +0000171
David Horstmann62a56d92023-12-14 18:12:47 +0000172/* Allocate a copy of the buffer output and set the pointer output_copy to
173 * point to the start of the copy.
David Horstmann36df4b22023-12-13 15:55:25 +0000174 *
David Horstmanne9a88ab2023-11-29 17:07:13 +0000175 * Assumptions:
176 * - psa_status_t status exists
177 * - An exit label is declared
David Horstmann36df4b22023-12-13 15:55:25 +0000178 * - output is the name of a pointer to the buffer to be copied
David Horstmann62a56d92023-12-14 18:12:47 +0000179 * - LOCAL_OUTPUT_DECLARE(output, output_copy) has previously been called
David Horstmanne9a88ab2023-11-29 17:07:13 +0000180 */
David Horstmann62a56d92023-12-14 18:12:47 +0000181#define LOCAL_OUTPUT_ALLOC(output, length, output_copy) \
David Horstmann36df4b22023-12-13 15:55:25 +0000182 status = psa_crypto_local_output_alloc(output, length, \
183 &LOCAL_OUTPUT_COPY_OF_##output); \
David Horstmanne9a88ab2023-11-29 17:07:13 +0000184 if (status != PSA_SUCCESS) { \
185 goto exit; \
186 } \
David Horstmann62a56d92023-12-14 18:12:47 +0000187 output_copy = LOCAL_OUTPUT_COPY_OF_##output.buffer;
David Horstmanne9a88ab2023-11-29 17:07:13 +0000188
Gabor Mezei1882c512024-01-24 13:07:17 +0100189/* Allocate a copy of the buffer output and set the pointer output_copy to
190 * point to the start of the copy.
191 *
192 * Assumptions:
193 * - psa_status_t status exists
194 * - An exit label is declared
195 * - output is the name of a pointer to the buffer to be copied
196 * - LOCAL_OUTPUT_DECLARE(output, output_copy) has previously been called
197 */
198#define LOCAL_OUTPUT_ALLOC_WITH_COPY(output, length, output_copy) \
199 status = psa_crypto_local_output_alloc_with_copy(output, length, \
200 &LOCAL_OUTPUT_COPY_OF_##output); \
201 if (status != PSA_SUCCESS) { \
202 goto exit; \
203 } \
204 output_copy = LOCAL_OUTPUT_COPY_OF_##output.buffer;
205
David Horstmann62a56d92023-12-14 18:12:47 +0000206/* Free the local output copy allocated previously by LOCAL_OUTPUT_ALLOC()
David Horstmann3e72db42023-12-08 14:08:18 +0000207 * after first copying back its contents to the original buffer.
David Horstmann36df4b22023-12-13 15:55:25 +0000208 *
David Horstmann3e72db42023-12-08 14:08:18 +0000209 * Assumptions:
David Horstmann3e72db42023-12-08 14:08:18 +0000210 * - psa_status_t status exists
David Horstmann62a56d92023-12-14 18:12:47 +0000211 * - output_copy is the name of the output copy pointer set by LOCAL_OUTPUT_ALLOC()
212 * - output is the name of the original buffer that was copied
David Horstmann3e72db42023-12-08 14:08:18 +0000213 */
David Horstmann62a56d92023-12-14 18:12:47 +0000214#define LOCAL_OUTPUT_FREE(output, output_copy) \
215 output_copy = NULL; \
David Horstmann5a945f52023-12-13 14:09:08 +0000216 do { \
217 psa_status_t local_output_status; \
David Horstmann36df4b22023-12-13 15:55:25 +0000218 local_output_status = psa_crypto_local_output_free(&LOCAL_OUTPUT_COPY_OF_##output); \
David Horstmann5a945f52023-12-13 14:09:08 +0000219 if (local_output_status != PSA_SUCCESS) { \
220 /* Since this error case is an internal error, it's more serious than \
221 * any existing error code and so it's fine to overwrite the existing \
222 * status. */ \
223 status = local_output_status; \
224 } \
225 } while (0)
David Horstmann513101b2023-11-29 17:24:08 +0000226#else /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
David Horstmann62a56d92023-12-14 18:12:47 +0000227#define LOCAL_INPUT_DECLARE(input, input_copy_name) \
228 const uint8_t *input_copy_name = NULL;
229#define LOCAL_INPUT_ALLOC(input, length, input_copy) \
230 input_copy = input;
231#define LOCAL_INPUT_FREE(input, input_copy) \
232 input_copy = NULL;
233#define LOCAL_OUTPUT_DECLARE(output, output_copy_name) \
234 uint8_t *output_copy_name = NULL;
235#define LOCAL_OUTPUT_ALLOC(output, length, output_copy) \
236 output_copy = output;
237#define LOCAL_OUTPUT_FREE(output, output_copy) \
238 output_copy = NULL;
David Horstmann513101b2023-11-29 17:24:08 +0000239#endif /* MBEDTLS_PSA_COPY_CALLER_BUFFERS */
David Horstmanne9a88ab2023-11-29 17:07:13 +0000240
241
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100242int psa_can_do_hash(psa_algorithm_t hash_alg)
243{
244 (void) hash_alg;
245 return global_data.drivers_initialized;
246}
Valerio Settia55f0422023-07-10 15:34:41 +0200247#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel53410502023-04-28 13:18:43 +0200248 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) || \
Valerio Settia55f0422023-07-10 15:34:41 +0200249 defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekiel134cc2e2023-05-05 10:13:37 +0200250static int psa_is_dh_key_size_valid(size_t bits)
251{
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200252 if (bits != 2048 && bits != 3072 && bits != 4096 &&
253 bits != 6144 && bits != 8192) {
254 return 0;
255 }
256
257 return 1;
258}
Valerio Settia55f0422023-07-10 15:34:41 +0200259#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT ||
Przemek Stekiel53410502023-04-28 13:18:43 +0200260 MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY ||
Valerio Settia55f0422023-07-10 15:34:41 +0200261 PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE */
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +0100262
Gilles Peskine449bd832023-01-11 14:50:10 +0100263psa_status_t mbedtls_to_psa_error(int ret)
Gilles Peskinee59236f2018-01-27 23:32:46 +0100264{
Gilles Peskinedbf68962021-01-06 20:04:23 +0100265 /* Mbed TLS error codes can combine a high-level error code and a
266 * low-level error code. The low-level error usually reflects the
267 * root cause better, so dispatch on that preferably. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100268 int low_level_ret = -(-ret & 0x007f);
269 switch (low_level_ret != 0 ? low_level_ret : ret) {
Gilles Peskinee59236f2018-01-27 23:32:46 +0100270 case 0:
Gilles Peskine449bd832023-01-11 14:50:10 +0100271 return PSA_SUCCESS;
Gilles Peskinea5905292018-02-07 20:59:33 +0100272
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100273#if defined(MBEDTLS_AES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100274 case MBEDTLS_ERR_AES_INVALID_KEY_LENGTH:
275 case MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100276 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman09a9e582023-08-31 11:05:22 +0100277 case MBEDTLS_ERR_AES_BAD_INPUT_DATA:
278 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100279#endif
280
281#if defined(MBEDTLS_ASN1_PARSE_C) || defined(MBEDTLS_ASN1_WRITE_C)
Gilles Peskine9a944802018-06-21 09:35:35 +0200282 case MBEDTLS_ERR_ASN1_OUT_OF_DATA:
283 case MBEDTLS_ERR_ASN1_UNEXPECTED_TAG:
284 case MBEDTLS_ERR_ASN1_INVALID_LENGTH:
285 case MBEDTLS_ERR_ASN1_LENGTH_MISMATCH:
286 case MBEDTLS_ERR_ASN1_INVALID_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100287 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine9a944802018-06-21 09:35:35 +0200288 case MBEDTLS_ERR_ASN1_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine9a944802018-06-21 09:35:35 +0200290 case MBEDTLS_ERR_ASN1_BUF_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100292#endif
Gilles Peskine9a944802018-06-21 09:35:35 +0200293
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100294#if defined(MBEDTLS_CAMELLIA_C)
Jaeden Amero892cd6d2019-02-11 12:21:12 +0000295 case MBEDTLS_ERR_CAMELLIA_BAD_INPUT_DATA:
Gilles Peskinea5905292018-02-07 20:59:33 +0100296 case MBEDTLS_ERR_CAMELLIA_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100297 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100298#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100299
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100300#if defined(MBEDTLS_CCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100301 case MBEDTLS_ERR_CCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100302 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100303 case MBEDTLS_ERR_CCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100304 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100305#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100306
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100307#if defined(MBEDTLS_CHACHA20_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200308 case MBEDTLS_ERR_CHACHA20_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100309 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100310#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200311
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100312#if defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine26869f22019-05-06 15:25:00 +0200313 case MBEDTLS_ERR_CHACHAPOLY_BAD_STATE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100314 return PSA_ERROR_BAD_STATE;
Gilles Peskine26869f22019-05-06 15:25:00 +0200315 case MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100316 return PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100317#endif
Gilles Peskine26869f22019-05-06 15:25:00 +0200318
Dave Rodgman509b5672023-08-16 19:26:23 +0100319#if defined(MBEDTLS_CIPHER_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100320 case MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100321 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100322 case MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100324 case MBEDTLS_ERR_CIPHER_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100325 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100326 case MBEDTLS_ERR_CIPHER_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100327 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100328 case MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100329 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100330 case MBEDTLS_ERR_CIPHER_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100331 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100332 case MBEDTLS_ERR_CIPHER_INVALID_CONTEXT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 return PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100334#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100335
Gilles Peskine449bd832023-01-11 14:50:10 +0100336#if !(defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) || \
337 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE))
Gilles Peskinebee96c82020-11-23 21:00:09 +0100338 /* Only check CTR_DRBG error codes if underlying mbedtls_xxx
339 * functions are passed a CTR_DRBG instance. */
Gilles Peskinea5905292018-02-07 20:59:33 +0100340 case MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100341 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100342 case MBEDTLS_ERR_CTR_DRBG_REQUEST_TOO_BIG:
343 case MBEDTLS_ERR_CTR_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100344 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100345 case MBEDTLS_ERR_CTR_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100346 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100347#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100348
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100349#if defined(MBEDTLS_DES_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100350 case MBEDTLS_ERR_DES_INVALID_INPUT_LENGTH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 return PSA_ERROR_NOT_SUPPORTED;
Dave Rodgman509b5672023-08-16 19:26:23 +0100352#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100353
Gilles Peskinee59236f2018-01-27 23:32:46 +0100354 case MBEDTLS_ERR_ENTROPY_NO_SOURCES_DEFINED:
355 case MBEDTLS_ERR_ENTROPY_NO_STRONG_SOURCE:
356 case MBEDTLS_ERR_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskinea5905292018-02-07 20:59:33 +0100358
Dave Rodgman4f47f3d2023-08-31 12:10:00 +0100359#if defined(MBEDTLS_GCM_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100360 case MBEDTLS_ERR_GCM_AUTH_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100361 return PSA_ERROR_INVALID_SIGNATURE;
Mateusz Starzykf28261f2021-09-30 16:39:07 +0200362 case MBEDTLS_ERR_GCM_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100363 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100364 case MBEDTLS_ERR_GCM_BAD_INPUT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100366#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100367
Gilles Peskine82e57d12020-11-13 21:31:17 +0100368#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100369 defined(MBEDTLS_PSA_HMAC_DRBG_MD_TYPE)
Gilles Peskinebee96c82020-11-23 21:00:09 +0100370 /* Only check HMAC_DRBG error codes if underlying mbedtls_xxx
371 * functions are passed a HMAC_DRBG instance. */
Gilles Peskine82e57d12020-11-13 21:31:17 +0100372 case MBEDTLS_ERR_HMAC_DRBG_ENTROPY_SOURCE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100373 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100374 case MBEDTLS_ERR_HMAC_DRBG_REQUEST_TOO_BIG:
375 case MBEDTLS_ERR_HMAC_DRBG_INPUT_TOO_BIG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100376 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100377 case MBEDTLS_ERR_HMAC_DRBG_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100378 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine82e57d12020-11-13 21:31:17 +0100379#endif
380
Dave Rodgmandea266f2023-08-31 11:52:43 +0100381#if defined(MBEDTLS_MD_LIGHT)
Gilles Peskinea5905292018-02-07 20:59:33 +0100382 case MBEDTLS_ERR_MD_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100383 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100384 case MBEDTLS_ERR_MD_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100385 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100386 case MBEDTLS_ERR_MD_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100387 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100388#if defined(MBEDTLS_FS_IO)
Gilles Peskinea5905292018-02-07 20:59:33 +0100389 case MBEDTLS_ERR_MD_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100390 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100391#endif
392#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100393
Dave Rodgman509b5672023-08-16 19:26:23 +0100394#if defined(MBEDTLS_BIGNUM_C)
395#if defined(MBEDTLS_FS_IO)
Gilles Peskinef76aa772018-10-29 19:24:33 +0100396 case MBEDTLS_ERR_MPI_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100397 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100398#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100399 case MBEDTLS_ERR_MPI_BAD_INPUT_DATA:
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_INVALID_CHARACTER:
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_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100405 case MBEDTLS_ERR_MPI_NEGATIVE_VALUE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100407 case MBEDTLS_ERR_MPI_DIVISION_BY_ZERO:
Gilles Peskine449bd832023-01-11 14:50:10 +0100408 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100409 case MBEDTLS_ERR_MPI_NOT_ACCEPTABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100410 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinef76aa772018-10-29 19:24:33 +0100411 case MBEDTLS_ERR_MPI_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100412 return PSA_ERROR_INSUFFICIENT_MEMORY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100413#endif
Gilles Peskinef76aa772018-10-29 19:24:33 +0100414
Dave Rodgman509b5672023-08-16 19:26:23 +0100415#if defined(MBEDTLS_PK_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100416 case MBEDTLS_ERR_PK_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100418 case MBEDTLS_ERR_PK_TYPE_MISMATCH:
419 case MBEDTLS_ERR_PK_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 return PSA_ERROR_INVALID_ARGUMENT;
Dave Rodgman509b5672023-08-16 19:26:23 +0100421#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) || defined(MBEDTLS_FS_IO) || \
422 defined(MBEDTLS_PSA_ITS_FILE_C)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100423 case MBEDTLS_ERR_PK_FILE_IO_ERROR:
Gilles Peskine449bd832023-01-11 14:50:10 +0100424 return PSA_ERROR_STORAGE_FAILURE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100425#endif
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100426 case MBEDTLS_ERR_PK_KEY_INVALID_VERSION:
427 case MBEDTLS_ERR_PK_KEY_INVALID_FORMAT:
Gilles Peskine449bd832023-01-11 14:50:10 +0100428 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100429 case MBEDTLS_ERR_PK_UNKNOWN_PK_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +0100430 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100431 case MBEDTLS_ERR_PK_PASSWORD_REQUIRED:
432 case MBEDTLS_ERR_PK_PASSWORD_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100433 return PSA_ERROR_NOT_PERMITTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100434 case MBEDTLS_ERR_PK_INVALID_PUBKEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100435 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100436 case MBEDTLS_ERR_PK_INVALID_ALG:
437 case MBEDTLS_ERR_PK_UNKNOWN_NAMED_CURVE:
438 case MBEDTLS_ERR_PK_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100439 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100440 case MBEDTLS_ERR_PK_SIG_LEN_MISMATCH:
Gilles Peskine449bd832023-01-11 14:50:10 +0100441 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinef9f1bdf2021-06-23 20:32:27 +0200442 case MBEDTLS_ERR_PK_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100443 return PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman509b5672023-08-16 19:26:23 +0100444#endif
Gilles Peskinea5905292018-02-07 20:59:33 +0100445
Gilles Peskineff2d2002019-05-06 15:26:23 +0200446 case MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100447 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200448 case MBEDTLS_ERR_PLATFORM_FEATURE_UNSUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100449 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineff2d2002019-05-06 15:26:23 +0200450
Dave Rodgman509b5672023-08-16 19:26:23 +0100451#if defined(MBEDTLS_RSA_C)
Gilles Peskinea5905292018-02-07 20:59:33 +0100452 case MBEDTLS_ERR_RSA_BAD_INPUT_DATA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100453 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100454 case MBEDTLS_ERR_RSA_INVALID_PADDING:
Gilles Peskine449bd832023-01-11 14:50:10 +0100455 return PSA_ERROR_INVALID_PADDING;
Gilles Peskinea5905292018-02-07 20:59:33 +0100456 case MBEDTLS_ERR_RSA_KEY_GEN_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100457 return PSA_ERROR_HARDWARE_FAILURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100458 case MBEDTLS_ERR_RSA_KEY_CHECK_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100459 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinea5905292018-02-07 20:59:33 +0100460 case MBEDTLS_ERR_RSA_PUBLIC_FAILED:
461 case MBEDTLS_ERR_RSA_PRIVATE_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100462 return PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinea5905292018-02-07 20:59:33 +0100463 case MBEDTLS_ERR_RSA_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 return PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskinea5905292018-02-07 20:59:33 +0100465 case MBEDTLS_ERR_RSA_OUTPUT_TOO_LARGE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100466 return PSA_ERROR_BUFFER_TOO_SMALL;
Gilles Peskinea5905292018-02-07 20:59:33 +0100467 case MBEDTLS_ERR_RSA_RNG_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100468 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Dave Rodgman509b5672023-08-16 19:26:23 +0100469#endif
Manuel Pégourié-Gonnard93c08472021-04-15 12:23:55 +0200470
Dave Rodgman1dab4452023-09-01 09:59:51 +0100471#if defined(MBEDTLS_ECP_LIGHT)
itayzafrir5c753392018-05-08 11:18:38 +0300472 case MBEDTLS_ERR_ECP_BAD_INPUT_DATA:
itayzafrir7b30f8b2018-05-09 16:07:36 +0300473 case MBEDTLS_ERR_ECP_INVALID_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100474 return PSA_ERROR_INVALID_ARGUMENT;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300475 case MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +0100476 return PSA_ERROR_BUFFER_TOO_SMALL;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300477 case MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE:
Gilles Peskine449bd832023-01-11 14:50:10 +0100478 return PSA_ERROR_NOT_SUPPORTED;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300479 case MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH:
480 case MBEDTLS_ERR_ECP_VERIFY_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100481 return PSA_ERROR_INVALID_SIGNATURE;
itayzafrir7b30f8b2018-05-09 16:07:36 +0300482 case MBEDTLS_ERR_ECP_ALLOC_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100483 return PSA_ERROR_INSUFFICIENT_MEMORY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100484 case MBEDTLS_ERR_ECP_RANDOM_FAILED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100485 return PSA_ERROR_INSUFFICIENT_ENTROPY;
Gilles Peskine40d81602020-11-25 00:09:47 +0100486
Dave Rodgman509b5672023-08-16 19:26:23 +0100487#if defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +0000488 case MBEDTLS_ERR_ECP_IN_PROGRESS:
489 return PSA_OPERATION_INCOMPLETE;
Dave Rodgman509b5672023-08-16 19:26:23 +0100490#endif
491#endif
Paul Elliott588f8ed2022-12-02 18:10:26 +0000492
Janos Follatha13b9052019-11-22 12:48:59 +0000493 case MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100494 return PSA_ERROR_CORRUPTION_DETECTED;
itayzafrir5c753392018-05-08 11:18:38 +0300495
Gilles Peskinee59236f2018-01-27 23:32:46 +0100496 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100497 return PSA_ERROR_GENERIC_ERROR;
Gilles Peskinee59236f2018-01-27 23:32:46 +0100498 }
499}
500
Paul Elliottdc42ca82023-02-24 18:11:59 +0000501/**
502 * \brief For output buffers which contain "tags"
503 * (outputs that may be checked for validity like
504 * hashes, MACs and signatures), fill the unused
505 * part of the output buffer (the whole buffer on
506 * error, the trailing part on success) with
507 * something that isn't a valid tag (barring an
508 * attack on the tag and deliberately-crafted
509 * input), in case the caller doesn't check the
510 * return status properly.
511 *
512 * \param output_buffer Pointer to buffer to wipe. May not be NULL
513 * unless \p output_buffer_size is zero.
514 * \param status Status of function called to generate
515 * output_buffer originally
516 * \param output_buffer_size Size of output buffer. If zero, \p output_buffer
517 * could be NULL.
518 * \param output_buffer_length Length of data written to output_buffer, must be
519 * less than \p output_buffer_size
520 */
521static void psa_wipe_tag_output_buffer(uint8_t *output_buffer, psa_status_t status,
Paul Elliott7118d172023-02-26 16:57:05 +0000522 size_t output_buffer_size, size_t output_buffer_length)
523{
Paul Elliottdc42ca82023-02-24 18:11:59 +0000524 size_t offset = 0;
525
526 if (output_buffer_size == 0) {
527 /* If output_buffer_size is 0 then we have nothing to do. We must not
528 call memset because output_buffer may be NULL in this case */
529 return;
530 }
531
532 if (status == PSA_SUCCESS) {
533 offset = output_buffer_length;
534 }
535
536 memset(output_buffer + offset, '!', output_buffer_size - offset);
537}
538
Gilles Peskineb0b255c2018-07-06 17:01:38 +0200539
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +0200540
541
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100542/****************************************************************/
543/* Key management */
544/****************************************************************/
545
Valerio Settia9aab1a2023-06-19 13:39:54 +0200546#if defined(PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200547psa_ecc_family_t mbedtls_ecc_group_to_psa(mbedtls_ecp_group_id grpid,
548 size_t *bits)
549{
550 switch (grpid) {
Valerio Settic437fae2023-09-08 14:58:03 +0200551#if defined(MBEDTLS_ECP_HAVE_SECP192R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200552 case MBEDTLS_ECP_DP_SECP192R1:
553 *bits = 192;
554 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100555#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200556#if defined(MBEDTLS_ECP_HAVE_SECP224R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200557 case MBEDTLS_ECP_DP_SECP224R1:
558 *bits = 224;
559 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100560#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200561#if defined(MBEDTLS_ECP_HAVE_SECP256R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200562 case MBEDTLS_ECP_DP_SECP256R1:
563 *bits = 256;
564 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100565#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200566#if defined(MBEDTLS_ECP_HAVE_SECP384R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200567 case MBEDTLS_ECP_DP_SECP384R1:
568 *bits = 384;
569 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100570#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200571#if defined(MBEDTLS_ECP_HAVE_SECP521R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200572 case MBEDTLS_ECP_DP_SECP521R1:
573 *bits = 521;
574 return PSA_ECC_FAMILY_SECP_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100575#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200576#if defined(MBEDTLS_ECP_HAVE_BP256R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200577 case MBEDTLS_ECP_DP_BP256R1:
578 *bits = 256;
579 return PSA_ECC_FAMILY_BRAINPOOL_P_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100580#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200581#if defined(MBEDTLS_ECP_HAVE_BP384R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200582 case MBEDTLS_ECP_DP_BP384R1:
583 *bits = 384;
584 return PSA_ECC_FAMILY_BRAINPOOL_P_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100585#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200586#if defined(MBEDTLS_ECP_HAVE_BP512R1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200587 case MBEDTLS_ECP_DP_BP512R1:
588 *bits = 512;
589 return PSA_ECC_FAMILY_BRAINPOOL_P_R1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100590#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200591#if defined(MBEDTLS_ECP_HAVE_CURVE25519)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200592 case MBEDTLS_ECP_DP_CURVE25519:
593 *bits = 255;
594 return PSA_ECC_FAMILY_MONTGOMERY;
Dave Rodgman6f682032023-08-16 18:44:32 +0100595#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200596#if defined(MBEDTLS_ECP_HAVE_SECP192K1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200597 case MBEDTLS_ECP_DP_SECP192K1:
598 *bits = 192;
599 return PSA_ECC_FAMILY_SECP_K1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100600#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200601#if defined(MBEDTLS_ECP_HAVE_SECP224K1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200602 case MBEDTLS_ECP_DP_SECP224K1:
603 *bits = 224;
604 return PSA_ECC_FAMILY_SECP_K1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100605#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200606#if defined(MBEDTLS_ECP_HAVE_SECP256K1)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200607 case MBEDTLS_ECP_DP_SECP256K1:
608 *bits = 256;
609 return PSA_ECC_FAMILY_SECP_K1;
Dave Rodgman6f682032023-08-16 18:44:32 +0100610#endif
Valerio Settic437fae2023-09-08 14:58:03 +0200611#if defined(MBEDTLS_ECP_HAVE_CURVE448)
Valerio Settibc2b1d32023-06-19 12:15:13 +0200612 case MBEDTLS_ECP_DP_CURVE448:
613 *bits = 448;
614 return PSA_ECC_FAMILY_MONTGOMERY;
Dave Rodgman6f682032023-08-16 18:44:32 +0100615#endif
Valerio Settibc2b1d32023-06-19 12:15:13 +0200616 default:
617 *bits = 0;
618 return 0;
619 }
620}
621
Gilles Peskine449bd832023-01-11 14:50:10 +0100622mbedtls_ecp_group_id mbedtls_ecc_group_of_psa(psa_ecc_family_t curve,
623 size_t bits,
624 int bits_is_sloppy)
Gilles Peskine12313cd2018-06-20 00:20:32 +0200625{
Gilles Peskine449bd832023-01-11 14:50:10 +0100626 switch (curve) {
Paul Elliott8ff510a2020-06-02 17:19:28 +0100627 case PSA_ECC_FAMILY_SECP_R1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100628 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100629#if defined(PSA_WANT_ECC_SECP_R1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100630 case 192:
Gilles Peskine449bd832023-01-11 14:50:10 +0100631 return MBEDTLS_ECP_DP_SECP192R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100632#endif
633#if defined(PSA_WANT_ECC_SECP_R1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100634 case 224:
Gilles Peskine449bd832023-01-11 14:50:10 +0100635 return MBEDTLS_ECP_DP_SECP224R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100636#endif
637#if defined(PSA_WANT_ECC_SECP_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100638 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100639 return MBEDTLS_ECP_DP_SECP256R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100640#endif
641#if defined(PSA_WANT_ECC_SECP_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100642 case 384:
Gilles Peskine449bd832023-01-11 14:50:10 +0100643 return MBEDTLS_ECP_DP_SECP384R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100644#endif
645#if defined(PSA_WANT_ECC_SECP_R1_521)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100646 case 521:
Gilles Peskine449bd832023-01-11 14:50:10 +0100647 return MBEDTLS_ECP_DP_SECP521R1;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100648 case 528:
Gilles Peskine449bd832023-01-11 14:50:10 +0100649 if (bits_is_sloppy) {
650 return MBEDTLS_ECP_DP_SECP521R1;
651 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100652 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100653#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100654 }
655 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100656
Paul Elliott8ff510a2020-06-02 17:19:28 +0100657 case PSA_ECC_FAMILY_BRAINPOOL_P_R1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100658 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100659#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100660 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100661 return MBEDTLS_ECP_DP_BP256R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100662#endif
663#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_384)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100664 case 384:
Gilles Peskine449bd832023-01-11 14:50:10 +0100665 return MBEDTLS_ECP_DP_BP384R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100666#endif
667#if defined(PSA_WANT_ECC_BRAINPOOL_P_R1_512)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100668 case 512:
Gilles Peskine449bd832023-01-11 14:50:10 +0100669 return MBEDTLS_ECP_DP_BP512R1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100670#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100671 }
672 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100673
Paul Elliott8ff510a2020-06-02 17:19:28 +0100674 case PSA_ECC_FAMILY_MONTGOMERY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100675 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100676#if defined(PSA_WANT_ECC_MONTGOMERY_255)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100677 case 255:
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 return MBEDTLS_ECP_DP_CURVE25519;
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100679 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100680 if (bits_is_sloppy) {
681 return MBEDTLS_ECP_DP_CURVE25519;
682 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100683 break;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100684#endif
685#if defined(PSA_WANT_ECC_MONTGOMERY_448)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100686 case 448:
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 return MBEDTLS_ECP_DP_CURVE448;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100688#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100689 }
690 break;
Gilles Peskine228abc52019-12-03 17:24:19 +0100691
Paul Elliott8ff510a2020-06-02 17:19:28 +0100692 case PSA_ECC_FAMILY_SECP_K1:
Gilles Peskine449bd832023-01-11 14:50:10 +0100693 switch (bits) {
Gilles Peskinea1684f42021-03-23 13:12:34 +0100694#if defined(PSA_WANT_ECC_SECP_K1_192)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100695 case 192:
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 return MBEDTLS_ECP_DP_SECP192K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100697#endif
698#if defined(PSA_WANT_ECC_SECP_K1_224)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100699 case 224:
Gilles Peskine449bd832023-01-11 14:50:10 +0100700 return MBEDTLS_ECP_DP_SECP224K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100701#endif
702#if defined(PSA_WANT_ECC_SECP_K1_256)
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100703 case 256:
Gilles Peskine449bd832023-01-11 14:50:10 +0100704 return MBEDTLS_ECP_DP_SECP256K1;
Gilles Peskinea1684f42021-03-23 13:12:34 +0100705#endif
Gilles Peskine228abc52019-12-03 17:24:19 +0100706 }
707 break;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200708 }
Gilles Peskine2fa6b5f2021-01-27 15:44:45 +0100709
Gilles Peskine71f45ba2021-03-23 14:17:55 +0100710 (void) bits_is_sloppy;
Gilles Peskine449bd832023-01-11 14:50:10 +0100711 return MBEDTLS_ECP_DP_NONE;
Gilles Peskine12313cd2018-06-20 00:20:32 +0200712}
Valerio Settia9aab1a2023-06-19 13:39:54 +0200713#endif /* PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY */
Gilles Peskine12313cd2018-06-20 00:20:32 +0200714
Gilles Peskine449bd832023-01-11 14:50:10 +0100715psa_status_t psa_validate_unstructured_key_bit_size(psa_key_type_t type,
716 size_t bits)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200717{
718 /* Check that the bit size is acceptable for the key type */
Gilles Peskine449bd832023-01-11 14:50:10 +0100719 switch (type) {
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200720 case PSA_KEY_TYPE_RAW_DATA:
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200721 case PSA_KEY_TYPE_HMAC:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200722 case PSA_KEY_TYPE_DERIVE:
Neil Armstrong4b5710f2022-05-25 11:30:27 +0200723 case PSA_KEY_TYPE_PASSWORD:
724 case PSA_KEY_TYPE_PASSWORD_HASH:
Gilles Peskineea0fb492018-07-12 17:17:20 +0200725 break;
Ronald Cron1f0db802021-03-12 09:59:30 +0100726#if defined(PSA_WANT_KEY_TYPE_AES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200727 case PSA_KEY_TYPE_AES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100728 if (bits != 128 && bits != 192 && bits != 256) {
729 return PSA_ERROR_INVALID_ARGUMENT;
730 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200731 break;
732#endif
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200733#if defined(PSA_WANT_KEY_TYPE_ARIA)
734 case PSA_KEY_TYPE_ARIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100735 if (bits != 128 && bits != 192 && bits != 256) {
736 return PSA_ERROR_INVALID_ARGUMENT;
737 }
Gilles Peskine6c12a1e2021-09-21 11:59:39 +0200738 break;
739#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100740#if defined(PSA_WANT_KEY_TYPE_CAMELLIA)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200741 case PSA_KEY_TYPE_CAMELLIA:
Gilles Peskine449bd832023-01-11 14:50:10 +0100742 if (bits != 128 && bits != 192 && bits != 256) {
743 return PSA_ERROR_INVALID_ARGUMENT;
744 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200745 break;
746#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100747#if defined(PSA_WANT_KEY_TYPE_DES)
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200748 case PSA_KEY_TYPE_DES:
Gilles Peskine449bd832023-01-11 14:50:10 +0100749 if (bits != 64 && bits != 128 && bits != 192) {
750 return PSA_ERROR_INVALID_ARGUMENT;
751 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200752 break;
753#endif
Ronald Cron1f0db802021-03-12 09:59:30 +0100754#if defined(PSA_WANT_KEY_TYPE_CHACHA20)
Gilles Peskine26869f22019-05-06 15:25:00 +0200755 case PSA_KEY_TYPE_CHACHA20:
Gilles Peskine449bd832023-01-11 14:50:10 +0100756 if (bits != 256) {
757 return PSA_ERROR_INVALID_ARGUMENT;
758 }
Gilles Peskine26869f22019-05-06 15:25:00 +0200759 break;
760#endif
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200761 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100762 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200763 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100764 if (bits % 8 != 0) {
765 return PSA_ERROR_INVALID_ARGUMENT;
766 }
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200767
Gilles Peskine449bd832023-01-11 14:50:10 +0100768 return PSA_SUCCESS;
Gilles Peskine0ff4b0f2018-06-19 21:31:50 +0200769}
770
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100771/** Check whether a given key type is valid for use with a given MAC algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100772 *
Steven Cooremancd640932021-03-08 12:00:27 +0100773 * Upon successful return of this function, the behavior of #PSA_MAC_LENGTH
774 * when called with the validated \p algorithm and \p key_type is well-defined.
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100775 *
776 * \param[in] algorithm The specific MAC algorithm (can be wildcard).
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100777 * \param[in] key_type The key type of the key to be used with the
778 * \p algorithm.
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100779 *
780 * \retval #PSA_SUCCESS
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100781 * The \p key_type is valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100782 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100783 * The \p key_type is not valid for use with the \p algorithm
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100784 */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100785MBEDTLS_STATIC_TESTABLE psa_status_t psa_mac_key_can_do(
Steven Cooreman58c94d32021-03-02 21:31:17 +0100786 psa_algorithm_t algorithm,
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 psa_key_type_t key_type)
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100788{
Gilles Peskine449bd832023-01-11 14:50:10 +0100789 if (PSA_ALG_IS_HMAC(algorithm)) {
790 if (key_type == PSA_KEY_TYPE_HMAC) {
791 return PSA_SUCCESS;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100792 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100793 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100794
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 if (PSA_ALG_IS_BLOCK_CIPHER_MAC(algorithm)) {
796 /* Check that we're calling PSA_BLOCK_CIPHER_BLOCK_LENGTH with a cipher
797 * key. */
798 if ((key_type & PSA_KEY_TYPE_CATEGORY_MASK) ==
799 PSA_KEY_TYPE_CATEGORY_SYMMETRIC) {
800 /* PSA_BLOCK_CIPHER_BLOCK_LENGTH returns 1 for stream ciphers and
801 * the block length (larger than 1) for block ciphers. */
802 if (PSA_BLOCK_CIPHER_BLOCK_LENGTH(key_type) > 1) {
803 return PSA_SUCCESS;
804 }
805 }
806 }
807
808 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +0100809}
810
Gilles Peskine449bd832023-01-11 14:50:10 +0100811psa_status_t psa_allocate_buffer_to_slot(psa_key_slot_t *slot,
812 size_t buffer_length)
Steven Cooreman75b74362020-07-28 14:30:13 +0200813{
Gilles Peskine449bd832023-01-11 14:50:10 +0100814 if (slot->key.data != NULL) {
815 return PSA_ERROR_ALREADY_EXISTS;
816 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200817
Gilles Peskine449bd832023-01-11 14:50:10 +0100818 slot->key.data = mbedtls_calloc(1, buffer_length);
819 if (slot->key.data == NULL) {
820 return PSA_ERROR_INSUFFICIENT_MEMORY;
821 }
Steven Cooreman75b74362020-07-28 14:30:13 +0200822
Ronald Cronea0f8a62020-11-25 17:52:23 +0100823 slot->key.bytes = buffer_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100824 return PSA_SUCCESS;
Steven Cooreman75b74362020-07-28 14:30:13 +0200825}
826
Gilles Peskine449bd832023-01-11 14:50:10 +0100827psa_status_t psa_copy_key_material_into_slot(psa_key_slot_t *slot,
828 const uint8_t *data,
829 size_t data_length)
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200830{
Gilles Peskine449bd832023-01-11 14:50:10 +0100831 psa_status_t status = psa_allocate_buffer_to_slot(slot,
832 data_length);
833 if (status != PSA_SUCCESS) {
834 return status;
835 }
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200836
Gilles Peskine449bd832023-01-11 14:50:10 +0100837 memcpy(slot->key.data, data, data_length);
838 return PSA_SUCCESS;
Steven Cooremanf7cebd42020-10-13 20:27:40 +0200839}
840
Ronald Crona0fe59f2020-11-29 11:14:53 +0100841psa_status_t psa_import_key_into_slot(
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100842 const psa_key_attributes_t *attributes,
843 const uint8_t *data, size_t data_length,
844 uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +0100845 size_t *key_buffer_length, size_t *bits)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100846{
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100847 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
848 psa_key_type_t type = attributes->core.type;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +0100849
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200850 /* zero-length keys are never supported. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100851 if (data_length == 0) {
852 return PSA_ERROR_NOT_SUPPORTED;
853 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200854
Gilles Peskine449bd832023-01-11 14:50:10 +0100855 if (key_type_is_raw_bytes(type)) {
856 *bits = PSA_BYTES_TO_BITS(data_length);
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200857
Gilles Peskine449bd832023-01-11 14:50:10 +0100858 status = psa_validate_unstructured_key_bit_size(attributes->core.type,
859 *bits);
860 if (status != PSA_SUCCESS) {
861 return status;
862 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200863
Ronald Crondd04d422020-11-28 15:14:42 +0100864 /* Copy the key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100865 memcpy(key_buffer, data, data_length);
Ronald Crondd04d422020-11-28 15:14:42 +0100866 *key_buffer_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +0100867 (void) key_buffer_size;
Steven Cooreman81be2fa2020-07-24 22:04:59 +0200868
Gilles Peskine449bd832023-01-11 14:50:10 +0100869 return PSA_SUCCESS;
870 } else if (PSA_KEY_TYPE_IS_ASYMMETRIC(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +0200871#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200872 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100873 if (PSA_KEY_TYPE_IS_DH(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +0200874 if (psa_is_dh_key_size_valid(PSA_BYTES_TO_BITS(data_length)) == 0) {
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100875 return PSA_ERROR_INVALID_ARGUMENT;
876 }
Przemek Stekiel33c91eb2023-05-30 15:16:35 +0200877 return mbedtls_psa_ffdh_import_key(attributes,
878 data, data_length,
879 key_buffer, key_buffer_size,
880 key_buffer_length,
881 bits);
Przemek Stekiel472b3f32022-12-01 14:38:49 +0100882 }
Valerio Settia55f0422023-07-10 15:34:41 +0200883#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_IMPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +0200884 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Valerio Setti27c501a2023-06-27 16:58:52 +0200885#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100886 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
887 if (PSA_KEY_TYPE_IS_ECC(type)) {
888 return mbedtls_psa_ecp_import_key(attributes,
889 data, data_length,
890 key_buffer, key_buffer_size,
891 key_buffer_length,
892 bits);
Steven Cooreman40120f62020-10-29 11:42:22 +0100893 }
Valerio Setti27c501a2023-06-27 16:58:52 +0200894#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_IMPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -0800895 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Valerio Settife478902023-07-25 12:27:19 +0200896#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
897 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +0100898 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
899 if (PSA_KEY_TYPE_IS_RSA(type)) {
900 return mbedtls_psa_rsa_import_key(attributes,
901 data, data_length,
902 key_buffer, key_buffer_size,
903 key_buffer_length,
904 bits);
Steven Cooreman3ea0ce42020-10-23 11:37:05 +0200905 }
Valerio Settife478902023-07-25 12:27:19 +0200906#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
907 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -0800908 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Ronald Cron2ebfdcc2020-11-28 15:54:54 +0100909 }
Steven Cooreman40120f62020-10-29 11:42:22 +0100910
Gilles Peskine449bd832023-01-11 14:50:10 +0100911 return PSA_ERROR_NOT_SUPPORTED;
Darryl Green06fd18d2018-07-16 11:21:11 +0100912}
913
Gilles Peskinef603c712019-01-19 13:40:11 +0100914/** Calculate the intersection of two algorithm usage policies.
915 *
916 * Return 0 (which allows no operation) on incompatibility.
917 */
918static psa_algorithm_t psa_key_policy_algorithm_intersection(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100919 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +0100920 psa_algorithm_t alg1,
Gilles Peskine449bd832023-01-11 14:50:10 +0100921 psa_algorithm_t alg2)
Gilles Peskinef603c712019-01-19 13:40:11 +0100922{
Gilles Peskine549ea862019-05-22 11:45:59 +0200923 /* Common case: both sides actually specify the same policy. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100924 if (alg1 == alg2) {
925 return alg1;
926 }
Steven Cooreman03488022021-02-18 12:07:20 +0100927 /* If the policies are from the same hash-and-sign family, check
928 * if one is a wildcard. If so the other has the specific algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100929 if (PSA_ALG_IS_SIGN_HASH(alg1) &&
930 PSA_ALG_IS_SIGN_HASH(alg2) &&
931 (alg1 & ~PSA_ALG_HASH_MASK) == (alg2 & ~PSA_ALG_HASH_MASK)) {
932 if (PSA_ALG_SIGN_GET_HASH(alg1) == PSA_ALG_ANY_HASH) {
933 return alg2;
934 }
935 if (PSA_ALG_SIGN_GET_HASH(alg2) == PSA_ALG_ANY_HASH) {
936 return alg1;
937 }
Steven Cooreman03488022021-02-18 12:07:20 +0100938 }
939 /* If the policies are from the same AEAD family, check whether
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100940 * one of them is a minimum-tag-length wildcard. Calculate the most
Steven Cooreman03488022021-02-18 12:07:20 +0100941 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100942 if (PSA_ALG_IS_AEAD(alg1) && PSA_ALG_IS_AEAD(alg2) &&
943 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg1, 0) ==
944 PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg2, 0))) {
945 size_t alg1_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg1);
946 size_t alg2_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100947 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100948
Steven Cooreman7de9e2d2021-02-22 17:05:56 +0100949 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100950 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
951 ((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
952 return PSA_ALG_AEAD_WITH_AT_LEAST_THIS_LENGTH_TAG(
953 alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100954 }
955 /* If only one is a wildcard, return specific algorithm if compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 if (((alg1 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
957 (alg1_len <= alg2_len)) {
958 return alg2;
Steven Cooreman03488022021-02-18 12:07:20 +0100959 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100960 if (((alg2 & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
961 (alg2_len <= alg1_len)) {
962 return alg1;
Steven Cooreman03488022021-02-18 12:07:20 +0100963 }
964 }
965 /* If the policies are from the same MAC family, check whether one
966 * of them is a minimum-MAC-length policy. Calculate the most
967 * restrictive tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100968 if (PSA_ALG_IS_MAC(alg1) && PSA_ALG_IS_MAC(alg2) &&
969 (PSA_ALG_FULL_LENGTH_MAC(alg1) ==
970 PSA_ALG_FULL_LENGTH_MAC(alg2))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100971 /* Validate the combination of key type and algorithm. Since the base
972 * algorithm of alg1 and alg2 are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100973 if (PSA_SUCCESS != psa_mac_key_can_do(alg1, key_type)) {
974 return 0;
975 }
Steven Cooreman1ac5ce32021-03-02 16:34:49 +0100976
Steven Cooreman31a876d2021-03-03 20:47:40 +0100977 /* Get the (exact or at-least) output lengths for both sides of the
978 * requested intersection. None of the currently supported algorithms
979 * have an output length dependent on the actual key size, so setting it
980 * to a bogus value of 0 is currently OK.
981 *
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +0100982 * Note that for at-least-this-length wildcard algorithms, the output
983 * length is set to the shortest allowed length, which allows us to
984 * calculate the most restrictive tag length for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100985 size_t alg1_len = PSA_MAC_LENGTH(key_type, 0, alg1);
986 size_t alg2_len = PSA_MAC_LENGTH(key_type, 0, alg2);
Steven Cooremancd640932021-03-08 12:00:27 +0100987 size_t restricted_len = alg1_len > alg2_len ? alg1_len : alg2_len;
Steven Cooremanb3ce8152021-02-18 12:03:50 +0100988
Steven Cooremana1d83222021-02-25 10:20:29 +0100989 /* If both are wildcards, return most restrictive wildcard */
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 if (((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) &&
991 ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
992 return PSA_ALG_AT_LEAST_THIS_LENGTH_MAC(alg1, restricted_len);
Steven Cooreman03488022021-02-18 12:07:20 +0100993 }
Steven Cooreman31a876d2021-03-03 20:47:40 +0100994
995 /* If only one is an at-least-this-length policy, the intersection would
996 * be the other (fixed-length) policy as long as said fixed length is
997 * equal to or larger than the shortest allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 if ((alg1 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
999 return (alg1_len <= alg2_len) ? alg2 : 0;
Steven Cooreman03488022021-02-18 12:07:20 +01001000 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001001 if ((alg2 & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
1002 return (alg2_len <= alg1_len) ? alg1 : 0;
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001003 }
Steven Cooreman31a876d2021-03-03 20:47:40 +01001004
Steven Cooremancd640932021-03-08 12:00:27 +01001005 /* If none of them are wildcards, check whether they define the same tag
1006 * length. This is still possible here when one is default-length and
1007 * the other specific-length. Ensure to always return the
1008 * specific-length version for the intersection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001009 if (alg1_len == alg2_len) {
1010 return PSA_ALG_TRUNCATED_MAC(alg1, alg1_len);
1011 }
Gilles Peskinef603c712019-01-19 13:40:11 +01001012 }
1013 /* If the policies are incompatible, allow nothing. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001014 return 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01001015}
1016
Gilles Peskine449bd832023-01-11 14:50:10 +01001017static int psa_key_algorithm_permits(psa_key_type_t key_type,
1018 psa_algorithm_t policy_alg,
1019 psa_algorithm_t requested_alg)
Gilles Peskined6f371b2019-05-10 19:33:38 +02001020{
Gilles Peskine549ea862019-05-22 11:45:59 +02001021 /* Common case: the policy only allows requested_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001022 if (requested_alg == policy_alg) {
1023 return 1;
1024 }
Steven Cooreman03488022021-02-18 12:07:20 +01001025 /* If policy_alg is a hash-and-sign with a wildcard for the hash,
1026 * and requested_alg is the same hash-and-sign family with any hash,
1027 * then requested_alg is compliant with policy_alg. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 if (PSA_ALG_IS_SIGN_HASH(requested_alg) &&
1029 PSA_ALG_SIGN_GET_HASH(policy_alg) == PSA_ALG_ANY_HASH) {
1030 return (policy_alg & ~PSA_ALG_HASH_MASK) ==
1031 (requested_alg & ~PSA_ALG_HASH_MASK);
Steven Cooreman03488022021-02-18 12:07:20 +01001032 }
1033 /* If policy_alg is a wildcard AEAD algorithm of the same base as
1034 * the requested algorithm, check the requested tag length to be
1035 * equal-length or longer than the wildcard-specified length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001036 if (PSA_ALG_IS_AEAD(policy_alg) &&
1037 PSA_ALG_IS_AEAD(requested_alg) &&
1038 (PSA_ALG_AEAD_WITH_SHORTENED_TAG(policy_alg, 0) ==
1039 PSA_ALG_AEAD_WITH_SHORTENED_TAG(requested_alg, 0)) &&
1040 ((policy_alg & PSA_ALG_AEAD_AT_LEAST_THIS_LENGTH_FLAG) != 0)) {
1041 return PSA_ALG_AEAD_GET_TAG_LENGTH(policy_alg) <=
1042 PSA_ALG_AEAD_GET_TAG_LENGTH(requested_alg);
Steven Cooreman03488022021-02-18 12:07:20 +01001043 }
Steven Cooremancd640932021-03-08 12:00:27 +01001044 /* If policy_alg is a MAC algorithm of the same base as the requested
1045 * algorithm, check whether their MAC lengths are compatible. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001046 if (PSA_ALG_IS_MAC(policy_alg) &&
1047 PSA_ALG_IS_MAC(requested_alg) &&
1048 (PSA_ALG_FULL_LENGTH_MAC(policy_alg) ==
1049 PSA_ALG_FULL_LENGTH_MAC(requested_alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01001050 /* Validate the combination of key type and algorithm. Since the policy
1051 * and requested algorithms are the same, we only need this once. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001052 if (PSA_SUCCESS != psa_mac_key_can_do(policy_alg, key_type)) {
1053 return 0;
1054 }
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01001055
Steven Cooreman31a876d2021-03-03 20:47:40 +01001056 /* Get both the requested output length for the algorithm which is to be
1057 * verified, and the default output length for the base algorithm.
1058 * Note that none of the currently supported algorithms have an output
1059 * length dependent on actual key size, so setting it to a bogus value
1060 * of 0 is currently OK. */
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01001061 size_t requested_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +01001062 key_type, 0, requested_alg);
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01001063 size_t default_output_length = PSA_MAC_LENGTH(
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 key_type, 0,
1065 PSA_ALG_FULL_LENGTH_MAC(requested_alg));
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001066
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001067 /* If the policy is default-length, only allow an algorithm with
1068 * a declared exact-length matching the default. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001069 if (PSA_MAC_TRUNCATED_LENGTH(policy_alg) == 0) {
1070 return requested_output_length == default_output_length;
1071 }
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001072
1073 /* If the requested algorithm is default-length, allow it if the policy
Steven Cooremancd640932021-03-08 12:00:27 +01001074 * length exactly matches the default length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 if (PSA_MAC_TRUNCATED_LENGTH(requested_alg) == 0 &&
1076 PSA_MAC_TRUNCATED_LENGTH(policy_alg) == default_output_length) {
1077 return 1;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001078 }
1079
Steven Cooremancd640932021-03-08 12:00:27 +01001080 /* If policy_alg is an at-least-this-length wildcard MAC algorithm,
1081 * check for the requested MAC length to be equal to or longer than the
1082 * minimum allowed length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001083 if ((policy_alg & PSA_ALG_MAC_AT_LEAST_THIS_LENGTH_FLAG) != 0) {
1084 return PSA_MAC_TRUNCATED_LENGTH(policy_alg) <=
1085 requested_output_length;
Steven Cooreman5ad4bf72021-03-02 15:11:57 +01001086 }
Gilles Peskined6f371b2019-05-10 19:33:38 +02001087 }
Steven Cooremance48e852020-10-05 16:02:45 +02001088 /* If policy_alg is a generic key agreement operation, then using it for
Steven Cooremanfa5e6312020-10-15 17:07:12 +02001089 * a key derivation with that key agreement should also be allowed. This
1090 * behaviour is expected to be defined in a future specification version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(policy_alg) &&
1092 PSA_ALG_IS_KEY_AGREEMENT(requested_alg)) {
1093 return PSA_ALG_KEY_AGREEMENT_GET_BASE(requested_alg) ==
1094 policy_alg;
Steven Cooremance48e852020-10-05 16:02:45 +02001095 }
Steven Cooremanb3ce8152021-02-18 12:03:50 +01001096 /* If it isn't explicitly permitted, it's forbidden. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 return 0;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001098}
1099
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001100/** Test whether a policy permits an algorithm.
1101 *
1102 * The caller must test usage flags separately.
Steven Cooreman7e39f052021-02-23 14:18:32 +01001103 *
Steven Cooreman5a172672021-03-02 21:27:42 +01001104 * \note This function requires providing the key type for which the policy is
1105 * being validated, since some algorithm policy definitions (e.g. MAC)
1106 * have different properties depending on what kind of cipher it is
1107 * combined with.
1108 *
Steven Cooreman7e39f052021-02-23 14:18:32 +01001109 * \retval PSA_SUCCESS When \p alg is a specific algorithm
1110 * allowed by the \p policy.
1111 * \retval PSA_ERROR_INVALID_ARGUMENT When \p alg is not a specific algorithm
1112 * \retval PSA_ERROR_NOT_PERMITTED When \p alg is a specific algorithm, but
1113 * the \p policy does not allow it.
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001114 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001115static psa_status_t psa_key_policy_permits(const psa_key_policy_t *policy,
1116 psa_key_type_t key_type,
1117 psa_algorithm_t alg)
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001118{
Steven Cooremand788fab2021-02-25 11:29:17 +01001119 /* '0' is not a valid algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01001120 if (alg == 0) {
1121 return PSA_ERROR_INVALID_ARGUMENT;
1122 }
Steven Cooremand788fab2021-02-25 11:29:17 +01001123
Steven Cooreman7e39f052021-02-23 14:18:32 +01001124 /* A requested algorithm cannot be a wildcard. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001125 if (PSA_ALG_IS_WILDCARD(alg)) {
1126 return PSA_ERROR_INVALID_ARGUMENT;
1127 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001128
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 if (psa_key_algorithm_permits(key_type, policy->alg, alg) ||
1130 psa_key_algorithm_permits(key_type, policy->alg2, alg)) {
1131 return PSA_SUCCESS;
1132 } else {
1133 return PSA_ERROR_NOT_PERMITTED;
1134 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001135}
1136
Gilles Peskinef603c712019-01-19 13:40:11 +01001137/** Restrict a key policy based on a constraint.
1138 *
Steven Cooreman5a172672021-03-02 21:27:42 +01001139 * \note This function requires providing the key type for which the policy is
1140 * being restricted, since some algorithm policy definitions (e.g. MAC)
1141 * have different properties depending on what kind of cipher it is
1142 * combined with.
1143 *
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001144 * \param[in] key_type The key type for which to restrict the policy
Gilles Peskinef603c712019-01-19 13:40:11 +01001145 * \param[in,out] policy The policy to restrict.
1146 * \param[in] constraint The policy constraint to apply.
1147 *
1148 * \retval #PSA_SUCCESS
1149 * \c *policy contains the intersection of the original value of
1150 * \c *policy and \c *constraint.
1151 * \retval #PSA_ERROR_INVALID_ARGUMENT
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001152 * \c key_type, \c *policy and \c *constraint are incompatible.
Gilles Peskinef603c712019-01-19 13:40:11 +01001153 * \c *policy is unchanged.
1154 */
1155static psa_status_t psa_restrict_key_policy(
Steven Cooreman1ac5ce32021-03-02 16:34:49 +01001156 psa_key_type_t key_type,
Gilles Peskinef603c712019-01-19 13:40:11 +01001157 psa_key_policy_t *policy,
Gilles Peskine449bd832023-01-11 14:50:10 +01001158 const psa_key_policy_t *constraint)
Gilles Peskinef603c712019-01-19 13:40:11 +01001159{
1160 psa_algorithm_t intersection_alg =
Gilles Peskine449bd832023-01-11 14:50:10 +01001161 psa_key_policy_algorithm_intersection(key_type, policy->alg,
1162 constraint->alg);
Gilles Peskined6f371b2019-05-10 19:33:38 +02001163 psa_algorithm_t intersection_alg2 =
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 psa_key_policy_algorithm_intersection(key_type, policy->alg2,
1165 constraint->alg2);
1166 if (intersection_alg == 0 && policy->alg != 0 && constraint->alg != 0) {
1167 return PSA_ERROR_INVALID_ARGUMENT;
1168 }
1169 if (intersection_alg2 == 0 && policy->alg2 != 0 && constraint->alg2 != 0) {
1170 return PSA_ERROR_INVALID_ARGUMENT;
1171 }
Gilles Peskinef603c712019-01-19 13:40:11 +01001172 policy->usage &= constraint->usage;
1173 policy->alg = intersection_alg;
Gilles Peskined6f371b2019-05-10 19:33:38 +02001174 policy->alg2 = intersection_alg2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001175 return PSA_SUCCESS;
Gilles Peskinef603c712019-01-19 13:40:11 +01001176}
1177
Przemek Stekiel061f6942022-11-30 10:51:35 +01001178/** Get the description of a key given its identifier and policy constraints
1179 * and lock it.
1180 *
1181 * The key must have allow all the usage flags set in \p usage. If \p alg is
1182 * nonzero, the key must allow operations with this algorithm. If \p alg is
1183 * zero, the algorithm is not checked.
1184 *
1185 * In case of a persistent key, the function loads the description of the key
1186 * into a key slot if not already done.
1187 *
1188 * On success, the returned key slot is locked. It is the responsibility of
1189 * the caller to unlock the key slot when it does not access it anymore.
1190 */
1191static psa_status_t psa_get_and_lock_key_slot_with_policy(
Ronald Cron5c522922020-11-14 16:35:34 +01001192 mbedtls_svc_key_id_t key,
1193 psa_key_slot_t **p_slot,
1194 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001195 psa_algorithm_t alg)
Darryl Green06fd18d2018-07-16 11:21:11 +01001196{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001197 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01001198 psa_key_slot_t *slot = NULL;
Darryl Green06fd18d2018-07-16 11:21:11 +01001199
Gilles Peskine449bd832023-01-11 14:50:10 +01001200 status = psa_get_and_lock_key_slot(key, p_slot);
1201 if (status != PSA_SUCCESS) {
1202 return status;
1203 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001204 slot = *p_slot;
Darryl Green06fd18d2018-07-16 11:21:11 +01001205
1206 /* Enforce that usage policy for the key slot contains all the flags
1207 * required by the usage parameter. There is one exception: public
1208 * keys can always be exported, so we treat public key objects as
1209 * if they had the export flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001210 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
Darryl Green06fd18d2018-07-16 11:21:11 +01001211 usage &= ~PSA_KEY_USAGE_EXPORT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001212 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001213
Gilles Peskine449bd832023-01-11 14:50:10 +01001214 if ((slot->attr.policy.usage & usage) != usage) {
Steven Cooreman328f11c2021-03-02 11:44:51 +01001215 status = PSA_ERROR_NOT_PERMITTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001216 goto error;
Steven Cooreman328f11c2021-03-02 11:44:51 +01001217 }
Gilles Peskine30f77cd2019-01-14 16:06:39 +01001218
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001219 /* Enforce that the usage policy permits the requested algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001220 if (alg != 0) {
1221 status = psa_key_policy_permits(&slot->attr.policy,
1222 slot->attr.type,
1223 alg);
1224 if (status != PSA_SUCCESS) {
Steven Cooreman7e39f052021-02-23 14:18:32 +01001225 goto error;
Gilles Peskine449bd832023-01-11 14:50:10 +01001226 }
Steven Cooreman7e39f052021-02-23 14:18:32 +01001227 }
Darryl Green06fd18d2018-07-16 11:21:11 +01001228
Gilles Peskine449bd832023-01-11 14:50:10 +01001229 return PSA_SUCCESS;
Ronald Cronf95a2b12020-10-22 15:24:49 +02001230
1231error:
1232 *p_slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001233 psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001234
Gilles Peskine449bd832023-01-11 14:50:10 +01001235 return status;
Darryl Green06fd18d2018-07-16 11:21:11 +01001236}
Darryl Green940d72c2018-07-13 13:18:51 +01001237
Ronald Cron5c522922020-11-14 16:35:34 +01001238/** Get a key slot containing a transparent key and lock it.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001239 *
1240 * A transparent key is a key for which the key material is directly
Ronald Cronddae0f52021-08-24 15:39:44 +02001241 * available, as opposed to a key in a secure element and/or to be used
1242 * by a secure element.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001243 *
Ronald Cronddae0f52021-08-24 15:39:44 +02001244 * This is a temporary function that may be used instead of
1245 * psa_get_and_lock_key_slot_with_policy() when there is no opaque key support
1246 * for a cryptographic operation.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001247 *
Ronald Cron5c522922020-11-14 16:35:34 +01001248 * On success, the returned key slot is locked. It is the responsibility of the
1249 * caller to unlock the key slot when it does not access it anymore.
Gilles Peskine28f8f302019-07-24 13:30:31 +02001250 */
Ronald Cron5c522922020-11-14 16:35:34 +01001251static psa_status_t psa_get_and_lock_transparent_key_slot_with_policy(
1252 mbedtls_svc_key_id_t key,
1253 psa_key_slot_t **p_slot,
1254 psa_key_usage_t usage,
Gilles Peskine449bd832023-01-11 14:50:10 +01001255 psa_algorithm_t alg)
Gilles Peskine28f8f302019-07-24 13:30:31 +02001256{
Gilles Peskine449bd832023-01-11 14:50:10 +01001257 psa_status_t status = psa_get_and_lock_key_slot_with_policy(key, p_slot,
1258 usage, alg);
1259 if (status != PSA_SUCCESS) {
1260 return status;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001261 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001262
Gilles Peskine449bd832023-01-11 14:50:10 +01001263 if (psa_key_lifetime_is_external((*p_slot)->attr.lifetime)) {
1264 psa_unlock_key_slot(*p_slot);
1265 *p_slot = NULL;
1266 return PSA_ERROR_NOT_SUPPORTED;
1267 }
1268
1269 return PSA_SUCCESS;
Gilles Peskine28f8f302019-07-24 13:30:31 +02001270}
Gilles Peskine28f8f302019-07-24 13:30:31 +02001271
Gilles Peskine449bd832023-01-11 14:50:10 +01001272psa_status_t psa_remove_key_data_from_memory(psa_key_slot_t *slot)
Darryl Green40225ba2018-11-15 14:48:15 +00001273{
Gilles Peskine449bd832023-01-11 14:50:10 +01001274 if (slot->key.data != NULL) {
Tom Cosgrove52f7e182023-08-01 09:08:48 +01001275 mbedtls_zeroize_and_free(slot->key.data, slot->key.bytes);
Gilles Peskine449bd832023-01-11 14:50:10 +01001276 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001277
Ronald Cronea0f8a62020-11-25 17:52:23 +01001278 slot->key.data = NULL;
1279 slot->key.bytes = 0;
Darryl Green40225ba2018-11-15 14:48:15 +00001280
Gilles Peskine449bd832023-01-11 14:50:10 +01001281 return PSA_SUCCESS;
Darryl Green40225ba2018-11-15 14:48:15 +00001282}
1283
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001284/** Completely wipe a slot in memory, including its policy.
1285 * Persistent storage is not affected. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001286psa_status_t psa_wipe_key_slot(psa_key_slot_t *slot)
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001287{
Gilles Peskine449bd832023-01-11 14:50:10 +01001288 psa_status_t status = psa_remove_key_data_from_memory(slot);
Ronald Cronddd3d052020-10-30 14:07:07 +01001289
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 /*
1291 * As the return error code may not be handled in case of multiple errors,
1292 * do our best to report an unexpected lock counter. Assert with
1293 * MBEDTLS_TEST_HOOK_TEST_ASSERT that the lock counter is equal to one:
1294 * if the MBEDTLS_TEST_HOOKS configuration option is enabled and the
1295 * function is called as part of the execution of a test suite, the
1296 * execution of the test suite is stopped in error if the assertion fails.
1297 */
1298 if (slot->lock_count != 1) {
1299 MBEDTLS_TEST_HOOK_TEST_ASSERT(slot->lock_count == 1);
Ronald Cronddd3d052020-10-30 14:07:07 +01001300 status = PSA_ERROR_CORRUPTION_DETECTED;
1301 }
1302
Gilles Peskine3f7cd622019-08-13 15:01:08 +02001303 /* Multipart operations may still be using the key. This is safe
1304 * because all multipart operation objects are independent from
1305 * the key slot: if they need to access the key after the setup
1306 * phase, they have a copy of the key. Note that this means that
1307 * key material can linger until all operations are completed. */
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001308 /* At this point, key material and other type-specific content has
1309 * been wiped. Clear remaining metadata. We can call memset and not
1310 * zeroize because the metadata is not particularly sensitive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 memset(slot, 0, sizeof(*slot));
1312 return status;
Gilles Peskinef77ed1f2018-12-03 11:58:46 +01001313}
1314
Gilles Peskine449bd832023-01-11 14:50:10 +01001315psa_status_t psa_destroy_key(mbedtls_svc_key_id_t key)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001316{
Gilles Peskine2f060a82018-12-04 17:12:32 +01001317 psa_key_slot_t *slot;
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001318 psa_status_t status; /* status of the last operation */
1319 psa_status_t overall_status = PSA_SUCCESS;
Gilles Peskine354f7672019-07-12 23:46:38 +02001320#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1321 psa_se_drv_table_entry_t *driver;
1322#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001323
Gilles Peskine449bd832023-01-11 14:50:10 +01001324 if (mbedtls_svc_key_id_is_null(key)) {
1325 return PSA_SUCCESS;
1326 }
Gilles Peskine1841cf42019-10-08 15:48:25 +02001327
Ronald Cronf2911112020-10-29 17:51:10 +01001328 /*
Ronald Cron19daca92020-11-10 18:08:03 +01001329 * Get the description of the key in a key slot. In case of a persistent
Ronald Cronf2911112020-10-29 17:51:10 +01001330 * key, this will load the key description from persistent memory if not
1331 * done yet. We cannot avoid this loading as without it we don't know if
1332 * the key is operated by an SE or not and this information is needed by
1333 * the current implementation.
1334 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 status = psa_get_and_lock_key_slot(key, &slot);
1336 if (status != PSA_SUCCESS) {
1337 return status;
1338 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001339
Ronald Cronf2911112020-10-29 17:51:10 +01001340 /*
1341 * If the key slot containing the key description is under access by the
1342 * library (apart from the present access), the key cannot be destroyed
1343 * yet. For the time being, just return in error. Eventually (to be
1344 * implemented), the key should be destroyed when all accesses have
1345 * stopped.
1346 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001347 if (slot->lock_count > 1) {
1348 psa_unlock_key_slot(slot);
1349 return PSA_ERROR_GENERIC_ERROR;
Ronald Cronf2911112020-10-29 17:51:10 +01001350 }
1351
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 if (PSA_KEY_LIFETIME_IS_READ_ONLY(slot->attr.lifetime)) {
Gilles Peskine6687cd02021-04-21 22:32:05 +02001353 /* Refuse the destruction of a read-only key (which may or may not work
1354 * if we attempt it, depending on whether the key is merely read-only
1355 * by policy or actually physically read-only).
Gilles Peskinef9a046e2021-06-07 23:27:54 +02001356 * Just do the best we can, which is to wipe the copy in memory
1357 * (done in this function's cleanup code). */
1358 overall_status = PSA_ERROR_NOT_PERMITTED;
1359 goto exit;
Gilles Peskine6687cd02021-04-21 22:32:05 +02001360 }
1361
Gilles Peskine354f7672019-07-12 23:46:38 +02001362#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001363 driver = psa_get_se_driver_entry(slot->attr.lifetime);
1364 if (driver != NULL) {
Gilles Peskine60450a42019-07-25 11:32:45 +02001365 /* For a key in a secure element, we need to do three things:
1366 * remove the key file in internal storage, destroy the
1367 * key inside the secure element, and update the driver's
1368 * persistent data. Start a transaction that will encompass these
1369 * three actions. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001370 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_DESTROY_KEY);
Gilles Peskine8e338702019-07-30 20:06:31 +02001371 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Gilles Peskine449bd832023-01-11 14:50:10 +01001372 psa_crypto_transaction.key.slot = psa_key_slot_get_slot_number(slot);
Gilles Peskine8e338702019-07-30 20:06:31 +02001373 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001374 status = psa_crypto_save_transaction();
1375 if (status != PSA_SUCCESS) {
1376 (void) psa_crypto_stop_transaction();
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001377 /* We should still try to destroy the key in the secure
1378 * element and the key metadata in storage. This is especially
1379 * important if the error is that the storage is full.
1380 * But how to do it exactly without risking an inconsistent
1381 * state after a reset?
1382 * https://github.com/ARMmbed/mbed-crypto/issues/215
1383 */
1384 overall_status = status;
1385 goto exit;
Gilles Peskinefc762652019-07-22 19:30:34 +02001386 }
1387
Gilles Peskine449bd832023-01-11 14:50:10 +01001388 status = psa_destroy_se_key(driver,
1389 psa_key_slot_get_slot_number(slot));
1390 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001391 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001392 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001393 }
Gilles Peskine354f7672019-07-12 23:46:38 +02001394#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1395
Darryl Greend49a4992018-06-18 17:27:26 +01001396#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001397 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
1398 status = psa_destroy_persistent_key(slot->attr.id);
1399 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001400 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 }
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001402
Gilles Peskine9ce31c42019-08-13 15:14:20 +02001403 /* TODO: other slots may have a copy of the same key. We should
1404 * invalidate them.
1405 * https://github.com/ARMmbed/mbed-crypto/issues/214
1406 */
Darryl Greend49a4992018-06-18 17:27:26 +01001407 }
1408#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
Gilles Peskine354f7672019-07-12 23:46:38 +02001409
Gilles Peskinefc762652019-07-22 19:30:34 +02001410#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001411 if (driver != NULL) {
1412 status = psa_save_se_persistent_data(driver);
1413 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001414 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001415 }
1416 status = psa_crypto_stop_transaction();
1417 if (overall_status == PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001418 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 }
Gilles Peskinefc762652019-07-22 19:30:34 +02001420 }
1421#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1422
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001423exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 status = psa_wipe_key_slot(slot);
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001425 /* Prioritize CORRUPTION_DETECTED from wiping over a storage error */
Gilles Peskine449bd832023-01-11 14:50:10 +01001426 if (status != PSA_SUCCESS) {
Gilles Peskine4b7f3402019-08-13 15:58:36 +02001427 overall_status = status;
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 }
1429 return overall_status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001430}
1431
Valerio Settib2bcedb2023-07-10 11:24:00 +02001432#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
John Durkop0e005192020-10-31 22:06:54 -07001433 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskineb699f072019-04-26 16:06:02 +02001434static psa_status_t psa_get_rsa_public_exponent(
1435 const mbedtls_rsa_context *rsa,
Gilles Peskine449bd832023-01-11 14:50:10 +01001436 psa_key_attributes_t *attributes)
Gilles Peskineb699f072019-04-26 16:06:02 +02001437{
1438 mbedtls_mpi mpi;
Janos Follath24eed8d2019-11-22 13:21:35 +00001439 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb699f072019-04-26 16:06:02 +02001440 uint8_t *buffer = NULL;
1441 size_t buflen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001442 mbedtls_mpi_init(&mpi);
Gilles Peskineb699f072019-04-26 16:06:02 +02001443
Gilles Peskine449bd832023-01-11 14:50:10 +01001444 ret = mbedtls_rsa_export(rsa, NULL, NULL, NULL, NULL, &mpi);
1445 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001446 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001447 }
1448 if (mbedtls_mpi_cmp_int(&mpi, 65537) == 0) {
Gilles Peskine772c8b12019-04-26 17:37:21 +02001449 /* It's the default value, which is reported as an empty string,
1450 * so there's nothing to do. */
1451 goto exit;
1452 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001453
Gilles Peskine449bd832023-01-11 14:50:10 +01001454 buflen = mbedtls_mpi_size(&mpi);
1455 buffer = mbedtls_calloc(1, buflen);
1456 if (buffer == NULL) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001457 ret = MBEDTLS_ERR_MPI_ALLOC_FAILED;
1458 goto exit;
1459 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001460 ret = mbedtls_mpi_write_binary(&mpi, buffer, buflen);
1461 if (ret != 0) {
Gilles Peskineb699f072019-04-26 16:06:02 +02001462 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01001463 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001464 attributes->domain_parameters = buffer;
1465 attributes->domain_parameters_size = buflen;
1466
1467exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001468 mbedtls_mpi_free(&mpi);
1469 if (ret != 0) {
1470 mbedtls_free(buffer);
1471 }
1472 return mbedtls_to_psa_error(ret);
Gilles Peskineb699f072019-04-26 16:06:02 +02001473}
Valerio Settib2bcedb2023-07-10 11:24:00 +02001474#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001475 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001476
Gilles Peskinebfd322f2019-07-23 11:58:03 +02001477/** Retrieve all the publicly-accessible attributes of a key.
1478 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001479psa_status_t psa_get_key_attributes(mbedtls_svc_key_id_t key,
1480 psa_key_attributes_t *attributes)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001481{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001482 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001483 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001484 psa_key_slot_t *slot;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001485
Gilles Peskine449bd832023-01-11 14:50:10 +01001486 psa_reset_key_attributes(attributes);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02001487
Gilles Peskine449bd832023-01-11 14:50:10 +01001488 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1489 if (status != PSA_SUCCESS) {
1490 return status;
1491 }
Gilles Peskineb870b182018-07-06 16:02:09 +02001492
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001493 attributes->core = slot->attr;
Gilles Peskine449bd832023-01-11 14:50:10 +01001494 attributes->core.flags &= (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1495 MBEDTLS_PSA_KA_MASK_DUAL_USE);
Gilles Peskinec8000c02019-08-02 20:15:51 +02001496
1497#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001498 if (psa_get_se_driver_entry(slot->attr.lifetime) != NULL) {
1499 psa_set_key_slot_number(attributes,
1500 psa_key_slot_get_slot_number(slot));
1501 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001502#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskineb699f072019-04-26 16:06:02 +02001503
Gilles Peskine449bd832023-01-11 14:50:10 +01001504 switch (slot->attr.type) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001505#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1506 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
John Durkop0e005192020-10-31 22:06:54 -07001507 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
Gilles Peskinec93b80c2019-05-16 19:39:54 +02001508 case PSA_KEY_TYPE_RSA_KEY_PAIR:
Gilles Peskineb699f072019-04-26 16:06:02 +02001509 case PSA_KEY_TYPE_RSA_PUBLIC_KEY:
Janos Follath1d57a202019-08-13 12:15:34 +01001510 /* TODO: reporting the public exponent for opaque keys
Gilles Peskinec9d7f942019-08-13 16:17:16 +02001511 * is not yet implemented.
1512 * https://github.com/ARMmbed/mbed-crypto/issues/216
1513 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001514 if (!psa_key_lifetime_is_external(slot->attr.lifetime)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02001515 mbedtls_rsa_context *rsa = NULL;
Steven Cooremana01795d2020-07-24 22:48:15 +02001516
Ronald Cron90857082020-11-25 14:58:33 +01001517 status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 slot->attr.type,
1519 slot->key.data,
1520 slot->key.bytes,
1521 &rsa);
1522 if (status != PSA_SUCCESS) {
Steven Cooremana01795d2020-07-24 22:48:15 +02001523 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 }
Steven Cooremana01795d2020-07-24 22:48:15 +02001525
Gilles Peskine449bd832023-01-11 14:50:10 +01001526 status = psa_get_rsa_public_exponent(rsa,
1527 attributes);
1528 mbedtls_rsa_free(rsa);
1529 mbedtls_free(rsa);
Steven Cooremana01795d2020-07-24 22:48:15 +02001530 }
Gilles Peskineb699f072019-04-26 16:06:02 +02001531 break;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001532#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
1533 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08001534 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskineb699f072019-04-26 16:06:02 +02001535 default:
1536 /* Nothing else to do. */
1537 break;
1538 }
1539
Gilles Peskine449bd832023-01-11 14:50:10 +01001540 if (status != PSA_SUCCESS) {
1541 psa_reset_key_attributes(attributes);
1542 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001543
Gilles Peskine449bd832023-01-11 14:50:10 +01001544 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001545
Gilles Peskine449bd832023-01-11 14:50:10 +01001546 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001547}
1548
Gilles Peskinec8000c02019-08-02 20:15:51 +02001549#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
1550psa_status_t psa_get_key_slot_number(
1551 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001552 psa_key_slot_number_t *slot_number)
Gilles Peskinec8000c02019-08-02 20:15:51 +02001553{
Gilles Peskine449bd832023-01-11 14:50:10 +01001554 if (attributes->core.flags & MBEDTLS_PSA_KA_FLAG_HAS_SLOT_NUMBER) {
Gilles Peskinec8000c02019-08-02 20:15:51 +02001555 *slot_number = attributes->slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 return PSA_SUCCESS;
1557 } else {
1558 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskinec8000c02019-08-02 20:15:51 +02001559 }
Gilles Peskinec8000c02019-08-02 20:15:51 +02001560}
1561#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1562
Gilles Peskine449bd832023-01-11 14:50:10 +01001563static psa_status_t psa_export_key_buffer_internal(const uint8_t *key_buffer,
1564 size_t key_buffer_size,
1565 uint8_t *data,
1566 size_t data_size,
1567 size_t *data_length)
Steven Cooremana01795d2020-07-24 22:48:15 +02001568{
Gilles Peskine449bd832023-01-11 14:50:10 +01001569 if (key_buffer_size > data_size) {
1570 return PSA_ERROR_BUFFER_TOO_SMALL;
1571 }
1572 memcpy(data, key_buffer, key_buffer_size);
1573 memset(data + key_buffer_size, 0,
1574 data_size - key_buffer_size);
Ronald Crond18b5f82020-11-25 16:46:05 +01001575 *data_length = key_buffer_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01001576 return PSA_SUCCESS;
Steven Cooremana01795d2020-07-24 22:48:15 +02001577}
1578
Ronald Cron7285cda2020-11-26 14:46:37 +01001579psa_status_t psa_export_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001580 const psa_key_attributes_t *attributes,
1581 const uint8_t *key_buffer, size_t key_buffer_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001582 uint8_t *data, size_t data_size, size_t *data_length)
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001583{
Ronald Crond18b5f82020-11-25 16:46:05 +01001584 psa_key_type_t type = attributes->core.type;
1585
Gilles Peskine449bd832023-01-11 14:50:10 +01001586 if (key_type_is_raw_bytes(type) ||
1587 PSA_KEY_TYPE_IS_RSA(type) ||
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001588 PSA_KEY_TYPE_IS_ECC(type) ||
1589 PSA_KEY_TYPE_IS_DH(type)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001590 return psa_export_key_buffer_internal(
1591 key_buffer, key_buffer_size,
1592 data, data_size, data_length);
1593 } else {
Ronald Cron9486f9d2020-11-26 13:36:23 +01001594 /* This shouldn't happen in the reference implementation, but
1595 it is valid for a special-purpose implementation to omit
1596 support for exporting certain key types. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001597 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001598 }
1599}
1600
Gilles Peskine449bd832023-01-11 14:50:10 +01001601psa_status_t psa_export_key(mbedtls_svc_key_id_t key,
Ryan Everett45ac5262024-01-08 17:15:19 +00001602 uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01001603 size_t data_size,
1604 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001605{
1606 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
1607 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
1608 psa_key_slot_t *slot;
Ryan Everett45ac5262024-01-08 17:15:19 +00001609 LOCAL_OUTPUT_DECLARE(data_external, data);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001610
Ronald Crone907e552021-01-18 13:22:38 +01001611 /* Reject a zero-length output buffer now, since this can never be a
1612 * valid key representation. This way we know that data must be a valid
1613 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001614 if (data_size == 0) {
1615 return PSA_ERROR_BUFFER_TOO_SMALL;
1616 }
Ronald Crone907e552021-01-18 13:22:38 +01001617
Ronald Cron9486f9d2020-11-26 13:36:23 +01001618 /* Set the key to empty now, so that even when there are errors, we always
1619 * set data_length to a value between 0 and data_size. On error, setting
1620 * the key to empty is a good choice because an empty key representation is
1621 * unlikely to be accepted anywhere. */
Jaeden Amerof24c7f82018-06-27 17:20:43 +01001622 *data_length = 0;
1623
Ronald Cron9486f9d2020-11-26 13:36:23 +01001624 /* Export requires the EXPORT flag. There is an exception for public keys,
1625 * which don't require any flag, but
1626 * psa_get_and_lock_key_slot_with_policy() takes care of this.
1627 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001628 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
1629 PSA_KEY_USAGE_EXPORT, 0);
1630 if (status != PSA_SUCCESS) {
1631 return status;
1632 }
mohammad160306e79202018-03-28 13:17:44 +03001633
Ryan Everett45ac5262024-01-08 17:15:19 +00001634 LOCAL_OUTPUT_ALLOC(data_external, data_size, data);
1635
Ronald Crond18b5f82020-11-25 16:46:05 +01001636 psa_key_attributes_t attributes = {
1637 .core = slot->attr
1638 };
Gilles Peskine449bd832023-01-11 14:50:10 +01001639 status = psa_driver_wrapper_export_key(&attributes,
1640 slot->key.data, slot->key.bytes,
1641 data, data_size, data_length);
Ryan Everett35f68532024-01-25 12:02:03 +00001642#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Ryan Everett45ac5262024-01-08 17:15:19 +00001643exit:
Ryan Everett35f68532024-01-25 12:02:03 +00001644#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001645 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001646
Ryan Everett45ac5262024-01-08 17:15:19 +00001647 LOCAL_OUTPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01001648 return (status == PSA_SUCCESS) ? unlock_status : status;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001649}
1650
Ronald Cron7285cda2020-11-26 14:46:37 +01001651psa_status_t psa_export_public_key_internal(
Ronald Crond18b5f82020-11-25 16:46:05 +01001652 const psa_key_attributes_t *attributes,
1653 const uint8_t *key_buffer,
1654 size_t key_buffer_size,
1655 uint8_t *data,
1656 size_t data_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01001657 size_t *data_length)
Ronald Cron9486f9d2020-11-26 13:36:23 +01001658{
Ronald Crond18b5f82020-11-25 16:46:05 +01001659 psa_key_type_t type = attributes->core.type;
Ronald Crond18b5f82020-11-25 16:46:05 +01001660
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001661 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(type) &&
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001662 (PSA_KEY_TYPE_IS_RSA(type) || PSA_KEY_TYPE_IS_ECC(type) ||
1663 PSA_KEY_TYPE_IS_DH(type))) {
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001664 /* Exporting public -> public */
1665 return psa_export_key_buffer_internal(
1666 key_buffer, key_buffer_size,
1667 data, data_size, data_length);
1668 } else if (PSA_KEY_TYPE_IS_RSA(type)) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02001669#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001670 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
1671 return mbedtls_psa_rsa_export_public_key(attributes,
1672 key_buffer,
1673 key_buffer_size,
1674 data,
1675 data_size,
1676 data_length);
Darryl Green9e2d7a02018-07-24 16:33:30 +01001677#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001678 /* We don't know how to convert a private RSA key to public. */
1679 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settib2bcedb2023-07-10 11:24:00 +02001680#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001681 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001682 } else if (PSA_KEY_TYPE_IS_ECC(type)) {
Valerio Setti27c501a2023-06-27 16:58:52 +02001683#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) || \
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001684 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY)
1685 return mbedtls_psa_ecp_export_public_key(attributes,
1686 key_buffer,
1687 key_buffer_size,
1688 data,
1689 data_size,
1690 data_length);
Steven Cooreman560c28a2020-07-24 23:20:24 +02001691#else
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001692 /* We don't know how to convert a private ECC key to public */
1693 return PSA_ERROR_NOT_SUPPORTED;
Valerio Setti27c501a2023-06-27 16:58:52 +02001694#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_EXPORT) ||
John Durkop9814fa22020-11-04 12:28:15 -08001695 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_PUBLIC_KEY) */
Przemek Stekiel6fd72b62023-04-27 10:20:56 +02001696 } else if (PSA_KEY_TYPE_IS_DH(type)) {
Valerio Settia55f0422023-07-10 15:34:41 +02001697#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) || \
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001698 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY)
Przemek Stekiel152bb462023-06-01 11:52:39 +02001699 return mbedtls_psa_ffdh_export_public_key(attributes,
Przemek Stekiel134cc2e2023-05-05 10:13:37 +02001700 key_buffer,
1701 key_buffer_size,
1702 data, data_size,
1703 data_length);
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001704#else
Przemek Stekiel472b3f32022-12-01 14:38:49 +01001705 return PSA_ERROR_NOT_SUPPORTED;
Valerio Settia55f0422023-07-10 15:34:41 +02001706#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_EXPORT) ||
Przemek Stekiel6d85afa2023-04-28 11:42:17 +02001707 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_PUBLIC_KEY) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001708 } else {
Przemek Stekiel0b11ee02023-05-16 13:26:06 +02001709 (void) key_buffer;
1710 (void) key_buffer_size;
1711 (void) data;
1712 (void) data_size;
1713 (void) data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01001714 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman560c28a2020-07-24 23:20:24 +02001715 }
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01001716}
Ronald Crond18b5f82020-11-25 16:46:05 +01001717
Gilles Peskine449bd832023-01-11 14:50:10 +01001718psa_status_t psa_export_public_key(mbedtls_svc_key_id_t key,
Ryan Everettb1d2c672024-01-08 17:19:30 +00001719 uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01001720 size_t data_size,
1721 size_t *data_length)
Moran Pekerdd4ea382018-04-03 15:30:03 +03001722{
Ronald Cronf95a2b12020-10-22 15:24:49 +02001723 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01001724 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01001725 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001726 psa_key_attributes_t attributes;
Ryan Everettb1d2c672024-01-08 17:19:30 +00001727 LOCAL_OUTPUT_DECLARE(data_external, data);
Darryl Greendd8fb772018-11-07 16:00:44 +00001728
Ronald Crone907e552021-01-18 13:22:38 +01001729 /* Reject a zero-length output buffer now, since this can never be a
1730 * valid key representation. This way we know that data must be a valid
1731 * pointer and we can do things like memset(data, ..., data_size). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001732 if (data_size == 0) {
1733 return PSA_ERROR_BUFFER_TOO_SMALL;
1734 }
Ronald Crone907e552021-01-18 13:22:38 +01001735
Darryl Greendd8fb772018-11-07 16:00:44 +00001736 /* Set the key to empty now, so that even when there are errors, we always
1737 * set data_length to a value between 0 and data_size. On error, setting
1738 * the key to empty is a good choice because an empty key representation is
1739 * unlikely to be accepted anywhere. */
1740 *data_length = 0;
1741
1742 /* Exporting a public key doesn't require a usage flag. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001743 status = psa_get_and_lock_key_slot_with_policy(key, &slot, 0, 0);
1744 if (status != PSA_SUCCESS) {
1745 return status;
1746 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02001747
Ryan Everettb1d2c672024-01-08 17:19:30 +00001748 LOCAL_OUTPUT_ALLOC(data_external, data_size, data);
1749
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 if (!PSA_KEY_TYPE_IS_ASYMMETRIC(slot->attr.type)) {
1751 status = PSA_ERROR_INVALID_ARGUMENT;
1752 goto exit;
Ronald Cron9486f9d2020-11-26 13:36:23 +01001753 }
1754
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01001755 attributes = (psa_key_attributes_t) {
Ronald Crond18b5f82020-11-25 16:46:05 +01001756 .core = slot->attr
1757 };
Ronald Cron67227982020-11-26 15:16:05 +01001758 status = psa_driver_wrapper_export_public_key(
Ronald Crond18b5f82020-11-25 16:46:05 +01001759 &attributes, slot->key.data, slot->key.bytes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 data, data_size, data_length);
Ronald Cron9486f9d2020-11-26 13:36:23 +01001761
1762exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001763 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02001764
Ryan Everettb1d2c672024-01-08 17:19:30 +00001765 LOCAL_OUTPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01001766 return (status == PSA_SUCCESS) ? unlock_status : status;
Moran Pekerdd4ea382018-04-03 15:30:03 +03001767}
1768
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00001769MBEDTLS_STATIC_ASSERT(
1770 (MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1771 "One or more key attribute flag is listed as both external-only and dual-use")
1772MBEDTLS_STATIC_ASSERT(
1773 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_DUAL_USE) == 0,
1774 "One or more key attribute flag is listed as both internal-only and dual-use")
1775MBEDTLS_STATIC_ASSERT(
1776 (PSA_KA_MASK_INTERNAL_ONLY & MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY) == 0,
1777 "One or more key attribute flag is listed as both internal-only and external-only")
Gilles Peskine91e8c332019-08-02 19:19:39 +02001778
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001779/** Validate that a key policy is internally well-formed.
1780 *
1781 * This function only rejects invalid policies. It does not validate the
1782 * consistency of the policy with respect to other attributes of the key
1783 * such as the key type.
1784 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001785static psa_status_t psa_validate_key_policy(const psa_key_policy_t *policy)
Gilles Peskine4747d192019-04-17 15:05:45 +02001786{
Gilles Peskine449bd832023-01-11 14:50:10 +01001787 if ((policy->usage & ~(PSA_KEY_USAGE_EXPORT |
1788 PSA_KEY_USAGE_COPY |
1789 PSA_KEY_USAGE_ENCRYPT |
1790 PSA_KEY_USAGE_DECRYPT |
1791 PSA_KEY_USAGE_SIGN_MESSAGE |
1792 PSA_KEY_USAGE_VERIFY_MESSAGE |
1793 PSA_KEY_USAGE_SIGN_HASH |
1794 PSA_KEY_USAGE_VERIFY_HASH |
1795 PSA_KEY_USAGE_VERIFY_DERIVATION |
1796 PSA_KEY_USAGE_DERIVE)) != 0) {
1797 return PSA_ERROR_INVALID_ARGUMENT;
1798 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001799
Gilles Peskine449bd832023-01-11 14:50:10 +01001800 return PSA_SUCCESS;
Gilles Peskine4747d192019-04-17 15:05:45 +02001801}
1802
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001803/** Validate the internal consistency of key attributes.
1804 *
1805 * This function only rejects invalid attribute values. If does not
1806 * validate the consistency of the attributes with any key data that may
1807 * be involved in the creation of the key.
1808 *
1809 * Call this function early in the key creation process.
1810 *
1811 * \param[in] attributes Key attributes for the new key.
1812 * \param[out] p_drv On any return, the driver for the key, if any.
1813 * NULL for a transparent key.
1814 *
1815 */
1816static psa_status_t psa_validate_key_attributes(
1817 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 psa_se_drv_table_entry_t **p_drv)
Darryl Green0c6575a2018-11-07 16:05:30 +00001819{
Steven Cooreman81fe7c32020-06-08 18:37:19 +02001820 psa_status_t status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01001821 psa_key_lifetime_t lifetime = psa_get_key_lifetime(attributes);
1822 mbedtls_svc_key_id_t key = psa_get_key_id(attributes);
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001823
Gilles Peskine449bd832023-01-11 14:50:10 +01001824 status = psa_validate_key_location(lifetime, p_drv);
1825 if (status != PSA_SUCCESS) {
1826 return status;
Ronald Crond2ed4812020-07-17 16:11:30 +02001827 }
1828
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 status = psa_validate_key_persistence(lifetime);
1830 if (status != PSA_SUCCESS) {
1831 return status;
1832 }
1833
1834 if (PSA_KEY_LIFETIME_IS_VOLATILE(lifetime)) {
1835 if (MBEDTLS_SVC_KEY_ID_GET_KEY_ID(key) != 0) {
1836 return PSA_ERROR_INVALID_ARGUMENT;
1837 }
1838 } else {
1839 if (!psa_is_valid_key_id(psa_get_key_id(attributes), 0)) {
1840 return PSA_ERROR_INVALID_ARGUMENT;
1841 }
1842 }
1843
1844 status = psa_validate_key_policy(&attributes->core.policy);
1845 if (status != PSA_SUCCESS) {
1846 return status;
1847 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001848
1849 /* Refuse to create overly large keys.
1850 * Note that this doesn't trigger on import if the attributes don't
1851 * explicitly specify a size (so psa_get_key_bits returns 0), so
1852 * psa_import_key() needs its own checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001853 if (psa_get_key_bits(attributes) > PSA_MAX_KEY_BITS) {
1854 return PSA_ERROR_NOT_SUPPORTED;
1855 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001856
Gilles Peskine91e8c332019-08-02 19:19:39 +02001857 /* Reject invalid flags. These should not be reachable through the API. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001858 if (attributes->core.flags & ~(MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY |
1859 MBEDTLS_PSA_KA_MASK_DUAL_USE)) {
1860 return PSA_ERROR_INVALID_ARGUMENT;
1861 }
Gilles Peskine91e8c332019-08-02 19:19:39 +02001862
Gilles Peskine449bd832023-01-11 14:50:10 +01001863 return PSA_SUCCESS;
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001864}
1865
Gilles Peskine4747d192019-04-17 15:05:45 +02001866/** Prepare a key slot to receive key material.
1867 *
1868 * This function allocates a key slot and sets its metadata.
1869 *
1870 * If this function fails, call psa_fail_key_creation().
1871 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001872 * This function is intended to be used as follows:
1873 * -# Call psa_start_key_creation() to allocate a key slot, prepare
Ronald Croncf56a0a2020-08-04 09:51:30 +02001874 * it with the specified attributes, and in case of a volatile key assign it
1875 * a volatile key identifier.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001876 * -# Populate the slot with the key material.
1877 * -# Call psa_finish_key_creation() to finalize the creation of the slot.
1878 * In case of failure at any step, stop the sequence and call
1879 * psa_fail_key_creation().
1880 *
Ronald Cron5c522922020-11-14 16:35:34 +01001881 * On success, the key slot is locked. It is the responsibility of the caller
1882 * to unlock the key slot when it does not access it anymore.
Ronald Cronf95a2b12020-10-22 15:24:49 +02001883 *
Gilles Peskinedf179142019-07-15 22:02:14 +02001884 * \param method An identification of the calling function.
Gilles Peskine011e4282019-06-26 18:34:38 +02001885 * \param[in] attributes Key attributes for the new key.
Gilles Peskine011e4282019-06-26 18:34:38 +02001886 * \param[out] p_slot On success, a pointer to the prepared slot.
1887 * \param[out] p_drv On any return, the driver for the key, if any.
1888 * NULL for a transparent key.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02001889 *
1890 * \retval #PSA_SUCCESS
1891 * The key slot is ready to receive key material.
1892 * \return If this function fails, the key slot is an invalid state.
1893 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02001894 */
1895static psa_status_t psa_start_key_creation(
Gilles Peskinedf179142019-07-15 22:02:14 +02001896 psa_key_creation_method_t method,
Gilles Peskine4747d192019-04-17 15:05:45 +02001897 const psa_key_attributes_t *attributes,
Gilles Peskine011e4282019-06-26 18:34:38 +02001898 psa_key_slot_t **p_slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01001899 psa_se_drv_table_entry_t **p_drv)
Gilles Peskine4747d192019-04-17 15:05:45 +02001900{
1901 psa_status_t status;
Ronald Cron2a993152020-07-17 14:13:26 +02001902 psa_key_id_t volatile_key_id;
Gilles Peskine4747d192019-04-17 15:05:45 +02001903 psa_key_slot_t *slot;
1904
Gilles Peskinedf179142019-07-15 22:02:14 +02001905 (void) method;
Gilles Peskine011e4282019-06-26 18:34:38 +02001906 *p_drv = NULL;
1907
Gilles Peskine449bd832023-01-11 14:50:10 +01001908 status = psa_validate_key_attributes(attributes, p_drv);
1909 if (status != PSA_SUCCESS) {
1910 return status;
1911 }
Gilles Peskine1b8594a2019-07-31 17:21:46 +02001912
Gilles Peskine449bd832023-01-11 14:50:10 +01001913 status = psa_get_empty_key_slot(&volatile_key_id, p_slot);
1914 if (status != PSA_SUCCESS) {
1915 return status;
1916 }
Gilles Peskine4747d192019-04-17 15:05:45 +02001917 slot = *p_slot;
1918
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001919 /* We're storing the declared bit-size of the key. It's up to each
1920 * creation mechanism to verify that this information is correct.
1921 * It's automatically correct for mechanisms that use the bit-size as
Gilles Peskineb46bef22019-07-30 21:32:04 +02001922 * an input (generate, device) but not for those where the bit-size
Ronald Cronc4d1b512020-07-31 11:26:37 +02001923 * is optional (import, copy). In case of a volatile key, assign it the
1924 * volatile key identifier associated to the slot returned to contain its
1925 * definition. */
Gilles Peskine76aa09c2019-07-31 14:15:34 +02001926
1927 slot->attr = attributes->core;
Gilles Peskine449bd832023-01-11 14:50:10 +01001928 if (PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Ronald Cronc4d1b512020-07-31 11:26:37 +02001929#if !defined(MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER)
1930 slot->attr.id = volatile_key_id;
1931#else
1932 slot->attr.id.key_id = volatile_key_id;
1933#endif
1934 }
Gilles Peskinec744d992019-07-30 17:26:54 +02001935
Gilles Peskine91e8c332019-08-02 19:19:39 +02001936 /* Erase external-only flags from the internal copy. To access
Gilles Peskine013f5472019-08-07 15:42:14 +02001937 * external-only flags, query `attributes`. Thanks to the check
1938 * in psa_validate_key_attributes(), this leaves the dual-use
Gilles Peskineedbed562019-08-07 18:19:59 +02001939 * flags and any internal flag that psa_get_empty_key_slot()
Gilles Peskine013f5472019-08-07 15:42:14 +02001940 * may have set. */
1941 slot->attr.flags &= ~MBEDTLS_PSA_KA_MASK_EXTERNAL_ONLY;
Gilles Peskine91e8c332019-08-02 19:19:39 +02001942
Gilles Peskinecbaff462019-07-12 23:46:04 +02001943#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02001944 /* For a key in a secure element, we need to do three things
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001945 * when creating or registering a persistent key:
Gilles Peskine60450a42019-07-25 11:32:45 +02001946 * create the key file in internal storage, create the
1947 * key inside the secure element, and update the driver's
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001948 * persistent data. This is done by starting a transaction that will
1949 * encompass these three actions.
1950 * For registering a volatile key, we just need to find an appropriate
1951 * slot number inside the SE. Since the key is designated volatile, creating
1952 * a transaction is not required. */
Gilles Peskine60450a42019-07-25 11:32:45 +02001953 /* The first thing to do is to find a slot number for the new key.
1954 * We save the slot number in persistent storage as part of the
1955 * transaction data. It will be needed to recover if the power
1956 * fails during the key creation process, to clean up on the secure
1957 * element side after restarting. Obtaining a slot number from the
1958 * secure element driver updates its persistent state, but we do not yet
1959 * save the driver's persistent state, so that if the power fails,
Gilles Peskinefc762652019-07-22 19:30:34 +02001960 * we can roll back to a state where the key doesn't exist. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 if (*p_drv != NULL) {
Ronald Cronea0f8a62020-11-25 17:52:23 +01001962 psa_key_slot_number_t slot_number;
Gilles Peskine449bd832023-01-11 14:50:10 +01001963 status = psa_find_se_slot_for_key(attributes, method, *p_drv,
1964 &slot_number);
1965 if (status != PSA_SUCCESS) {
1966 return status;
1967 }
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001968
Gilles Peskine449bd832023-01-11 14:50:10 +01001969 if (!PSA_KEY_LIFETIME_IS_VOLATILE(attributes->core.lifetime)) {
1970 psa_crypto_prepare_transaction(PSA_CRYPTO_TRANSACTION_CREATE_KEY);
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001971 psa_crypto_transaction.key.lifetime = slot->attr.lifetime;
Ronald Cronea0f8a62020-11-25 17:52:23 +01001972 psa_crypto_transaction.key.slot = slot_number;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001973 psa_crypto_transaction.key.id = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01001974 status = psa_crypto_save_transaction();
1975 if (status != PSA_SUCCESS) {
1976 (void) psa_crypto_stop_transaction();
1977 return status;
Steven Cooremanbbeaf182020-06-08 18:29:44 +02001978 }
Gilles Peskine66be51c2019-07-25 18:02:52 +02001979 }
Ronald Cronea0f8a62020-11-25 17:52:23 +01001980
1981 status = psa_copy_key_material_into_slot(
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 slot, (uint8_t *) (&slot_number), sizeof(slot_number));
Darryl Green0c6575a2018-11-07 16:05:30 +00001983 }
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001984
Gilles Peskine449bd832023-01-11 14:50:10 +01001985 if (*p_drv == NULL && method == PSA_KEY_CREATION_REGISTER) {
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001986 /* Key registration only makes sense with a secure element. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001987 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine3efcebb2019-10-01 14:18:35 +02001988 }
Gilles Peskinecbaff462019-07-12 23:46:04 +02001989#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
1990
Ryan Everett975d4112023-11-16 13:37:51 +00001991 slot->status = PSA_SLOT_OCCUPIED;
1992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993 return PSA_SUCCESS;
Darryl Green0c6575a2018-11-07 16:05:30 +00001994}
Gilles Peskine4747d192019-04-17 15:05:45 +02001995
1996/** Finalize the creation of a key once its key material has been set.
1997 *
1998 * This entails writing the key to persistent storage.
1999 *
2000 * If this function fails, call psa_fail_key_creation().
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002001 * See the documentation of psa_start_key_creation() for the intended use
2002 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002003 *
Ronald Cron5c522922020-11-14 16:35:34 +01002004 * If the finalization succeeds, the function unlocks the key slot (it was
2005 * locked by psa_start_key_creation()) and the key slot cannot be accessed
2006 * anymore as part of the key creation process.
Ronald Cron50972942020-11-14 11:28:25 +01002007 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002008 * \param[in,out] slot Pointer to the slot with key material.
2009 * \param[in] driver The secure element driver for the key,
2010 * or NULL for a transparent key.
Ronald Cron81709fc2020-11-14 12:10:32 +01002011 * \param[out] key On success, identifier of the key. Note that the
2012 * key identifier is also stored in the key slot.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002013 *
2014 * \retval #PSA_SUCCESS
Ronald Croncf56a0a2020-08-04 09:51:30 +02002015 * The key was successfully created.
Gilles Peskineed733552023-02-14 19:21:09 +01002016 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
2017 * \retval #PSA_ERROR_INSUFFICIENT_STORAGE \emptydescription
2018 * \retval #PSA_ERROR_ALREADY_EXISTS \emptydescription
2019 * \retval #PSA_ERROR_DATA_INVALID \emptydescription
2020 * \retval #PSA_ERROR_DATA_CORRUPT \emptydescription
2021 * \retval #PSA_ERROR_STORAGE_FAILURE \emptydescription
gabor-mezei-arm452b0a32020-11-09 17:42:55 +01002022 *
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002023 * \return If this function fails, the key slot is an invalid state.
2024 * You must call psa_fail_key_creation() to wipe and free the slot.
Gilles Peskine4747d192019-04-17 15:05:45 +02002025 */
Gilles Peskine011e4282019-06-26 18:34:38 +02002026static psa_status_t psa_finish_key_creation(
2027 psa_key_slot_t *slot,
Ronald Cron81709fc2020-11-14 12:10:32 +01002028 psa_se_drv_table_entry_t *driver,
2029 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002030{
2031 psa_status_t status = PSA_SUCCESS;
Gilles Peskine30afafd2019-04-25 13:47:40 +02002032 (void) slot;
Gilles Peskine011e4282019-06-26 18:34:38 +02002033 (void) driver;
Gilles Peskine4747d192019-04-17 15:05:45 +02002034
2035#if defined(MBEDTLS_PSA_CRYPTO_STORAGE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 if (!PSA_KEY_LIFETIME_IS_VOLATILE(slot->attr.lifetime)) {
Gilles Peskine1df83d42019-07-23 16:13:14 +02002037#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 if (driver != NULL) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002039 psa_se_key_data_storage_t data;
Ronald Cronea0f8a62020-11-25 17:52:23 +01002040 psa_key_slot_number_t slot_number =
Gilles Peskine449bd832023-01-11 14:50:10 +01002041 psa_key_slot_get_slot_number(slot);
Ronald Cronea0f8a62020-11-25 17:52:23 +01002042
Tom Cosgrove6ef9bb32023-03-08 14:19:51 +00002043 MBEDTLS_STATIC_ASSERT(sizeof(slot_number) ==
2044 sizeof(data.slot_number),
2045 "Slot number size does not match psa_se_key_data_storage_t");
2046
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 memcpy(&data.slot_number, &slot_number, sizeof(slot_number));
2048 status = psa_save_persistent_key(&slot->attr,
2049 (uint8_t *) &data,
2050 sizeof(data));
2051 } else
Gilles Peskine1df83d42019-07-23 16:13:14 +02002052#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2053 {
Steven Cooreman40120f62020-10-29 11:42:22 +01002054 /* Key material is saved in export representation in the slot, so
2055 * just pass the slot buffer for storage. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002056 status = psa_save_persistent_key(&slot->attr,
2057 slot->key.data,
2058 slot->key.bytes);
Gilles Peskine1df83d42019-07-23 16:13:14 +02002059 }
Gilles Peskine4747d192019-04-17 15:05:45 +02002060 }
Darryl Green0c6575a2018-11-07 16:05:30 +00002061#endif /* defined(MBEDTLS_PSA_CRYPTO_STORAGE_C) */
2062
Gilles Peskinecbaff462019-07-12 23:46:04 +02002063#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskined7729582019-08-05 15:55:54 +02002064 /* Finish the transaction for a key creation. This does not
2065 * happen when registering an existing key. Detect this case
2066 * by checking whether a transaction is in progress (actual
Steven Cooremanbbeaf182020-06-08 18:29:44 +02002067 * creation of a persistent key in a secure element requires a transaction,
2068 * but registration or volatile key creation doesn't use one). */
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 if (driver != NULL &&
2070 psa_crypto_transaction.unknown.type == PSA_CRYPTO_TRANSACTION_CREATE_KEY) {
2071 status = psa_save_se_persistent_data(driver);
2072 if (status != PSA_SUCCESS) {
2073 psa_destroy_persistent_key(slot->attr.id);
2074 return status;
Gilles Peskinecbaff462019-07-12 23:46:04 +02002075 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 status = psa_crypto_stop_transaction();
Gilles Peskinecbaff462019-07-12 23:46:04 +02002077 }
2078#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2079
Gilles Peskine449bd832023-01-11 14:50:10 +01002080 if (status == PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01002081 *key = slot->attr.id;
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 status = psa_unlock_key_slot(slot);
2083 if (status != PSA_SUCCESS) {
Ronald Cron81709fc2020-11-14 12:10:32 +01002084 *key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 }
Ronald Cron81709fc2020-11-14 12:10:32 +01002086 }
Ronald Cron50972942020-11-14 11:28:25 +01002087
Gilles Peskine449bd832023-01-11 14:50:10 +01002088 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002089}
2090
2091/** Abort the creation of a key.
2092 *
2093 * You may call this function after calling psa_start_key_creation(),
2094 * or after psa_finish_key_creation() fails. In other circumstances, this
2095 * function may not clean up persistent storage.
Gilles Peskine9bc88c62019-04-28 11:37:03 +02002096 * See the documentation of psa_start_key_creation() for the intended use
2097 * of this function.
Gilles Peskine4747d192019-04-17 15:05:45 +02002098 *
Gilles Peskine011e4282019-06-26 18:34:38 +02002099 * \param[in,out] slot Pointer to the slot with key material.
2100 * \param[in] driver The secure element driver for the key,
2101 * or NULL for a transparent key.
Gilles Peskine4747d192019-04-17 15:05:45 +02002102 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002103static void psa_fail_key_creation(psa_key_slot_t *slot,
2104 psa_se_drv_table_entry_t *driver)
Gilles Peskine4747d192019-04-17 15:05:45 +02002105{
Gilles Peskine011e4282019-06-26 18:34:38 +02002106 (void) driver;
2107
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 if (slot == NULL) {
Gilles Peskine4747d192019-04-17 15:05:45 +02002109 return;
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 }
Gilles Peskine011e4282019-06-26 18:34:38 +02002111
2112#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Janos Follath1d57a202019-08-13 12:15:34 +01002113 /* TODO: If the key has already been created in the secure
Gilles Peskine011e4282019-06-26 18:34:38 +02002114 * element, and the failure happened later (when saving metadata
2115 * to internal storage), we need to destroy the key in the secure
Gilles Peskinec9d7f942019-08-13 16:17:16 +02002116 * element.
2117 * https://github.com/ARMmbed/mbed-crypto/issues/217
2118 */
Gilles Peskinefc762652019-07-22 19:30:34 +02002119
Gilles Peskined7729582019-08-05 15:55:54 +02002120 /* Abort the ongoing transaction if any (there may not be one if
2121 * the creation process failed before starting one, or if the
2122 * key creation is a registration of a key in a secure element).
2123 * Earlier functions must already have done what it takes to undo any
2124 * partial creation. All that's left is to update the transaction data
2125 * itself. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 (void) psa_crypto_stop_transaction();
Gilles Peskine011e4282019-06-26 18:34:38 +02002127#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2128
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 psa_wipe_key_slot(slot);
Gilles Peskine4747d192019-04-17 15:05:45 +02002130}
2131
Gilles Peskine1b8594a2019-07-31 17:21:46 +02002132/** Validate optional attributes during key creation.
2133 *
2134 * Some key attributes are optional during key creation. If they are
2135 * specified in the attributes structure, check that they are consistent
2136 * with the data in the slot.
2137 *
2138 * This function should be called near the end of key creation, after
2139 * the slot in memory is fully populated but before saving persistent data.
2140 */
2141static psa_status_t psa_validate_optional_attributes(
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002142 const psa_key_slot_t *slot,
Gilles Peskine449bd832023-01-11 14:50:10 +01002143 const psa_key_attributes_t *attributes)
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002144{
Gilles Peskine449bd832023-01-11 14:50:10 +01002145 if (attributes->core.type != 0) {
2146 if (attributes->core.type != slot->attr.type) {
2147 return PSA_ERROR_INVALID_ARGUMENT;
2148 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002149 }
2150
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 if (attributes->domain_parameters_size != 0) {
Valerio Settib2bcedb2023-07-10 11:24:00 +02002152#if (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) && \
2153 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01002154 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY)
2155 if (PSA_KEY_TYPE_IS_RSA(slot->attr.type)) {
Steven Cooremana2371e52020-07-28 14:30:39 +02002156 mbedtls_rsa_context *rsa = NULL;
Steven Cooreman75b74362020-07-28 14:30:13 +02002157 mbedtls_mpi actual, required;
Steven Cooreman6d839f02020-07-30 11:36:45 +02002158 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Steven Cooremana01795d2020-07-24 22:48:15 +02002159
Ronald Cron90857082020-11-25 14:58:33 +01002160 psa_status_t status = mbedtls_psa_rsa_load_representation(
Gilles Peskine449bd832023-01-11 14:50:10 +01002161 slot->attr.type,
2162 slot->key.data,
2163 slot->key.bytes,
2164 &rsa);
2165 if (status != PSA_SUCCESS) {
2166 return status;
2167 }
Steven Cooreman75b74362020-07-28 14:30:13 +02002168
Gilles Peskine449bd832023-01-11 14:50:10 +01002169 mbedtls_mpi_init(&actual);
2170 mbedtls_mpi_init(&required);
2171 ret = mbedtls_rsa_export(rsa,
2172 NULL, NULL, NULL, NULL, &actual);
2173 mbedtls_rsa_free(rsa);
2174 mbedtls_free(rsa);
2175 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002176 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 }
2178 ret = mbedtls_mpi_read_binary(&required,
2179 attributes->domain_parameters,
2180 attributes->domain_parameters_size);
2181 if (ret != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002182 goto rsa_exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002183 }
2184 if (mbedtls_mpi_cmp_mpi(&actual, &required) != 0) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002185 ret = MBEDTLS_ERR_RSA_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +01002186 }
2187rsa_exit:
2188 mbedtls_mpi_free(&actual);
2189 mbedtls_mpi_free(&required);
2190 if (ret != 0) {
2191 return mbedtls_to_psa_error(ret);
2192 }
2193 } else
Valerio Settib2bcedb2023-07-10 11:24:00 +02002194#endif /* (defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_IMPORT) &&
2195 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_EXPORT)) ||
John Durkop9814fa22020-11-04 12:28:15 -08002196 * defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_PUBLIC_KEY) */
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002197 {
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002199 }
2200 }
2201
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 if (attributes->core.bits != 0) {
2203 if (attributes->core.bits != slot->attr.bits) {
2204 return PSA_ERROR_INVALID_ARGUMENT;
2205 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002206 }
2207
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 return PSA_SUCCESS;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002209}
2210
Gilles Peskine449bd832023-01-11 14:50:10 +01002211psa_status_t psa_import_key(const psa_key_attributes_t *attributes,
Ryan Everettf028fe12024-01-08 17:14:44 +00002212 const uint8_t *data_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01002213 size_t data_length,
2214 mbedtls_svc_key_id_t *key)
Gilles Peskine4747d192019-04-17 15:05:45 +02002215{
2216 psa_status_t status;
Ryan Everettf028fe12024-01-08 17:14:44 +00002217 LOCAL_INPUT_DECLARE(data_external, data);
Gilles Peskine4747d192019-04-17 15:05:45 +02002218 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002219 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002220 size_t bits;
Archanad8a83dc2021-06-14 10:04:16 +05302221 size_t storage_size = data_length;
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002222
Ronald Cron81709fc2020-11-14 12:10:32 +01002223 *key = MBEDTLS_SVC_KEY_ID_INIT;
2224
Gilles Peskine0f84d622019-09-12 19:03:13 +02002225 /* Reject zero-length symmetric keys (including raw data key objects).
2226 * This also rejects any key which might be encoded as an empty string,
2227 * which is never valid. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002228 if (data_length == 0) {
2229 return PSA_ERROR_INVALID_ARGUMENT;
2230 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02002231
Archana449608b2021-09-08 15:36:05 +05302232 /* Ensure that the bytes-to-bits conversion cannot overflow. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002233 if (data_length > SIZE_MAX / 8) {
2234 return PSA_ERROR_NOT_SUPPORTED;
2235 }
Archana6ed4bda2021-08-04 10:47:15 +05302236
Ryan Everettf028fe12024-01-08 17:14:44 +00002237 LOCAL_INPUT_ALLOC(data_external, data_length, data);
2238
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 status = psa_start_key_creation(PSA_KEY_CREATION_IMPORT, attributes,
2240 &slot, &driver);
2241 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002242 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002244
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002245 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05302246 * storage ( thus not in the case of importing a key in a secure element
2247 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
2248 * buffer to hold the imported key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002249 if (slot->key.data == NULL) {
2250 if (psa_key_lifetime_is_external(attributes->core.lifetime)) {
Archana449608b2021-09-08 15:36:05 +05302251 status = psa_driver_wrapper_get_key_buffer_size_from_key_data(
Gilles Peskine449bd832023-01-11 14:50:10 +01002252 attributes, data, data_length, &storage_size);
2253 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05302254 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002255 }
Archanad8a83dc2021-06-14 10:04:16 +05302256 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002257 status = psa_allocate_buffer_to_slot(slot, storage_size);
2258 if (status != PSA_SUCCESS) {
Gilles Peskineb46bef22019-07-30 21:32:04 +02002259 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002260 }
Gilles Peskine5d309672019-07-12 23:47:28 +02002261 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002262
2263 bits = slot->attr.bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002264 status = psa_driver_wrapper_import_key(attributes,
2265 data, data_length,
2266 slot->key.data,
2267 slot->key.bytes,
2268 &slot->key.bytes, &bits);
2269 if (status != PSA_SUCCESS) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002270 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 }
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002272
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 if (slot->attr.bits == 0) {
Ronald Cronfb2ed5b2020-11-30 12:11:01 +01002274 slot->attr.bits = (psa_key_bits_t) bits;
Gilles Peskine449bd832023-01-11 14:50:10 +01002275 } else if (bits != slot->attr.bits) {
Steven Cooremanac3434f2021-01-15 17:36:02 +01002276 status = PSA_ERROR_INVALID_ARGUMENT;
2277 goto exit;
Gilles Peskine5d309672019-07-12 23:47:28 +02002278 }
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01002279
Archana6ed4bda2021-08-04 10:47:15 +05302280 /* Enforce a size limit, and in particular ensure that the bit
2281 * size fits in its representation type.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 if (bits > PSA_MAX_KEY_BITS) {
Archana6ed4bda2021-08-04 10:47:15 +05302283 status = PSA_ERROR_NOT_SUPPORTED;
2284 goto exit;
2285 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002286 status = psa_validate_optional_attributes(slot, attributes);
2287 if (status != PSA_SUCCESS) {
Gilles Peskine18017402019-07-24 20:25:59 +02002288 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002289 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002290
Gilles Peskine449bd832023-01-11 14:50:10 +01002291 status = psa_finish_key_creation(slot, driver, key);
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002292exit:
Ryan Everettf028fe12024-01-08 17:14:44 +00002293 LOCAL_INPUT_FREE(data_external, data);
Gilles Peskine449bd832023-01-11 14:50:10 +01002294 if (status != PSA_SUCCESS) {
2295 psa_fail_key_creation(slot, driver);
2296 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002297
Gilles Peskine449bd832023-01-11 14:50:10 +01002298 return status;
Gilles Peskine4747d192019-04-17 15:05:45 +02002299}
2300
Gilles Peskined7729582019-08-05 15:55:54 +02002301#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
2302psa_status_t mbedtls_psa_register_se_key(
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 const psa_key_attributes_t *attributes)
Gilles Peskined7729582019-08-05 15:55:54 +02002304{
2305 psa_status_t status;
2306 psa_key_slot_t *slot = NULL;
2307 psa_se_drv_table_entry_t *driver = NULL;
Ronald Croncf56a0a2020-08-04 09:51:30 +02002308 mbedtls_svc_key_id_t key = MBEDTLS_SVC_KEY_ID_INIT;
Gilles Peskined7729582019-08-05 15:55:54 +02002309
2310 /* Leaving attributes unspecified is not currently supported.
2311 * It could make sense to query the key type and size from the
2312 * secure element, but not all secure elements support this
2313 * and the driver HAL doesn't currently support it. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 if (psa_get_key_type(attributes) == PSA_KEY_TYPE_NONE) {
2315 return PSA_ERROR_NOT_SUPPORTED;
2316 }
2317 if (psa_get_key_bits(attributes) == 0) {
2318 return PSA_ERROR_NOT_SUPPORTED;
2319 }
Gilles Peskined7729582019-08-05 15:55:54 +02002320
Gilles Peskine449bd832023-01-11 14:50:10 +01002321 status = psa_start_key_creation(PSA_KEY_CREATION_REGISTER, attributes,
2322 &slot, &driver);
2323 if (status != PSA_SUCCESS) {
Gilles Peskined7729582019-08-05 15:55:54 +02002324 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002325 }
Gilles Peskined7729582019-08-05 15:55:54 +02002326
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 status = psa_finish_key_creation(slot, driver, &key);
Gilles Peskined7729582019-08-05 15:55:54 +02002328
2329exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002330 if (status != PSA_SUCCESS) {
2331 psa_fail_key_creation(slot, driver);
2332 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002333
Gilles Peskined7729582019-08-05 15:55:54 +02002334 /* Registration doesn't keep the key in RAM. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002335 psa_close_key(key);
2336 return status;
Gilles Peskined7729582019-08-05 15:55:54 +02002337}
2338#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
2339
Gilles Peskine449bd832023-01-11 14:50:10 +01002340psa_status_t psa_copy_key(mbedtls_svc_key_id_t source_key,
2341 const psa_key_attributes_t *specified_attributes,
2342 mbedtls_svc_key_id_t *target_key)
Gilles Peskinef603c712019-01-19 13:40:11 +01002343{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002344 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01002345 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinef603c712019-01-19 13:40:11 +01002346 psa_key_slot_t *source_slot = NULL;
2347 psa_key_slot_t *target_slot = NULL;
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002348 psa_key_attributes_t actual_attributes = *specified_attributes;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02002349 psa_se_drv_table_entry_t *driver = NULL;
Archana8a180362021-07-05 02:18:48 +05302350 size_t storage_size = 0;
Gilles Peskinef603c712019-01-19 13:40:11 +01002351
Ronald Cron81709fc2020-11-14 12:10:32 +01002352 *target_key = MBEDTLS_SVC_KEY_ID_INIT;
2353
Archana8a180362021-07-05 02:18:48 +05302354 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002355 source_key, &source_slot, PSA_KEY_USAGE_COPY, 0);
2356 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002357 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002359
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 status = psa_validate_optional_attributes(source_slot,
2361 specified_attributes);
2362 if (status != PSA_SUCCESS) {
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002363 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002364 }
Gilles Peskine4ce2a9d2019-05-03 16:57:15 +02002365
Archana9d17bf42021-09-10 06:22:44 +05302366 /* The target key type and number of bits have been validated by
2367 * psa_validate_optional_attributes() to be either equal to zero or
2368 * equal to the ones of the source key. So it is safe to inherit
2369 * them from the source key now."
Archana374fe5b2021-09-08 15:50:28 +05302370 * */
Archana9d17bf42021-09-10 06:22:44 +05302371 actual_attributes.core.bits = source_slot->attr.bits;
2372 actual_attributes.core.type = source_slot->attr.type;
Archana374fe5b2021-09-08 15:50:28 +05302373
2374
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 status = psa_restrict_key_policy(source_slot->attr.type,
2376 &actual_attributes.core.policy,
2377 &source_slot->attr.policy);
2378 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002379 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002380 }
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002381
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 status = psa_start_key_creation(PSA_KEY_CREATION_COPY, &actual_attributes,
2383 &target_slot, &driver);
2384 if (status != PSA_SUCCESS) {
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002385 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 }
2387 if (PSA_KEY_LIFETIME_GET_LOCATION(target_slot->attr.lifetime) !=
2388 PSA_KEY_LIFETIME_GET_LOCATION(source_slot->attr.lifetime)) {
Archana8a180362021-07-05 02:18:48 +05302389 /*
Archana9d17bf42021-09-10 06:22:44 +05302390 * If the source and target keys are stored in different locations,
Archana8a180362021-07-05 02:18:48 +05302391 * the source key would need to be exported as plaintext and re-imported
2392 * in the other location. This has security implications which have not
Archana449608b2021-09-08 15:36:05 +05302393 * been fully mapped. For now, this can be achieved through
Archana8a180362021-07-05 02:18:48 +05302394 * appropriate API invocations from the application, if needed.
2395 * */
Gilles Peskinef4ee6622019-07-24 13:44:30 +02002396 status = PSA_ERROR_NOT_SUPPORTED;
2397 goto exit;
Gilles Peskinef603c712019-01-19 13:40:11 +01002398 }
Archana8a180362021-07-05 02:18:48 +05302399 /*
2400 * When the source and target keys are within the same location,
Archana449608b2021-09-08 15:36:05 +05302401 * - For transparent keys it is a blind copy without any driver invocation,
Archana8a180362021-07-05 02:18:48 +05302402 * - For opaque keys this translates to an invocation of the drivers'
2403 * copy_key entry point through the dispatch layer.
2404 * */
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 if (psa_key_lifetime_is_external(actual_attributes.core.lifetime)) {
2406 status = psa_driver_wrapper_get_key_buffer_size(&actual_attributes,
2407 &storage_size);
2408 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302409 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002410 }
Archana374fe5b2021-09-08 15:50:28 +05302411
Gilles Peskine449bd832023-01-11 14:50:10 +01002412 status = psa_allocate_buffer_to_slot(target_slot, storage_size);
2413 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302414 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 }
Archana374fe5b2021-09-08 15:50:28 +05302416
Gilles Peskine449bd832023-01-11 14:50:10 +01002417 status = psa_driver_wrapper_copy_key(&actual_attributes,
2418 source_slot->key.data,
2419 source_slot->key.bytes,
2420 target_slot->key.data,
2421 target_slot->key.bytes,
2422 &target_slot->key.bytes);
2423 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302424 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002425 }
2426 } else {
2427 status = psa_copy_key_material_into_slot(target_slot,
Archana9d17bf42021-09-10 06:22:44 +05302428 source_slot->key.data,
Gilles Peskine449bd832023-01-11 14:50:10 +01002429 source_slot->key.bytes);
2430 if (status != PSA_SUCCESS) {
Archana8a180362021-07-05 02:18:48 +05302431 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 }
Archana8a180362021-07-05 02:18:48 +05302433 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 status = psa_finish_key_creation(target_slot, driver, target_key);
Gilles Peskine8c8f2ab2019-04-18 21:44:46 +02002435exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 if (status != PSA_SUCCESS) {
2437 psa_fail_key_creation(target_slot, driver);
2438 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002439
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 unlock_status = psa_unlock_key_slot(source_slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002441
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskinef603c712019-01-19 13:40:11 +01002443}
2444
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02002445
2446
Gilles Peskine2f9c4dc2018-01-28 13:16:24 +01002447/****************************************************************/
Gilles Peskine20035e32018-02-03 22:44:14 +01002448/* Message digests */
2449/****************************************************************/
2450
Gilles Peskine449bd832023-01-11 14:50:10 +01002451psa_status_t psa_hash_abort(psa_hash_operation_t *operation)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002452{
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002453 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002454 if (operation->id == 0) {
2455 return PSA_SUCCESS;
2456 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002457
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 psa_status_t status = psa_driver_wrapper_hash_abort(operation);
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002459 operation->id = 0;
2460
Gilles Peskine449bd832023-01-11 14:50:10 +01002461 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002462}
2463
Gilles Peskine449bd832023-01-11 14:50:10 +01002464psa_status_t psa_hash_setup(psa_hash_operation_t *operation,
2465 psa_algorithm_t alg)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002466{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002467 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002468
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002469 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002470 if (operation->id != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002471 status = PSA_ERROR_BAD_STATE;
2472 goto exit;
2473 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002474
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 if (!PSA_ALG_IS_HASH(alg)) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002476 status = PSA_ERROR_INVALID_ARGUMENT;
2477 goto exit;
2478 }
Jaeden Amero36ee5d02019-02-19 09:25:10 +00002479
Steven Cooremanb6bf4bb2021-03-15 19:00:14 +01002480 /* Ensure all of the context is zeroized, since PSA_HASH_OPERATION_INIT only
2481 * directly zeroes the int-sized dummy member of the context union. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002482 memset(&operation->ctx, 0, sizeof(operation->ctx));
Steven Cooreman893232f2021-03-15 12:23:37 +01002483
Gilles Peskine449bd832023-01-11 14:50:10 +01002484 status = psa_driver_wrapper_hash_setup(operation, alg);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002485
2486exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002487 if (status != PSA_SUCCESS) {
2488 psa_hash_abort(operation);
2489 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002490
2491 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002492}
2493
Gilles Peskine449bd832023-01-11 14:50:10 +01002494psa_status_t psa_hash_update(psa_hash_operation_t *operation,
2495 const uint8_t *input,
2496 size_t input_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002497{
Dave Rodgman685b6a72021-06-24 11:49:14 +01002498 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2499
Gilles Peskine449bd832023-01-11 14:50:10 +01002500 if (operation->id == 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002501 status = PSA_ERROR_BAD_STATE;
2502 goto exit;
2503 }
Gilles Peskine94e44542018-07-12 16:58:43 +02002504
Steven Cooremanc8288352021-03-04 14:02:19 +01002505 /* Don't require hash implementations to behave correctly on a
2506 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002507 if (input_length == 0) {
2508 return PSA_SUCCESS;
2509 }
Steven Cooremanc8288352021-03-04 14:02:19 +01002510
Gilles Peskine449bd832023-01-11 14:50:10 +01002511 status = psa_driver_wrapper_hash_update(operation, input, input_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002512
2513exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 if (status != PSA_SUCCESS) {
2515 psa_hash_abort(operation);
2516 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002517
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002519}
2520
Gilles Peskine449bd832023-01-11 14:50:10 +01002521psa_status_t psa_hash_finish(psa_hash_operation_t *operation,
2522 uint8_t *hash,
2523 size_t hash_size,
2524 size_t *hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002525{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002526 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002527 if (operation->id == 0) {
2528 return PSA_ERROR_BAD_STATE;
2529 }
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002530
Steven Cooreman1e582352021-02-18 17:24:37 +01002531 psa_status_t status = psa_driver_wrapper_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002532 operation, hash, hash_size, hash_length);
2533 psa_hash_abort(operation);
2534 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002535}
2536
Gilles Peskine449bd832023-01-11 14:50:10 +01002537psa_status_t psa_hash_verify(psa_hash_operation_t *operation,
2538 const uint8_t *hash,
2539 size_t hash_length)
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002540{
Ronald Cron69a63422021-10-18 09:47:58 +02002541 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002542 size_t actual_hash_length;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002543 psa_status_t status = psa_hash_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01002544 operation,
2545 actual_hash, sizeof(actual_hash),
2546 &actual_hash_length);
Dave Rodgman685b6a72021-06-24 11:49:14 +01002547
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002549 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002551
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 if (actual_hash_length != hash_length) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002553 status = PSA_ERROR_INVALID_SIGNATURE;
2554 goto exit;
2555 }
2556
Dave Rodgman78701152023-08-29 14:20:18 +01002557 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002558 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002559 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002560
2561exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002562 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2563 if (status != PSA_SUCCESS) {
Dave Rodgman685b6a72021-06-24 11:49:14 +01002564 psa_hash_abort(operation);
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 }
Dave Rodgman685b6a72021-06-24 11:49:14 +01002566
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 return status;
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002568}
2569
Gilles Peskine449bd832023-01-11 14:50:10 +01002570psa_status_t psa_hash_compute(psa_algorithm_t alg,
2571 const uint8_t *input, size_t input_length,
2572 uint8_t *hash, size_t hash_size,
2573 size_t *hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002574{
Steven Cooremanfbe09282021-03-08 18:41:12 +01002575 *hash_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002576 if (!PSA_ALG_IS_HASH(alg)) {
2577 return PSA_ERROR_INVALID_ARGUMENT;
2578 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002579
Gilles Peskine449bd832023-01-11 14:50:10 +01002580 return psa_driver_wrapper_hash_compute(alg, input, input_length,
2581 hash, hash_size, hash_length);
Gilles Peskine0a749c82019-11-28 19:33:58 +01002582}
2583
Gilles Peskine449bd832023-01-11 14:50:10 +01002584psa_status_t psa_hash_compare(psa_algorithm_t alg,
2585 const uint8_t *input, size_t input_length,
2586 const uint8_t *hash, size_t hash_length)
Gilles Peskine0a749c82019-11-28 19:33:58 +01002587{
Ronald Cron69a63422021-10-18 09:47:58 +02002588 uint8_t actual_hash[PSA_HASH_MAX_SIZE];
Steven Cooreman84d670d2021-02-18 16:22:53 +01002589 size_t actual_hash_length;
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002590
Gilles Peskine449bd832023-01-11 14:50:10 +01002591 if (!PSA_ALG_IS_HASH(alg)) {
2592 return PSA_ERROR_INVALID_ARGUMENT;
2593 }
Steven Cooremanf66d5fd2021-03-08 18:40:40 +01002594
Steven Cooreman1e582352021-02-18 17:24:37 +01002595 psa_status_t status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002596 alg, input, input_length,
2597 actual_hash, sizeof(actual_hash),
2598 &actual_hash_length);
2599 if (status != PSA_SUCCESS) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002600 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 }
2602 if (actual_hash_length != hash_length) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002603 status = PSA_ERROR_INVALID_SIGNATURE;
2604 goto exit;
2605 }
Dave Rodgman78701152023-08-29 14:20:18 +01002606 if (mbedtls_ct_memcmp(hash, actual_hash, actual_hash_length) != 0) {
Gilles Peskine60aebec2021-12-13 12:33:18 +01002607 status = PSA_ERROR_INVALID_SIGNATURE;
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 }
Gilles Peskine60aebec2021-12-13 12:33:18 +01002609
2610exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002611 mbedtls_platform_zeroize(actual_hash, sizeof(actual_hash));
2612 return status;
Gilles Peskine0a749c82019-11-28 19:33:58 +01002613}
2614
Gilles Peskine449bd832023-01-11 14:50:10 +01002615psa_status_t psa_hash_clone(const psa_hash_operation_t *source_operation,
2616 psa_hash_operation_t *target_operation)
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002617{
Gilles Peskine449bd832023-01-11 14:50:10 +01002618 if (source_operation->id == 0 ||
2619 target_operation->id != 0) {
2620 return PSA_ERROR_BAD_STATE;
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002621 }
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002622
Gilles Peskine449bd832023-01-11 14:50:10 +01002623 psa_status_t status = psa_driver_wrapper_hash_clone(source_operation,
2624 target_operation);
2625 if (status != PSA_SUCCESS) {
2626 psa_hash_abort(target_operation);
2627 }
Steven Cooremandbf8ced2021-03-04 13:01:18 +01002628
Gilles Peskine449bd832023-01-11 14:50:10 +01002629 return status;
Gilles Peskineebb2c3e2019-01-19 12:03:41 +01002630}
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002631
2632
Gilles Peskine9ef733f2018-02-07 21:05:37 +01002633/****************************************************************/
Gilles Peskine8c9def32018-02-08 10:02:12 +01002634/* MAC */
2635/****************************************************************/
2636
Gilles Peskine449bd832023-01-11 14:50:10 +01002637psa_status_t psa_mac_abort(psa_mac_operation_t *operation)
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002638{
Steven Cooremane6804192021-03-19 18:28:56 +01002639 /* Aborting a non-active operation is allowed */
Gilles Peskine449bd832023-01-11 14:50:10 +01002640 if (operation->id == 0) {
2641 return PSA_SUCCESS;
2642 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002643
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 psa_status_t status = psa_driver_wrapper_mac_abort(operation);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002645 operation->mac_size = 0;
2646 operation->is_sign = 0;
Steven Cooremane6804192021-03-19 18:28:56 +01002647 operation->id = 0;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002648
Gilles Peskine449bd832023-01-11 14:50:10 +01002649 return status;
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02002650}
2651
Ronald Cron2dff3b22021-06-17 16:33:22 +02002652static psa_status_t psa_mac_finalize_alg_and_key_validation(
2653 psa_algorithm_t alg,
Ronald Cron79bdd822021-06-17 16:46:44 +02002654 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01002655 uint8_t *mac_size)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002656{
Ronald Cronf95a2b12020-10-22 15:24:49 +02002657 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 psa_key_type_t key_type = psa_get_key_type(attributes);
2659 size_t key_bits = psa_get_key_bits(attributes);
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002660
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 if (!PSA_ALG_IS_MAC(alg)) {
2662 return PSA_ERROR_INVALID_ARGUMENT;
2663 }
Steven Cooremane6804192021-03-19 18:28:56 +01002664
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002665 /* Validate the combination of key type and algorithm */
Gilles Peskine449bd832023-01-11 14:50:10 +01002666 status = psa_mac_key_can_do(alg, key_type);
2667 if (status != PSA_SUCCESS) {
2668 return status;
2669 }
Steven Cooreman15472f82021-03-02 16:16:22 +01002670
Steven Cooremand1a68f12021-05-10 11:13:41 +02002671 /* Get the output length for the algorithm and key combination */
Gilles Peskine449bd832023-01-11 14:50:10 +01002672 *mac_size = PSA_MAC_LENGTH(key_type, key_bits, alg);
Steven Cooreman15472f82021-03-02 16:16:22 +01002673
Gilles Peskine449bd832023-01-11 14:50:10 +01002674 if (*mac_size < 4) {
Steven Cooreman15472f82021-03-02 16:16:22 +01002675 /* A very short MAC is too short for security since it can be
2676 * brute-forced. Ancient protocols with 32-bit MACs do exist,
2677 * so we make this our minimum, even though 32 bits is still
2678 * too small for security. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002679 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman15472f82021-03-02 16:16:22 +01002680 }
Gilles Peskineab1d7ab2018-07-06 16:07:47 +02002681
Gilles Peskine449bd832023-01-11 14:50:10 +01002682 if (*mac_size > PSA_MAC_LENGTH(key_type, key_bits,
2683 PSA_ALG_FULL_LENGTH_MAC(alg))) {
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002684 /* It's impossible to "truncate" to a larger length than the full length
2685 * of the algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002686 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanf9f7fdf2021-03-03 19:04:05 +01002687 }
2688
Gilles Peskine449bd832023-01-11 14:50:10 +01002689 if (*mac_size > PSA_MAC_MAX_SIZE) {
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002690 /* PSA_MAC_LENGTH returns the correct length even for a MAC algorithm
2691 * that is disabled in the compile-time configuration. The result can
2692 * therefore be larger than PSA_MAC_MAX_SIZE, which does take the
2693 * configuration into account. In this case, force a return of
2694 * PSA_ERROR_NOT_SUPPORTED here. Otherwise psa_mac_verify(), or
2695 * psa_mac_compute(mac_size=PSA_MAC_MAX_SIZE), would return
2696 * PSA_ERROR_BUFFER_TOO_SMALL for an unsupported algorithm whose MAC size
2697 * is larger than PSA_MAC_MAX_SIZE, which is misleading and which breaks
2698 * systematically generated tests. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002699 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskinea9b6c802022-03-16 13:54:49 +01002700 }
2701
Gilles Peskine449bd832023-01-11 14:50:10 +01002702 return PSA_SUCCESS;
Ronald Cron2dff3b22021-06-17 16:33:22 +02002703}
2704
Gilles Peskine449bd832023-01-11 14:50:10 +01002705static psa_status_t psa_mac_setup(psa_mac_operation_t *operation,
2706 mbedtls_svc_key_id_t key,
2707 psa_algorithm_t alg,
2708 int is_sign)
Gilles Peskinee59236f2018-01-27 23:32:46 +01002709{
2710 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2711 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01002712 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002713 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002714
2715 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002716 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01002717 status = PSA_ERROR_BAD_STATE;
2718 goto exit;
2719 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002720
2721 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002722 key,
2723 &slot,
2724 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2725 alg);
2726 if (status != PSA_SUCCESS) {
Dave Rodgman54648242021-06-24 11:49:45 +01002727 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002728 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002729
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002730 attributes = (psa_key_attributes_t) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002731 .core = slot->attr
2732 };
2733
Gilles Peskine449bd832023-01-11 14:50:10 +01002734 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2735 &operation->mac_size);
2736 if (status != PSA_SUCCESS) {
Gilles Peskine8c9def32018-02-08 10:02:12 +01002737 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002738 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002739
2740 operation->is_sign = is_sign;
Steven Cooremane6804192021-03-19 18:28:56 +01002741 /* Dispatch the MAC setup call with validated input */
Gilles Peskine449bd832023-01-11 14:50:10 +01002742 if (is_sign) {
2743 status = psa_driver_wrapper_mac_sign_setup(operation,
2744 &attributes,
2745 slot->key.data,
2746 slot->key.bytes,
2747 alg);
2748 } else {
2749 status = psa_driver_wrapper_mac_verify_setup(operation,
2750 &attributes,
2751 slot->key.data,
2752 slot->key.bytes,
2753 alg);
Gilles Peskine8c9def32018-02-08 10:02:12 +01002754 }
Gilles Peskine7e454bc2018-06-11 17:26:17 +02002755
Gilles Peskinefbfac682018-07-08 20:51:54 +02002756exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002757 if (status != PSA_SUCCESS) {
2758 psa_mac_abort(operation);
2759 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02002760
Gilles Peskine449bd832023-01-11 14:50:10 +01002761 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02002762
Gilles Peskine449bd832023-01-11 14:50:10 +01002763 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002764}
2765
Gilles Peskine449bd832023-01-11 14:50:10 +01002766psa_status_t psa_mac_sign_setup(psa_mac_operation_t *operation,
2767 mbedtls_svc_key_id_t key,
2768 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002769{
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 return psa_mac_setup(operation, key, alg, 1);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002771}
2772
Gilles Peskine449bd832023-01-11 14:50:10 +01002773psa_status_t psa_mac_verify_setup(psa_mac_operation_t *operation,
2774 mbedtls_svc_key_id_t key,
2775 psa_algorithm_t alg)
Gilles Peskine89167cb2018-07-08 20:12:23 +02002776{
Gilles Peskine449bd832023-01-11 14:50:10 +01002777 return psa_mac_setup(operation, key, alg, 0);
Gilles Peskine89167cb2018-07-08 20:12:23 +02002778}
2779
Gilles Peskine449bd832023-01-11 14:50:10 +01002780psa_status_t psa_mac_update(psa_mac_operation_t *operation,
2781 const uint8_t *input,
2782 size_t input_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002783{
Gilles Peskine449bd832023-01-11 14:50:10 +01002784 if (operation->id == 0) {
2785 return PSA_ERROR_BAD_STATE;
2786 }
Gilles Peskine8c9def32018-02-08 10:02:12 +01002787
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002788 /* Don't require hash implementations to behave correctly on a
2789 * zero-length input, which may have an invalid pointer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 if (input_length == 0) {
2791 return PSA_SUCCESS;
2792 }
Nir Sonnenscheindcd636a2018-06-04 16:03:32 +03002793
Gilles Peskine449bd832023-01-11 14:50:10 +01002794 psa_status_t status = psa_driver_wrapper_mac_update(operation,
2795 input, input_length);
2796 if (status != PSA_SUCCESS) {
2797 psa_mac_abort(operation);
2798 }
Steven Cooreman6e7f2912021-03-19 18:38:46 +01002799
Gilles Peskine449bd832023-01-11 14:50:10 +01002800 return status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002801}
2802
Gilles Peskine449bd832023-01-11 14:50:10 +01002803psa_status_t psa_mac_sign_finish(psa_mac_operation_t *operation,
2804 uint8_t *mac,
2805 size_t mac_size,
2806 size_t *mac_length)
mohammad16036df908f2018-04-02 08:34:15 -07002807{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002808 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2809 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002810
Gilles Peskine449bd832023-01-11 14:50:10 +01002811 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002812 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002813 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002814 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002815
Gilles Peskine449bd832023-01-11 14:50:10 +01002816 if (!operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002817 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002818 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002819 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002820
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002821 /* Sanity check. This will guarantee that mac_size != 0 (and so mac != NULL)
2822 * once all the error checks are done. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 if (operation->mac_size == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002824 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002825 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002826 }
Steven Cooreman8af5c5c2021-05-11 11:09:13 +02002827
Gilles Peskine449bd832023-01-11 14:50:10 +01002828 if (mac_size < operation->mac_size) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002829 status = PSA_ERROR_BUFFER_TOO_SMALL;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002830 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002831 }
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002832
Gilles Peskine449bd832023-01-11 14:50:10 +01002833 status = psa_driver_wrapper_mac_sign_finish(operation,
2834 mac, operation->mac_size,
2835 mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002836
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002837exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002838 /* In case of success, set the potential excess room in the output buffer
2839 * to an invalid value, to avoid potentially leaking a longer MAC.
2840 * In case of error, set the output length and content to a safe default,
2841 * such that in case the caller misses an error check, the output would be
2842 * an unachievable MAC.
2843 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002844 if (status != PSA_SUCCESS) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002845 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002846 operation->mac_size = 0;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002847 }
mohammad16036df908f2018-04-02 08:34:15 -07002848
Paul Elliottdc42ca82023-02-24 18:11:59 +00002849 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002850
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 abort_status = psa_mac_abort(operation);
Gilles Peskine5d0b8642018-07-08 20:35:02 +02002852
Gilles Peskine449bd832023-01-11 14:50:10 +01002853 return status == PSA_SUCCESS ? abort_status : status;
mohammad16036df908f2018-04-02 08:34:15 -07002854}
2855
Gilles Peskine449bd832023-01-11 14:50:10 +01002856psa_status_t psa_mac_verify_finish(psa_mac_operation_t *operation,
2857 const uint8_t *mac,
2858 size_t mac_length)
Gilles Peskine8c9def32018-02-08 10:02:12 +01002859{
Steven Cooremana5b860a2021-03-19 19:04:39 +01002860 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
2861 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Steven Cooreman77e2cc52021-03-19 17:05:52 +01002862
Gilles Peskine449bd832023-01-11 14:50:10 +01002863 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002864 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002865 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002866 }
Jaeden Amero252ef282019-02-15 14:05:35 +00002867
Gilles Peskine449bd832023-01-11 14:50:10 +01002868 if (operation->is_sign) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002869 status = PSA_ERROR_BAD_STATE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002870 goto exit;
Dave Rodgman38e62ae2021-06-23 11:38:39 +01002871 }
Steven Cooreman72f736a2021-05-07 14:14:37 +02002872
Gilles Peskine449bd832023-01-11 14:50:10 +01002873 if (operation->mac_size != mac_length) {
Steven Cooreman72f736a2021-05-07 14:14:37 +02002874 status = PSA_ERROR_INVALID_SIGNATURE;
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002875 goto exit;
Steven Cooreman72f736a2021-05-07 14:14:37 +02002876 }
2877
Gilles Peskine449bd832023-01-11 14:50:10 +01002878 status = psa_driver_wrapper_mac_verify_finish(operation,
2879 mac, mac_length);
Steven Cooreman72f736a2021-05-07 14:14:37 +02002880
Dave Rodgman90d1cb82021-06-25 09:09:02 +01002881exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002882 abort_status = psa_mac_abort(operation);
mohammad16036df908f2018-04-02 08:34:15 -07002883
Gilles Peskine449bd832023-01-11 14:50:10 +01002884 return status == PSA_SUCCESS ? abort_status : status;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002885}
2886
Gilles Peskine449bd832023-01-11 14:50:10 +01002887static psa_status_t psa_mac_compute_internal(mbedtls_svc_key_id_t key,
2888 psa_algorithm_t alg,
2889 const uint8_t *input,
2890 size_t input_length,
2891 uint8_t *mac,
2892 size_t mac_size,
2893 size_t *mac_length,
2894 int is_sign)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002895{
2896 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron51131b52021-06-17 17:17:20 +02002897 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
2898 psa_key_slot_t *slot;
2899 uint8_t operation_mac_size = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002900 psa_key_attributes_t attributes;
Gilles Peskine8c9def32018-02-08 10:02:12 +01002901
Ronald Cron51131b52021-06-17 17:17:20 +02002902 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01002903 key,
2904 &slot,
2905 is_sign ? PSA_KEY_USAGE_SIGN_MESSAGE : PSA_KEY_USAGE_VERIFY_MESSAGE,
2906 alg);
2907 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002908 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002909 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002910
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01002911 attributes = (psa_key_attributes_t) {
Ronald Cron51131b52021-06-17 17:17:20 +02002912 .core = slot->attr
2913 };
2914
Gilles Peskine449bd832023-01-11 14:50:10 +01002915 status = psa_mac_finalize_alg_and_key_validation(alg, &attributes,
2916 &operation_mac_size);
2917 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002918 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002920
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 if (mac_size < operation_mac_size) {
Ronald Cron51131b52021-06-17 17:17:20 +02002922 status = PSA_ERROR_BUFFER_TOO_SMALL;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002923 goto exit;
Ronald Cron51131b52021-06-17 17:17:20 +02002924 }
2925
2926 status = psa_driver_wrapper_mac_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01002927 &attributes,
2928 slot->key.data, slot->key.bytes,
2929 alg,
2930 input, input_length,
2931 mac, operation_mac_size, mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002932
2933exit:
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002934 /* In case of success, set the potential excess room in the output buffer
2935 * to an invalid value, to avoid potentially leaking a longer MAC.
2936 * In case of error, set the output length and content to a safe default,
2937 * such that in case the caller misses an error check, the output would be
2938 * an unachievable MAC.
2939 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002940 if (status != PSA_SUCCESS) {
Ronald Cron51131b52021-06-17 17:17:20 +02002941 *mac_length = mac_size;
Ronald Cronc3dd75f2021-06-18 13:05:48 +02002942 operation_mac_size = 0;
Ronald Cron51131b52021-06-17 17:17:20 +02002943 }
Paul Elliottdc42ca82023-02-24 18:11:59 +00002944
2945 psa_wipe_tag_output_buffer(mac, status, mac_size, *mac_length);
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002946
Gilles Peskine449bd832023-01-11 14:50:10 +01002947 unlock_status = psa_unlock_key_slot(slot);
Ronald Cron51131b52021-06-17 17:17:20 +02002948
Gilles Peskine449bd832023-01-11 14:50:10 +01002949 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002950}
2951
Gilles Peskine449bd832023-01-11 14:50:10 +01002952psa_status_t psa_mac_compute(mbedtls_svc_key_id_t key,
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002953 psa_algorithm_t alg,
2954 const uint8_t *input,
2955 size_t input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01002956 uint8_t *mac,
2957 size_t mac_size,
2958 size_t *mac_length)
2959{
2960 return psa_mac_compute_internal(key, alg,
2961 input, input_length,
2962 mac, mac_size, mac_length, 1);
2963}
2964
2965psa_status_t psa_mac_verify(mbedtls_svc_key_id_t key,
2966 psa_algorithm_t alg,
2967 const uint8_t *input,
2968 size_t input_length,
2969 const uint8_t *mac,
2970 size_t mac_length)
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002971{
2972 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Crona587cbc2021-06-18 14:51:29 +02002973 uint8_t actual_mac[PSA_MAC_MAX_SIZE];
2974 size_t actual_mac_length;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002975
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 status = psa_mac_compute_internal(key, alg,
2977 input, input_length,
2978 actual_mac, sizeof(actual_mac),
2979 &actual_mac_length, 0);
2980 if (status != PSA_SUCCESS) {
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002981 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01002982 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002983
Gilles Peskine449bd832023-01-11 14:50:10 +01002984 if (mac_length != actual_mac_length) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002985 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002986 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002987 }
Dave Rodgman78701152023-08-29 14:20:18 +01002988 if (mbedtls_ct_memcmp(mac, actual_mac, actual_mac_length) != 0) {
Ronald Crona587cbc2021-06-18 14:51:29 +02002989 status = PSA_ERROR_INVALID_SIGNATURE;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002990 goto exit;
Ronald Crona587cbc2021-06-18 14:51:29 +02002991 }
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002992
2993exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01002994 mbedtls_platform_zeroize(actual_mac, sizeof(actual_mac));
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002995
Gilles Peskine449bd832023-01-11 14:50:10 +01002996 return status;
gabor-mezei-arm4076d3e2021-03-01 15:34:18 +01002997}
Gilles Peskinee59236f2018-01-27 23:32:46 +01002998
Gilles Peskinee59236f2018-01-27 23:32:46 +01002999/****************************************************************/
3000/* Asymmetric cryptography */
3001/****************************************************************/
3002
Gilles Peskine449bd832023-01-11 14:50:10 +01003003static psa_status_t psa_sign_verify_check_alg(int input_is_message,
3004 psa_algorithm_t alg)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003005{
Gilles Peskine449bd832023-01-11 14:50:10 +01003006 if (input_is_message) {
3007 if (!PSA_ALG_IS_SIGN_MESSAGE(alg)) {
3008 return PSA_ERROR_INVALID_ARGUMENT;
3009 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003010
Gilles Peskine449bd832023-01-11 14:50:10 +01003011 if (PSA_ALG_IS_SIGN_HASH(alg)) {
3012 if (!PSA_ALG_IS_HASH(PSA_ALG_SIGN_GET_HASH(alg))) {
3013 return PSA_ERROR_INVALID_ARGUMENT;
3014 }
3015 }
3016 } else {
3017 if (!PSA_ALG_IS_SIGN_HASH(alg)) {
3018 return PSA_ERROR_INVALID_ARGUMENT;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003019 }
3020 }
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003021
Gilles Peskine449bd832023-01-11 14:50:10 +01003022 return PSA_SUCCESS;
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003023}
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003024
Gilles Peskine449bd832023-01-11 14:50:10 +01003025static psa_status_t psa_sign_internal(mbedtls_svc_key_id_t key,
3026 int input_is_message,
3027 psa_algorithm_t alg,
3028 const uint8_t *input,
3029 size_t input_length,
3030 uint8_t *signature,
3031 size_t signature_size,
3032 size_t *signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003033{
3034 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3035 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3036 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003037 psa_key_attributes_t attributes;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003038
3039 *signature_length = 0;
3040
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 status = psa_sign_verify_check_alg(input_is_message, alg);
3042 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003043 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003044 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003045
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003046 /* Immediately reject a zero-length signature buffer. This guarantees
gabor-mezei-arm12b4f342021-05-05 13:54:55 +02003047 * that signature must be a valid pointer. (On the other hand, the input
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003048 * buffer can in principle be empty since it doesn't actually have
3049 * to be a hash.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003050 if (signature_size == 0) {
3051 return PSA_ERROR_BUFFER_TOO_SMALL;
3052 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003053
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003054 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003055 key, &slot,
3056 input_is_message ? PSA_KEY_USAGE_SIGN_MESSAGE :
3057 PSA_KEY_USAGE_SIGN_HASH,
3058 alg);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003059
Gilles Peskine449bd832023-01-11 14:50:10 +01003060 if (status != PSA_SUCCESS) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003061 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01003062 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003063
Gilles Peskine449bd832023-01-11 14:50:10 +01003064 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003065 status = PSA_ERROR_INVALID_ARGUMENT;
3066 goto exit;
3067 }
3068
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003069 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003070 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003071 };
3072
Gilles Peskine449bd832023-01-11 14:50:10 +01003073 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003074 status = psa_driver_wrapper_sign_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003075 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003076 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003077 signature, signature_size, signature_length);
3078 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003079
3080 status = psa_driver_wrapper_sign_hash(
3081 &attributes, slot->key.data, slot->key.bytes,
3082 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003083 signature, signature_size, signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003084 }
3085
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003086
3087exit:
Paul Elliott59200a22023-02-21 15:07:40 +00003088 psa_wipe_tag_output_buffer(signature, status, signature_size,
3089 *signature_length);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003090
Gilles Peskine449bd832023-01-11 14:50:10 +01003091 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003092
Gilles Peskine449bd832023-01-11 14:50:10 +01003093 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003094}
3095
Gilles Peskine449bd832023-01-11 14:50:10 +01003096static psa_status_t psa_verify_internal(mbedtls_svc_key_id_t key,
3097 int input_is_message,
3098 psa_algorithm_t alg,
3099 const uint8_t *input,
3100 size_t input_length,
3101 const uint8_t *signature,
3102 size_t signature_length)
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003103{
3104 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3105 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3106 psa_key_slot_t *slot;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003107
Gilles Peskine449bd832023-01-11 14:50:10 +01003108 status = psa_sign_verify_check_alg(input_is_message, alg);
3109 if (status != PSA_SUCCESS) {
gabor-mezei-arm8b3e8862021-05-05 13:56:27 +02003110 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003111 }
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003112
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003113 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003114 key, &slot,
3115 input_is_message ? PSA_KEY_USAGE_VERIFY_MESSAGE :
3116 PSA_KEY_USAGE_VERIFY_HASH,
3117 alg);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003118
Gilles Peskine449bd832023-01-11 14:50:10 +01003119 if (status != PSA_SUCCESS) {
3120 return status;
3121 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003122
3123 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01003124 .core = slot->attr
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003125 };
3126
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 if (input_is_message) {
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003128 status = psa_driver_wrapper_verify_message(
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003129 &attributes, slot->key.data, slot->key.bytes,
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003130 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003131 signature, signature_length);
3132 } else {
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003133 status = psa_driver_wrapper_verify_hash(
3134 &attributes, slot->key.data, slot->key.bytes,
3135 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003136 signature, signature_length);
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003137 }
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003138
Gilles Peskine449bd832023-01-11 14:50:10 +01003139 unlock_status = psa_unlock_key_slot(slot);
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003140
Gilles Peskine449bd832023-01-11 14:50:10 +01003141 return (status == PSA_SUCCESS) ? unlock_status : status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003142
3143}
3144
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003145psa_status_t psa_sign_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003146 const psa_key_attributes_t *attributes,
3147 const uint8_t *key_buffer,
3148 size_t key_buffer_size,
3149 psa_algorithm_t alg,
3150 const uint8_t *input,
3151 size_t input_length,
3152 uint8_t *signature,
3153 size_t signature_size,
Gilles Peskine449bd832023-01-11 14:50:10 +01003154 size_t *signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003155{
3156 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003157
Gilles Peskine449bd832023-01-11 14:50:10 +01003158 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003159 size_t hash_length;
3160 uint8_t hash[PSA_HASH_MAX_SIZE];
3161
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003162 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003163 PSA_ALG_SIGN_GET_HASH(alg),
3164 input, input_length,
3165 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003166
Gilles Peskine449bd832023-01-11 14:50:10 +01003167 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003168 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003169 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003170
3171 return psa_driver_wrapper_sign_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003172 attributes, key_buffer, key_buffer_size,
3173 alg, hash, hash_length,
3174 signature, signature_size, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003175 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003176
Gilles Peskine449bd832023-01-11 14:50:10 +01003177 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003178}
3179
Gilles Peskine449bd832023-01-11 14:50:10 +01003180psa_status_t psa_sign_message(mbedtls_svc_key_id_t key,
3181 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003182 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003183 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003184 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003185 size_t signature_size,
3186 size_t *signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003187{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003188 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3189 LOCAL_INPUT_DECLARE(input_external, input);
3190 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3191
3192 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3193 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3194 status = psa_sign_internal(key, 1, alg, input, input_length, signature,
3195 signature_size, signature_length);
3196
Thomas Daubney3e65f522024-01-30 12:37:25 +00003197#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003198exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003199#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003200 LOCAL_INPUT_FREE(input_external, input);
3201 LOCAL_OUTPUT_FREE(signature_external, signature);
3202 return status;
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003203}
3204
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003205psa_status_t psa_verify_message_builtin(
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003206 const psa_key_attributes_t *attributes,
3207 const uint8_t *key_buffer,
3208 size_t key_buffer_size,
3209 psa_algorithm_t alg,
3210 const uint8_t *input,
3211 size_t input_length,
3212 const uint8_t *signature,
Gilles Peskine449bd832023-01-11 14:50:10 +01003213 size_t signature_length)
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003214{
3215 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003216
Gilles Peskine449bd832023-01-11 14:50:10 +01003217 if (PSA_ALG_IS_SIGN_HASH(alg)) {
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003218 size_t hash_length;
3219 uint8_t hash[PSA_HASH_MAX_SIZE];
3220
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003221 status = psa_driver_wrapper_hash_compute(
Gilles Peskine449bd832023-01-11 14:50:10 +01003222 PSA_ALG_SIGN_GET_HASH(alg),
3223 input, input_length,
3224 hash, sizeof(hash), &hash_length);
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003225
Gilles Peskine449bd832023-01-11 14:50:10 +01003226 if (status != PSA_SUCCESS) {
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003227 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01003228 }
gabor-mezei-armf9820f92021-05-03 16:26:20 +02003229
3230 return psa_driver_wrapper_verify_hash(
Gilles Peskine449bd832023-01-11 14:50:10 +01003231 attributes, key_buffer, key_buffer_size,
3232 alg, hash, hash_length,
3233 signature, signature_length);
gabor-mezei-arm0f622402021-04-29 16:48:44 +02003234 }
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003235
Gilles Peskine449bd832023-01-11 14:50:10 +01003236 return PSA_ERROR_NOT_SUPPORTED;
gabor-mezei-arm50eac352021-04-22 11:32:19 +02003237}
3238
Gilles Peskine449bd832023-01-11 14:50:10 +01003239psa_status_t psa_verify_message(mbedtls_svc_key_id_t key,
3240 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003241 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003242 size_t input_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003243 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003244 size_t signature_length)
gabor-mezei-arm5b446522021-04-20 12:11:35 +02003245{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003246 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3247 LOCAL_INPUT_DECLARE(input_external, input);
3248 LOCAL_INPUT_DECLARE(signature_external, signature);
3249
3250 LOCAL_INPUT_ALLOC(input_external, input_length, input);
3251 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3252 status = psa_verify_internal(key, 1, alg, input, input_length, signature,
3253 signature_length);
3254
Thomas Daubney3e65f522024-01-30 12:37:25 +00003255#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003256exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003257#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003258 LOCAL_INPUT_FREE(input_external, input);
3259 LOCAL_INPUT_FREE(signature_external, signature);
3260
3261 return status;
gabor-mezei-arm4a210192021-04-14 21:14:28 +02003262}
3263
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003264psa_status_t psa_sign_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003265 const psa_key_attributes_t *attributes,
3266 const uint8_t *key_buffer, size_t key_buffer_size,
3267 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003268 uint8_t *signature, size_t signature_size, size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003269{
Gilles Peskine449bd832023-01-11 14:50:10 +01003270 if (attributes->core.type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
3271 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3272 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003273#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003274 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3275 return mbedtls_psa_rsa_sign_hash(
3276 attributes,
3277 key_buffer, key_buffer_size,
3278 alg, hash, hash_length,
3279 signature, signature_size, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003280#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3281 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003282 } else {
3283 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003284 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003285 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3286 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003287#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003288 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3289 return mbedtls_psa_ecdsa_sign_hash(
3290 attributes,
3291 key_buffer, key_buffer_size,
3292 alg, hash, hash_length,
3293 signature, signature_size, signature_length);
Gilles Peskinee59236f2018-01-27 23:32:46 +01003294#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3295 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003296 } else {
3297 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003298 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003299 }
Ronald Cron4501c982021-03-19 20:09:32 +01003300
Gilles Peskine449bd832023-01-11 14:50:10 +01003301 (void) key_buffer;
3302 (void) key_buffer_size;
3303 (void) hash;
3304 (void) hash_length;
3305 (void) signature;
3306 (void) signature_size;
3307 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003308
Gilles Peskine449bd832023-01-11 14:50:10 +01003309 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003310}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003311
Gilles Peskine449bd832023-01-11 14:50:10 +01003312psa_status_t psa_sign_hash(mbedtls_svc_key_id_t key,
3313 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003314 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003315 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003316 uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003317 size_t signature_size,
3318 size_t *signature_length)
Gilles Peskinee59236f2018-01-27 23:32:46 +01003319{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003320 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3321 LOCAL_INPUT_DECLARE(hash_external, hash);
3322 LOCAL_OUTPUT_DECLARE(signature_external, signature);
3323
3324 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3325 LOCAL_OUTPUT_ALLOC(signature_external, signature_size, signature);
3326 status = psa_sign_internal(key, 0, alg, hash, hash_length, signature,
3327 signature_size, signature_length);
3328
Thomas Daubney3e65f522024-01-30 12:37:25 +00003329#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003330exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003331#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003332 LOCAL_INPUT_FREE(hash_external, hash);
3333 LOCAL_OUTPUT_FREE(signature_external, signature);
3334
3335 return status;
itayzafrir5c753392018-05-08 11:18:38 +03003336}
3337
gabor-mezei-arm6883fd22021-05-05 14:18:36 +02003338psa_status_t psa_verify_hash_builtin(
Ronald Cron18659932020-12-08 16:32:23 +01003339 const psa_key_attributes_t *attributes,
3340 const uint8_t *key_buffer, size_t key_buffer_size,
3341 psa_algorithm_t alg, const uint8_t *hash, size_t hash_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003342 const uint8_t *signature, size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003343{
Gilles Peskine449bd832023-01-11 14:50:10 +01003344 if (PSA_KEY_TYPE_IS_RSA(attributes->core.type)) {
3345 if (PSA_ALG_IS_RSA_PKCS1V15_SIGN(alg) ||
3346 PSA_ALG_IS_RSA_PSS(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003347#if defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003348 defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS)
3349 return mbedtls_psa_rsa_verify_hash(
3350 attributes,
3351 key_buffer, key_buffer_size,
3352 alg, hash, hash_length,
3353 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003354#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PKCS1V15_SIGN) ||
3355 * defined(MBEDTLS_PSA_BUILTIN_ALG_RSA_PSS) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003356 } else {
3357 return PSA_ERROR_INVALID_ARGUMENT;
Steven Cooremanacda8342020-07-24 23:09:52 +02003358 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003359 } else if (PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3360 if (PSA_ALG_IS_ECDSA(alg)) {
Ronald Cron4501c982021-03-19 20:09:32 +01003361#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Gilles Peskine449bd832023-01-11 14:50:10 +01003362 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3363 return mbedtls_psa_ecdsa_verify_hash(
3364 attributes,
3365 key_buffer, key_buffer_size,
3366 alg, hash, hash_length,
3367 signature, signature_length);
Ronald Cron4501c982021-03-19 20:09:32 +01003368#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3369 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Gilles Peskine449bd832023-01-11 14:50:10 +01003370 } else {
3371 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron4501c982021-03-19 20:09:32 +01003372 }
Ronald Cron8a494f32021-02-17 09:49:51 +01003373 }
Ronald Cron4501c982021-03-19 20:09:32 +01003374
Gilles Peskine449bd832023-01-11 14:50:10 +01003375 (void) key_buffer;
3376 (void) key_buffer_size;
3377 (void) hash;
3378 (void) hash_length;
3379 (void) signature;
3380 (void) signature_length;
Ronald Cron4501c982021-03-19 20:09:32 +01003381
Gilles Peskine449bd832023-01-11 14:50:10 +01003382 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron18659932020-12-08 16:32:23 +01003383}
3384
Gilles Peskine449bd832023-01-11 14:50:10 +01003385psa_status_t psa_verify_hash(mbedtls_svc_key_id_t key,
3386 psa_algorithm_t alg,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003387 const uint8_t *hash_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003388 size_t hash_length,
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003389 const uint8_t *signature_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01003390 size_t signature_length)
itayzafrir5c753392018-05-08 11:18:38 +03003391{
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003392 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3393 LOCAL_INPUT_DECLARE(hash_external, hash);
3394 LOCAL_INPUT_DECLARE(signature_external, signature);
3395
3396 LOCAL_INPUT_ALLOC(hash_external, hash_length, hash);
3397 LOCAL_INPUT_ALLOC(signature_external, signature_length, signature);
3398 status = psa_verify_internal(key, 0, alg, hash, hash_length, signature,
3399 signature_length);
3400
Thomas Daubney3e65f522024-01-30 12:37:25 +00003401#if defined(MBEDTLS_PSA_COPY_CALLER_BUFFERS)
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003402exit:
Thomas Daubney3e65f522024-01-30 12:37:25 +00003403#endif
Thomas Daubney4f8847b2024-01-18 17:23:02 +00003404 LOCAL_INPUT_FREE(hash_external, hash);
3405 LOCAL_INPUT_FREE(signature_external, signature);
3406
3407 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01003408}
3409
Gilles Peskine449bd832023-01-11 14:50:10 +01003410psa_status_t psa_asymmetric_encrypt(mbedtls_svc_key_id_t key,
3411 psa_algorithm_t alg,
3412 const uint8_t *input,
3413 size_t input_length,
3414 const uint8_t *salt,
3415 size_t salt_length,
3416 uint8_t *output,
3417 size_t output_size,
3418 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003419{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003420 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003421 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003422 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003423 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003424
Darryl Green5cc689a2018-07-24 15:34:10 +01003425 (void) input;
3426 (void) input_length;
3427 (void) salt;
3428 (void) output;
3429 (void) output_size;
3430
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003431 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003432
Gilles Peskine449bd832023-01-11 14:50:10 +01003433 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3434 return PSA_ERROR_INVALID_ARGUMENT;
3435 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003436
Ronald Cron5c522922020-11-14 16:35:34 +01003437 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003438 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
3439 if (status != PSA_SUCCESS) {
3440 return status;
3441 }
3442 if (!(PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type) ||
3443 PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type))) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003444 status = PSA_ERROR_INVALID_ARGUMENT;
3445 goto exit;
3446 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003447
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003448 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003449 .core = slot->attr
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003450 };
Steven Cooremana2371e52020-07-28 14:30:39 +02003451
Przemyslaw Stekiel19e61422021-12-09 11:09:11 +01003452 status = psa_driver_wrapper_asymmetric_encrypt(
3453 &attributes, slot->key.data, slot->key.bytes,
3454 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003455 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003456exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003457 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003458
Gilles Peskine449bd832023-01-11 14:50:10 +01003459 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003460}
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003461
Gilles Peskine449bd832023-01-11 14:50:10 +01003462psa_status_t psa_asymmetric_decrypt(mbedtls_svc_key_id_t key,
3463 psa_algorithm_t alg,
3464 const uint8_t *input,
3465 size_t input_length,
3466 const uint8_t *salt,
3467 size_t salt_length,
3468 uint8_t *output,
3469 size_t output_size,
3470 size_t *output_length)
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003471{
Ronald Cronf95a2b12020-10-22 15:24:49 +02003472 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01003473 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01003474 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003475 psa_key_attributes_t attributes;
Gilles Peskineb0b255c2018-07-06 17:01:38 +02003476
Darryl Green5cc689a2018-07-24 15:34:10 +01003477 (void) input;
3478 (void) input_length;
3479 (void) salt;
3480 (void) output;
3481 (void) output_size;
3482
Nir Sonnenscheinca466c82018-06-04 16:43:12 +03003483 *output_length = 0;
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003484
Gilles Peskine449bd832023-01-11 14:50:10 +01003485 if (!PSA_ALG_IS_RSA_OAEP(alg) && salt_length != 0) {
3486 return PSA_ERROR_INVALID_ARGUMENT;
3487 }
Gilles Peskineb3fc05d2018-06-30 19:04:35 +02003488
Ronald Cron5c522922020-11-14 16:35:34 +01003489 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01003490 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
3491 if (status != PSA_SUCCESS) {
3492 return status;
3493 }
3494 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
Ronald Cronf95a2b12020-10-22 15:24:49 +02003495 status = PSA_ERROR_INVALID_ARGUMENT;
3496 goto exit;
3497 }
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003498
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003499 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01003500 .core = slot->attr
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003501 };
Nir Sonnenschein39e59142018-05-02 23:16:26 +03003502
Przemyslaw Stekiel8d45c002021-12-13 08:58:19 +01003503 status = psa_driver_wrapper_asymmetric_decrypt(
3504 &attributes, slot->key.data, slot->key.bytes,
3505 alg, input, input_length, salt, salt_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01003506 output, output_size, output_length);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003507
3508exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01003509 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02003510
Gilles Peskine449bd832023-01-11 14:50:10 +01003511 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine5b051bc2018-05-31 13:25:48 +02003512}
Gilles Peskinee59236f2018-01-27 23:32:46 +01003513
Paul Elliott9fe12f62022-11-30 19:16:02 +00003514/****************************************************************/
3515/* Asymmetric interruptible cryptography */
3516/****************************************************************/
3517
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003518static uint32_t psa_interruptible_max_ops = PSA_INTERRUPTIBLE_MAX_OPS_UNLIMITED;
3519
Paul Elliott9fe12f62022-11-30 19:16:02 +00003520void psa_interruptible_set_max_ops(uint32_t max_ops)
3521{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003522 psa_interruptible_max_ops = max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003523}
3524
3525uint32_t psa_interruptible_get_max_ops(void)
3526{
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003527 return psa_interruptible_max_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003528}
3529
Paul Elliott9fe12f62022-11-30 19:16:02 +00003530uint32_t psa_sign_hash_get_num_ops(
3531 const psa_sign_hash_interruptible_operation_t *operation)
3532{
Paul Elliott296ede92022-12-15 17:00:30 +00003533 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003534}
3535
3536uint32_t psa_verify_hash_get_num_ops(
3537 const psa_verify_hash_interruptible_operation_t *operation)
3538{
Paul Elliott296ede92022-12-15 17:00:30 +00003539 return operation->num_ops;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003540}
3541
Paul Elliott59ad9452022-12-18 15:09:02 +00003542static psa_status_t psa_sign_hash_abort_internal(
3543 psa_sign_hash_interruptible_operation_t *operation)
3544{
3545 if (operation->id == 0) {
3546 /* The object has (apparently) been initialized but it is not (yet)
3547 * in use. It's ok to call abort on such an object, and there's
3548 * nothing to do. */
3549 return PSA_SUCCESS;
3550 }
3551
3552 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3553
3554 status = psa_driver_wrapper_sign_hash_abort(operation);
3555
3556 operation->id = 0;
3557
Paul Elliotte6145dc2023-02-07 12:51:21 +00003558 /* Do not clear either the error_occurred or num_ops elements here as they
3559 * only want to be cleared by the application calling abort, not by abort
3560 * being called at completion of an operation. */
3561
Paul Elliott59ad9452022-12-18 15:09:02 +00003562 return status;
3563}
3564
Paul Elliott9fe12f62022-11-30 19:16:02 +00003565psa_status_t psa_sign_hash_start(
3566 psa_sign_hash_interruptible_operation_t *operation,
3567 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3568 const uint8_t *hash, size_t hash_length)
3569{
3570 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3571 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3572 psa_key_slot_t *slot;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003573 psa_key_attributes_t attributes;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003574
Paul Elliottc9774412023-02-06 15:14:07 +00003575 /* Check that start has not been previously called, or operation has not
3576 * previously errored. */
3577 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003578 return PSA_ERROR_BAD_STATE;
3579 }
3580
Paul Elliott9fe12f62022-11-30 19:16:02 +00003581 status = psa_sign_verify_check_alg(0, alg);
3582 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003583 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003584 return status;
3585 }
3586
3587 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3588 PSA_KEY_USAGE_SIGN_HASH,
3589 alg);
3590
3591 if (status != PSA_SUCCESS) {
3592 goto exit;
3593 }
3594
3595 if (!PSA_KEY_TYPE_IS_KEY_PAIR(slot->attr.type)) {
3596 status = PSA_ERROR_INVALID_ARGUMENT;
3597 goto exit;
3598 }
3599
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01003600 attributes = (psa_key_attributes_t) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003601 .core = slot->attr
3602 };
3603
Paul Elliott296ede92022-12-15 17:00:30 +00003604 /* Ensure ops count gets reset, in case of operation re-use. */
3605 operation->num_ops = 0;
3606
Paul Elliott9fe12f62022-11-30 19:16:02 +00003607 status = psa_driver_wrapper_sign_hash_start(operation, &attributes,
3608 slot->key.data,
3609 slot->key.bytes, alg,
3610 hash, hash_length);
3611exit:
3612
3613 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003614 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003615 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003616 }
3617
3618 unlock_status = psa_unlock_key_slot(slot);
3619
Paul Elliottc9774412023-02-06 15:14:07 +00003620 if (unlock_status != PSA_SUCCESS) {
3621 operation->error_occurred = 1;
3622 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003623
Paul Elliottc9774412023-02-06 15:14:07 +00003624 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003625}
3626
3627
3628psa_status_t psa_sign_hash_complete(
3629 psa_sign_hash_interruptible_operation_t *operation,
3630 uint8_t *signature, size_t signature_size,
3631 size_t *signature_length)
3632{
3633 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3634
3635 *signature_length = 0;
3636
Paul Elliottc9774412023-02-06 15:14:07 +00003637 /* Check that start has been called first, and that operation has not
3638 * previously errored. */
3639 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003640 status = PSA_ERROR_BAD_STATE;
3641 goto exit;
3642 }
3643
Paul Elliott096abc42023-02-03 18:33:23 +00003644 /* Immediately reject a zero-length signature buffer. This guarantees that
3645 * signature must be a valid pointer. */
Paul Elliott9fe12f62022-11-30 19:16:02 +00003646 if (signature_size == 0) {
3647 status = PSA_ERROR_BUFFER_TOO_SMALL;
3648 goto exit;
3649 }
3650
3651 status = psa_driver_wrapper_sign_hash_complete(operation, signature,
3652 signature_size,
3653 signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003654
Paul Elliott296ede92022-12-15 17:00:30 +00003655 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003656 operation->num_ops = psa_driver_wrapper_sign_hash_get_num_ops(operation);
Paul Elliott296ede92022-12-15 17:00:30 +00003657
Paul Elliottebe225c2023-02-10 14:32:53 +00003658exit:
3659
Paul Elliott59200a22023-02-21 15:07:40 +00003660 psa_wipe_tag_output_buffer(signature, status, signature_size,
3661 *signature_length);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003662
Paul Elliott53bb3122023-02-10 14:22:22 +00003663 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003664 if (status != PSA_SUCCESS) {
3665 operation->error_occurred = 1;
3666 }
3667
Paul Elliott59ad9452022-12-18 15:09:02 +00003668 psa_sign_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003669 }
3670
3671 return status;
3672}
3673
3674psa_status_t psa_sign_hash_abort(
3675 psa_sign_hash_interruptible_operation_t *operation)
3676{
Paul Elliott59ad9452022-12-18 15:09:02 +00003677 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3678
3679 status = psa_sign_hash_abort_internal(operation);
3680
3681 /* We clear the number of ops done here, so that it is not cleared when
3682 * the operation fails or succeeds, only on manual abort. */
3683 operation->num_ops = 0;
3684
Paul Elliottc9774412023-02-06 15:14:07 +00003685 /* Likewise, failure state. */
3686 operation->error_occurred = 0;
3687
Paul Elliott59ad9452022-12-18 15:09:02 +00003688 return status;
3689}
3690
3691static psa_status_t psa_verify_hash_abort_internal(
3692 psa_verify_hash_interruptible_operation_t *operation)
3693{
Paul Elliott9fe12f62022-11-30 19:16:02 +00003694 if (operation->id == 0) {
3695 /* The object has (apparently) been initialized but it is not (yet)
3696 * in use. It's ok to call abort on such an object, and there's
3697 * nothing to do. */
3698 return PSA_SUCCESS;
3699 }
3700
Paul Elliott59ad9452022-12-18 15:09:02 +00003701 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3702
3703 status = psa_driver_wrapper_verify_hash_abort(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003704
3705 operation->id = 0;
3706
Paul Elliotte6145dc2023-02-07 12:51:21 +00003707 /* Do not clear either the error_occurred or num_ops elements here as they
3708 * only want to be cleared by the application calling abort, not by abort
3709 * being called at completion of an operation. */
3710
Paul Elliott59ad9452022-12-18 15:09:02 +00003711 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003712}
3713
3714psa_status_t psa_verify_hash_start(
3715 psa_verify_hash_interruptible_operation_t *operation,
3716 mbedtls_svc_key_id_t key, psa_algorithm_t alg,
3717 const uint8_t *hash, size_t hash_length,
3718 const uint8_t *signature, size_t signature_length)
3719{
3720 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3721 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
3722 psa_key_slot_t *slot;
3723
Paul Elliottc9774412023-02-06 15:14:07 +00003724 /* Check that start has not been previously called, or operation has not
3725 * previously errored. */
3726 if (operation->id != 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003727 return PSA_ERROR_BAD_STATE;
3728 }
3729
3730 status = psa_sign_verify_check_alg(0, alg);
3731 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003732 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003733 return status;
3734 }
3735
3736 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
3737 PSA_KEY_USAGE_VERIFY_HASH,
3738 alg);
3739
3740 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003741 operation->error_occurred = 1;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003742 return status;
3743 }
3744
3745 psa_key_attributes_t attributes = {
3746 .core = slot->attr
3747 };
3748
Paul Elliott296ede92022-12-15 17:00:30 +00003749 /* Ensure ops count gets reset, in case of operation re-use. */
3750 operation->num_ops = 0;
3751
Paul Elliott9fe12f62022-11-30 19:16:02 +00003752 status = psa_driver_wrapper_verify_hash_start(operation, &attributes,
3753 slot->key.data,
3754 slot->key.bytes,
3755 alg, hash, hash_length,
3756 signature, signature_length);
3757
3758 if (status != PSA_SUCCESS) {
Paul Elliottc9774412023-02-06 15:14:07 +00003759 operation->error_occurred = 1;
Paul Elliott59ad9452022-12-18 15:09:02 +00003760 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003761 }
3762
3763 unlock_status = psa_unlock_key_slot(slot);
3764
Paul Elliottc9774412023-02-06 15:14:07 +00003765 if (unlock_status != PSA_SUCCESS) {
3766 operation->error_occurred = 1;
3767 }
Paul Elliott9fe12f62022-11-30 19:16:02 +00003768
Paul Elliottc9774412023-02-06 15:14:07 +00003769 return (status == PSA_SUCCESS) ? unlock_status : status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003770}
3771
3772psa_status_t psa_verify_hash_complete(
3773 psa_verify_hash_interruptible_operation_t *operation)
3774{
3775 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
3776
Paul Elliottc9774412023-02-06 15:14:07 +00003777 /* Check that start has been called first, and that operation has not
3778 * previously errored. */
3779 if (operation->id == 0 || operation->error_occurred) {
Paul Elliott9fe12f62022-11-30 19:16:02 +00003780 status = PSA_ERROR_BAD_STATE;
3781 goto exit;
3782 }
3783
3784 status = psa_driver_wrapper_verify_hash_complete(operation);
3785
Paul Elliott296ede92022-12-15 17:00:30 +00003786 /* Update ops count with work done. */
Paul Elliottde1114c2023-02-07 12:43:11 +00003787 operation->num_ops = psa_driver_wrapper_verify_hash_get_num_ops(
Paul Elliott296ede92022-12-15 17:00:30 +00003788 operation);
3789
Paul Elliottebe225c2023-02-10 14:32:53 +00003790exit:
3791
Paul Elliott9fe12f62022-11-30 19:16:02 +00003792 if (status != PSA_OPERATION_INCOMPLETE) {
Paul Elliottc9774412023-02-06 15:14:07 +00003793 if (status != PSA_SUCCESS) {
3794 operation->error_occurred = 1;
3795 }
3796
Paul Elliott59ad9452022-12-18 15:09:02 +00003797 psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003798 }
3799
3800 return status;
3801}
3802
3803psa_status_t psa_verify_hash_abort(
3804 psa_verify_hash_interruptible_operation_t *operation)
3805{
Paul Elliott59ad9452022-12-18 15:09:02 +00003806 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003807
Paul Elliott59ad9452022-12-18 15:09:02 +00003808 status = psa_verify_hash_abort_internal(operation);
Paul Elliott9fe12f62022-11-30 19:16:02 +00003809
Paul Elliott59ad9452022-12-18 15:09:02 +00003810 /* We clear the number of ops done here, so that it is not cleared when
3811 * the operation fails or succeeds, only on manual abort. */
3812 operation->num_ops = 0;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003813
Paul Elliottc9774412023-02-06 15:14:07 +00003814 /* Likewise, failure state. */
3815 operation->error_occurred = 0;
3816
Paul Elliott59ad9452022-12-18 15:09:02 +00003817 return status;
Paul Elliott9fe12f62022-11-30 19:16:02 +00003818}
3819
Paul Elliott588f8ed2022-12-02 18:10:26 +00003820/****************************************************************/
3821/* Asymmetric interruptible cryptography internal */
3822/* implementations */
3823/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02003824
Paul Elliott588f8ed2022-12-02 18:10:26 +00003825void mbedtls_psa_interruptible_set_max_ops(uint32_t max_ops)
3826{
Paul Elliott7cc4e812023-01-10 17:14:11 +00003827
Paul Elliott588f8ed2022-12-02 18:10:26 +00003828#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3829 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3830 defined(MBEDTLS_ECP_RESTARTABLE)
3831
3832 /* Internal implementation uses zero to indicate infinite number max ops,
3833 * therefore avoid this value, and set to minimum possible. */
3834 if (max_ops == 0) {
3835 max_ops = 1;
3836 }
3837
Paul Elliott588f8ed2022-12-02 18:10:26 +00003838 mbedtls_ecp_set_max_ops(max_ops);
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003839#else
3840 (void) max_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003841#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3842 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3843 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3844}
3845
Paul Elliott588f8ed2022-12-02 18:10:26 +00003846uint32_t mbedtls_psa_sign_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003847 const mbedtls_psa_sign_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003848{
3849#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3850 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3851 defined(MBEDTLS_ECP_RESTARTABLE)
3852
Paul Elliott93d9ca82023-02-15 18:14:21 +00003853 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003854#else
3855 (void) operation;
3856 return 0;
3857#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3858 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3859 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3860}
3861
3862uint32_t mbedtls_psa_verify_hash_get_num_ops(
Paul Elliottf8e5b562023-02-19 18:43:45 +00003863 const mbedtls_psa_verify_hash_interruptible_operation_t *operation)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003864{
3865 #if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3866 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3867 defined(MBEDTLS_ECP_RESTARTABLE)
3868
Paul Elliott93d9ca82023-02-15 18:14:21 +00003869 return operation->num_ops;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003870#else
3871 (void) operation;
3872 return 0;
3873#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3874 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3875 * defined( MBEDTLS_ECP_RESTARTABLE ) */
3876}
3877
3878psa_status_t mbedtls_psa_sign_hash_start(
3879 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3880 const psa_key_attributes_t *attributes, const uint8_t *key_buffer,
3881 size_t key_buffer_size, psa_algorithm_t alg,
3882 const uint8_t *hash, size_t hash_length)
3883{
3884 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott0290a762023-02-09 14:30:24 +00003885 size_t required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003886
Paul Elliott068fe072023-01-16 13:59:15 +00003887 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
3888 return PSA_ERROR_NOT_SUPPORTED;
3889 }
3890
3891 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00003892 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00003893 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003894
3895#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00003896 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3897 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00003898
Paul Elliotta1c94092023-02-15 16:38:04 +00003899 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
3900
Paul Elliott93d9ca82023-02-15 18:14:21 +00003901 /* Ensure num_ops is zero'ed in case of context re-use. */
3902 operation->num_ops = 0;
3903
Paul Elliott068fe072023-01-16 13:59:15 +00003904 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
3905 attributes->core.bits,
3906 key_buffer,
3907 key_buffer_size,
3908 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003909
Paul Elliott068fe072023-01-16 13:59:15 +00003910 if (status != PSA_SUCCESS) {
3911 return status;
3912 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00003913
Paul Elliott1bc59df2023-02-05 13:41:57 +00003914 operation->coordinate_bytes = PSA_BITS_TO_BYTES(
Paul Elliottc569fc22023-02-10 13:02:54 +00003915 operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003916
Paul Elliott068fe072023-01-16 13:59:15 +00003917 psa_algorithm_t hash_alg = PSA_ALG_SIGN_GET_HASH(alg);
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +02003918 operation->md_alg = mbedtls_md_type_from_psa_alg(hash_alg);
Paul Elliott068fe072023-01-16 13:59:15 +00003919 operation->alg = alg;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003920
Paul Elliott0290a762023-02-09 14:30:24 +00003921 /* We only need to store the same length of hash as the private key size
3922 * here, it would be truncated by the internal implementation anyway. */
3923 required_hash_length = (hash_length < operation->coordinate_bytes ?
3924 hash_length : operation->coordinate_bytes);
3925
Paul Elliottba70ad42023-02-15 18:23:53 +00003926 if (required_hash_length > sizeof(operation->hash)) {
3927 /* Shouldn't happen, but better safe than sorry. */
3928 return PSA_ERROR_CORRUPTION_DETECTED;
3929 }
3930
Paul Elliott0290a762023-02-09 14:30:24 +00003931 memcpy(operation->hash, hash, required_hash_length);
3932 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00003933
3934 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003935
3936#else
Paul Elliott068fe072023-01-16 13:59:15 +00003937 (void) operation;
3938 (void) key_buffer;
3939 (void) key_buffer_size;
3940 (void) alg;
3941 (void) hash;
3942 (void) hash_length;
3943 (void) status;
Paul Elliott0290a762023-02-09 14:30:24 +00003944 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003945
Paul Elliott068fe072023-01-16 13:59:15 +00003946 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003947#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
3948 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
3949 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00003950}
3951
3952psa_status_t mbedtls_psa_sign_hash_complete(
3953 mbedtls_psa_sign_hash_interruptible_operation_t *operation,
3954 uint8_t *signature, size_t signature_size,
3955 size_t *signature_length)
3956{
Paul Elliott588f8ed2022-12-02 18:10:26 +00003957#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
3958 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
3959 defined(MBEDTLS_ECP_RESTARTABLE)
3960
Paul Elliotta1c94092023-02-15 16:38:04 +00003961 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1243f932023-02-07 11:21:10 +00003962 mbedtls_mpi r;
3963 mbedtls_mpi s;
3964
Paul Elliott46845252023-02-03 14:59:11 +00003965 mbedtls_mpi_init(&r);
3966 mbedtls_mpi_init(&s);
Paul Elliott588f8ed2022-12-02 18:10:26 +00003967
Paul Elliotta16ce9f2023-02-21 14:19:23 +00003968 /* Ensure max_ops is set to the current value (or default). */
3969 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
3970
Paul Elliotta1c94092023-02-15 16:38:04 +00003971 if (signature_size < 2 * operation->coordinate_bytes) {
3972 status = PSA_ERROR_BUFFER_TOO_SMALL;
3973 goto exit;
3974 }
3975
Paul Elliott588f8ed2022-12-02 18:10:26 +00003976 if (PSA_ALG_ECDSA_IS_DETERMINISTIC(operation->alg)) {
Paul Elliott46845252023-02-03 14:59:11 +00003977
Paul Elliott588f8ed2022-12-02 18:10:26 +00003978#if defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)
3979 status = mbedtls_to_psa_error(
3980 mbedtls_ecdsa_sign_det_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003981 &r,
3982 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003983 &operation->ctx->d,
3984 operation->hash,
3985 operation->hash_length,
3986 operation->md_alg,
3987 mbedtls_psa_get_random,
3988 MBEDTLS_PSA_RANDOM_STATE,
3989 &operation->restart_ctx));
3990#else /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
Paul Elliott724bd252023-02-08 12:35:08 +00003991 status = PSA_ERROR_NOT_SUPPORTED;
3992 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00003993#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) */
3994 } else {
Paul Elliott588f8ed2022-12-02 18:10:26 +00003995 status = mbedtls_to_psa_error(
3996 mbedtls_ecdsa_sign_restartable(&operation->ctx->grp,
Paul Elliott46845252023-02-03 14:59:11 +00003997 &r,
3998 &s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00003999 &operation->ctx->d,
4000 operation->hash,
4001 operation->hash_length,
4002 mbedtls_psa_get_random,
4003 MBEDTLS_PSA_RANDOM_STATE,
4004 mbedtls_psa_get_random,
4005 MBEDTLS_PSA_RANDOM_STATE,
4006 &operation->restart_ctx));
4007 }
4008
Paul Elliottf8e5b562023-02-19 18:43:45 +00004009 /* Hide the fact that the restart context only holds a delta of number of
4010 * ops done during the last operation, not an absolute value. */
4011 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4012
Paul Elliott724bd252023-02-08 12:35:08 +00004013 if (status == PSA_SUCCESS) {
Paul Elliott588f8ed2022-12-02 18:10:26 +00004014 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00004015 mbedtls_mpi_write_binary(&r,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004016 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004017 operation->coordinate_bytes)
4018 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00004019
4020 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00004021 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004022 }
4023
4024 status = mbedtls_to_psa_error(
Paul Elliott46845252023-02-03 14:59:11 +00004025 mbedtls_mpi_write_binary(&s,
Paul Elliott588f8ed2022-12-02 18:10:26 +00004026 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004027 operation->coordinate_bytes,
4028 operation->coordinate_bytes)
4029 );
Paul Elliott588f8ed2022-12-02 18:10:26 +00004030
4031 if (status != PSA_SUCCESS) {
Paul Elliott724bd252023-02-08 12:35:08 +00004032 goto exit;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004033 }
4034
Paul Elliott1bc59df2023-02-05 13:41:57 +00004035 *signature_length = operation->coordinate_bytes * 2;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004036
Paul Elliott724bd252023-02-08 12:35:08 +00004037 status = PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004038 }
Paul Elliott724bd252023-02-08 12:35:08 +00004039
4040exit:
4041
4042 mbedtls_mpi_free(&r);
4043 mbedtls_mpi_free(&s);
4044 return status;
4045
Paul Elliott588f8ed2022-12-02 18:10:26 +00004046 #else
4047
4048 (void) operation;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004049 (void) signature;
4050 (void) signature_size;
4051 (void) signature_length;
4052
4053 return PSA_ERROR_NOT_SUPPORTED;
4054
4055#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4056 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4057 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4058}
4059
4060psa_status_t mbedtls_psa_sign_hash_abort(
4061 mbedtls_psa_sign_hash_interruptible_operation_t *operation)
4062{
4063
4064#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4065 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4066 defined(MBEDTLS_ECP_RESTARTABLE)
4067
4068 if (operation->ctx) {
4069 mbedtls_ecdsa_free(operation->ctx);
4070 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004071 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004072 }
4073
4074 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4075
Paul Elliott93d9ca82023-02-15 18:14:21 +00004076 operation->num_ops = 0;
4077
Paul Elliott588f8ed2022-12-02 18:10:26 +00004078 return PSA_SUCCESS;
4079
4080#else
4081
4082 (void) operation;
4083
4084 return PSA_ERROR_NOT_SUPPORTED;
4085
4086#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4087 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4088 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4089}
4090
4091psa_status_t mbedtls_psa_verify_hash_start(
4092 mbedtls_psa_verify_hash_interruptible_operation_t *operation,
4093 const psa_key_attributes_t *attributes,
4094 const uint8_t *key_buffer, size_t key_buffer_size,
4095 psa_algorithm_t alg,
4096 const uint8_t *hash, size_t hash_length,
4097 const uint8_t *signature, size_t signature_length)
4098{
4099 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott1bc59df2023-02-05 13:41:57 +00004100 size_t coordinate_bytes = 0;
Paul Elliott0290a762023-02-09 14:30:24 +00004101 size_t required_hash_length = 0;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004102
Paul Elliott068fe072023-01-16 13:59:15 +00004103 if (!PSA_KEY_TYPE_IS_ECC(attributes->core.type)) {
4104 return PSA_ERROR_NOT_SUPPORTED;
4105 }
4106
4107 if (!PSA_ALG_IS_ECDSA(alg)) {
Paul Elliott813f9cd2023-02-05 15:28:46 +00004108 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott068fe072023-01-16 13:59:15 +00004109 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004110
4111#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
Paul Elliott068fe072023-01-16 13:59:15 +00004112 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4113 defined(MBEDTLS_ECP_RESTARTABLE)
Paul Elliott588f8ed2022-12-02 18:10:26 +00004114
Paul Elliotta1c94092023-02-15 16:38:04 +00004115 mbedtls_ecdsa_restart_init(&operation->restart_ctx);
4116 mbedtls_mpi_init(&operation->r);
4117 mbedtls_mpi_init(&operation->s);
4118
Paul Elliott93d9ca82023-02-15 18:14:21 +00004119 /* Ensure num_ops is zero'ed in case of context re-use. */
4120 operation->num_ops = 0;
4121
Paul Elliott068fe072023-01-16 13:59:15 +00004122 status = mbedtls_psa_ecp_load_representation(attributes->core.type,
4123 attributes->core.bits,
4124 key_buffer,
4125 key_buffer_size,
4126 &operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004127
Paul Elliott068fe072023-01-16 13:59:15 +00004128 if (status != PSA_SUCCESS) {
4129 return status;
4130 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004131
Paul Elliottc569fc22023-02-10 13:02:54 +00004132 coordinate_bytes = PSA_BITS_TO_BYTES(operation->ctx->grp.nbits);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004133
Paul Elliott1bc59df2023-02-05 13:41:57 +00004134 if (signature_length != 2 * coordinate_bytes) {
Paul Elliott068fe072023-01-16 13:59:15 +00004135 return PSA_ERROR_INVALID_SIGNATURE;
4136 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004137
Paul Elliott068fe072023-01-16 13:59:15 +00004138 status = mbedtls_to_psa_error(
4139 mbedtls_mpi_read_binary(&operation->r,
4140 signature,
Paul Elliott1bc59df2023-02-05 13:41:57 +00004141 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004142
Paul Elliott068fe072023-01-16 13:59:15 +00004143 if (status != PSA_SUCCESS) {
4144 return status;
4145 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004146
Paul Elliott068fe072023-01-16 13:59:15 +00004147 status = mbedtls_to_psa_error(
4148 mbedtls_mpi_read_binary(&operation->s,
4149 signature +
Paul Elliott1bc59df2023-02-05 13:41:57 +00004150 coordinate_bytes,
4151 coordinate_bytes));
Paul Elliott588f8ed2022-12-02 18:10:26 +00004152
Paul Elliott068fe072023-01-16 13:59:15 +00004153 if (status != PSA_SUCCESS) {
4154 return status;
4155 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004156
Paul Elliott2c9843f2023-02-15 17:32:42 +00004157 status = mbedtls_psa_ecp_load_public_part(operation->ctx);
Paul Elliott588f8ed2022-12-02 18:10:26 +00004158
Paul Elliott2c9843f2023-02-15 17:32:42 +00004159 if (status != PSA_SUCCESS) {
4160 return status;
Paul Elliott068fe072023-01-16 13:59:15 +00004161 }
Paul Elliott588f8ed2022-12-02 18:10:26 +00004162
Paul Elliott0290a762023-02-09 14:30:24 +00004163 /* We only need to store the same length of hash as the private key size
4164 * here, it would be truncated by the internal implementation anyway. */
4165 required_hash_length = (hash_length < coordinate_bytes ? hash_length :
4166 coordinate_bytes);
4167
Paul Elliottba70ad42023-02-15 18:23:53 +00004168 if (required_hash_length > sizeof(operation->hash)) {
4169 /* Shouldn't happen, but better safe than sorry. */
4170 return PSA_ERROR_CORRUPTION_DETECTED;
4171 }
4172
Paul Elliott0290a762023-02-09 14:30:24 +00004173 memcpy(operation->hash, hash, required_hash_length);
4174 operation->hash_length = required_hash_length;
Paul Elliott068fe072023-01-16 13:59:15 +00004175
4176 return PSA_SUCCESS;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004177#else
Paul Elliott068fe072023-01-16 13:59:15 +00004178 (void) operation;
4179 (void) key_buffer;
4180 (void) key_buffer_size;
4181 (void) alg;
4182 (void) hash;
4183 (void) hash_length;
4184 (void) signature;
4185 (void) signature_length;
4186 (void) status;
Paul Elliott1243f932023-02-07 11:21:10 +00004187 (void) coordinate_bytes;
Paul Elliott0290a762023-02-09 14:30:24 +00004188 (void) required_hash_length;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004189
Paul Elliott068fe072023-01-16 13:59:15 +00004190 return PSA_ERROR_NOT_SUPPORTED;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004191#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4192 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4193 * defined( MBEDTLS_ECP_RESTARTABLE ) */
Paul Elliott588f8ed2022-12-02 18:10:26 +00004194}
4195
4196psa_status_t mbedtls_psa_verify_hash_complete(
4197 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4198{
4199
4200#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4201 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4202 defined(MBEDTLS_ECP_RESTARTABLE)
4203
Paul Elliottf8e5b562023-02-19 18:43:45 +00004204 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4205
Paul Elliotta16ce9f2023-02-21 14:19:23 +00004206 /* Ensure max_ops is set to the current value (or default). */
4207 mbedtls_psa_interruptible_set_max_ops(psa_interruptible_get_max_ops());
4208
Paul Elliottf8e5b562023-02-19 18:43:45 +00004209 status = mbedtls_to_psa_error(
Paul Elliott588f8ed2022-12-02 18:10:26 +00004210 mbedtls_ecdsa_verify_restartable(&operation->ctx->grp,
4211 operation->hash,
4212 operation->hash_length,
4213 &operation->ctx->Q,
4214 &operation->r,
4215 &operation->s,
4216 &operation->restart_ctx));
4217
Paul Elliottf8e5b562023-02-19 18:43:45 +00004218 /* Hide the fact that the restart context only holds a delta of number of
4219 * ops done during the last operation, not an absolute value. */
4220 operation->num_ops += operation->restart_ctx.ecp.ops_done;
4221
4222 return status;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004223#else
4224 (void) operation;
4225
4226 return PSA_ERROR_NOT_SUPPORTED;
4227
4228#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4229 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4230 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4231}
4232
4233psa_status_t mbedtls_psa_verify_hash_abort(
4234 mbedtls_psa_verify_hash_interruptible_operation_t *operation)
4235{
4236
4237#if (defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) || \
4238 defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA)) && \
4239 defined(MBEDTLS_ECP_RESTARTABLE)
4240
4241 if (operation->ctx) {
4242 mbedtls_ecdsa_free(operation->ctx);
4243 mbedtls_free(operation->ctx);
Paul Elliottf9c91a72023-02-05 18:06:38 +00004244 operation->ctx = NULL;
Paul Elliott588f8ed2022-12-02 18:10:26 +00004245 }
4246
4247 mbedtls_ecdsa_restart_free(&operation->restart_ctx);
4248
Paul Elliott93d9ca82023-02-15 18:14:21 +00004249 operation->num_ops = 0;
4250
Paul Elliott588f8ed2022-12-02 18:10:26 +00004251 mbedtls_mpi_free(&operation->r);
4252 mbedtls_mpi_free(&operation->s);
4253
4254 return PSA_SUCCESS;
4255
4256#else
4257 (void) operation;
4258
4259 return PSA_ERROR_NOT_SUPPORTED;
4260
4261#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_ECDSA) ||
4262 * defined(MBEDTLS_PSA_BUILTIN_ALG_DETERMINISTIC_ECDSA) &&
4263 * defined( MBEDTLS_ECP_RESTARTABLE ) */
4264}
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004265
mohammad1603503973b2018-03-12 15:59:30 +02004266/****************************************************************/
4267/* Symmetric cryptography */
4268/****************************************************************/
4269
Gilles Peskine449bd832023-01-11 14:50:10 +01004270static psa_status_t psa_cipher_setup(psa_cipher_operation_t *operation,
4271 mbedtls_svc_key_id_t key,
4272 psa_algorithm_t alg,
4273 mbedtls_operation_t cipher_operation)
Ronald Cronab99ac22020-10-01 16:38:28 +02004274{
4275 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4276 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Dave Rodgman54648242021-06-24 11:49:45 +01004277 psa_key_slot_t *slot = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01004278 psa_key_usage_t usage = (cipher_operation == MBEDTLS_ENCRYPT ?
4279 PSA_KEY_USAGE_ENCRYPT :
4280 PSA_KEY_USAGE_DECRYPT);
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004281 psa_key_attributes_t attributes;
Ronald Cronab99ac22020-10-01 16:38:28 +02004282
4283 /* A context must be freshly initialized before it can be set up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004284 if (operation->id != 0) {
Dave Rodgman54648242021-06-24 11:49:45 +01004285 status = PSA_ERROR_BAD_STATE;
4286 goto exit;
4287 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004288
Gilles Peskine449bd832023-01-11 14:50:10 +01004289 if (!PSA_ALG_IS_CIPHER(alg)) {
Dave Rodgman54648242021-06-24 11:49:45 +01004290 status = PSA_ERROR_INVALID_ARGUMENT;
4291 goto exit;
4292 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004293
Gilles Peskine449bd832023-01-11 14:50:10 +01004294 status = psa_get_and_lock_key_slot_with_policy(key, &slot, usage, alg);
4295 if (status != PSA_SUCCESS) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004296 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004297 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004298
Ronald Cron49fafa92021-03-10 08:34:23 +01004299 /* Initialize the operation struct members, except for id. The id member
Ronald Cronab99ac22020-10-01 16:38:28 +02004300 * is used to indicate to psa_cipher_abort that there are resources to free,
Ronald Cron49fafa92021-03-10 08:34:23 +01004301 * so we only set it (in the driver wrapper) after resources have been
4302 * allocated/initialized. */
Ronald Cronab99ac22020-10-01 16:38:28 +02004303 operation->iv_set = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004304 if (alg == PSA_ALG_ECB_NO_PADDING) {
Ronald Cronab99ac22020-10-01 16:38:28 +02004305 operation->iv_required = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004306 } else {
Ronald Cronab99ac22020-10-01 16:38:28 +02004307 operation->iv_required = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004308 }
4309 operation->default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
Ronald Cronab99ac22020-10-01 16:38:28 +02004310
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004311 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004312 .core = slot->attr
Ronald Crona4af55f2020-12-14 14:36:06 +01004313 };
4314
Ronald Cronab99ac22020-10-01 16:38:28 +02004315 /* Try doing the operation through a driver before using software fallback. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004316 if (cipher_operation == MBEDTLS_ENCRYPT) {
4317 status = psa_driver_wrapper_cipher_encrypt_setup(operation,
4318 &attributes,
4319 slot->key.data,
4320 slot->key.bytes,
4321 alg);
4322 } else {
4323 status = psa_driver_wrapper_cipher_decrypt_setup(operation,
4324 &attributes,
4325 slot->key.data,
4326 slot->key.bytes,
4327 alg);
4328 }
Ronald Cronab99ac22020-10-01 16:38:28 +02004329
Gilles Peskine9ab61b62019-02-25 17:43:14 +01004330exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004331 if (status != PSA_SUCCESS) {
4332 psa_cipher_abort(operation);
4333 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02004334
Gilles Peskine449bd832023-01-11 14:50:10 +01004335 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02004336
Gilles Peskine449bd832023-01-11 14:50:10 +01004337 return (status == PSA_SUCCESS) ? unlock_status : status;
mohammad1603503973b2018-03-12 15:59:30 +02004338}
4339
Gilles Peskine449bd832023-01-11 14:50:10 +01004340psa_status_t psa_cipher_encrypt_setup(psa_cipher_operation_t *operation,
4341 mbedtls_svc_key_id_t key,
4342 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004343{
Gilles Peskine449bd832023-01-11 14:50:10 +01004344 return psa_cipher_setup(operation, key, alg, MBEDTLS_ENCRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004345}
4346
Gilles Peskine449bd832023-01-11 14:50:10 +01004347psa_status_t psa_cipher_decrypt_setup(psa_cipher_operation_t *operation,
4348 mbedtls_svc_key_id_t key,
4349 psa_algorithm_t alg)
mohammad16038481e742018-03-18 13:57:31 +02004350{
Gilles Peskine449bd832023-01-11 14:50:10 +01004351 return psa_cipher_setup(operation, key, alg, MBEDTLS_DECRYPT);
mohammad16038481e742018-03-18 13:57:31 +02004352}
4353
Gilles Peskine449bd832023-01-11 14:50:10 +01004354psa_status_t psa_cipher_generate_iv(psa_cipher_operation_t *operation,
4355 uint8_t *iv,
4356 size_t iv_size,
4357 size_t *iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004358{
Ronald Cron6d051732020-10-01 14:10:20 +02004359 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2fb90522021-07-05 12:31:44 +02004360 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004361 size_t default_iv_length = 0;
Ronald Cron5618a392021-03-26 09:52:26 +01004362
Gilles Peskine449bd832023-01-11 14:50:10 +01004363 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004364 status = PSA_ERROR_BAD_STATE;
4365 goto exit;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004366 }
4367
Gilles Peskine449bd832023-01-11 14:50:10 +01004368 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004369 status = PSA_ERROR_BAD_STATE;
4370 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004371 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004372
Ronald Cron2fb90522021-07-05 12:31:44 +02004373 default_iv_length = operation->default_iv_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004374 if (iv_size < default_iv_length) {
Ronald Cron5618a392021-03-26 09:52:26 +01004375 status = PSA_ERROR_BUFFER_TOO_SMALL;
4376 goto exit;
4377 }
Gilles Peskinee553c652018-06-04 16:22:46 +02004378
Gilles Peskine449bd832023-01-11 14:50:10 +01004379 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cron2fb90522021-07-05 12:31:44 +02004380 status = PSA_ERROR_GENERIC_ERROR;
4381 goto exit;
4382 }
4383
Gilles Peskine449bd832023-01-11 14:50:10 +01004384 status = psa_generate_random(local_iv, default_iv_length);
4385 if (status != PSA_SUCCESS) {
Ronald Cron5618a392021-03-26 09:52:26 +01004386 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004387 }
Ronald Cron5618a392021-03-26 09:52:26 +01004388
Gilles Peskine449bd832023-01-11 14:50:10 +01004389 status = psa_driver_wrapper_cipher_set_iv(operation,
4390 local_iv, default_iv_length);
Ronald Cron5618a392021-03-26 09:52:26 +01004391
4392exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004393 if (status == PSA_SUCCESS) {
4394 memcpy(iv, local_iv, default_iv_length);
Ronald Cron2fb90522021-07-05 12:31:44 +02004395 *iv_length = default_iv_length;
Steven Cooreman7df02922020-09-09 15:28:49 +02004396 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004397 } else {
Ronald Cron2fb90522021-07-05 12:31:44 +02004398 *iv_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004399 psa_cipher_abort(operation);
Ronald Cron2fb90522021-07-05 12:31:44 +02004400 }
Ronald Cron6d051732020-10-01 14:10:20 +02004401
Gilles Peskine449bd832023-01-11 14:50:10 +01004402 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004403}
4404
Gilles Peskine449bd832023-01-11 14:50:10 +01004405psa_status_t psa_cipher_set_iv(psa_cipher_operation_t *operation,
4406 const uint8_t *iv,
4407 size_t iv_length)
mohammad1603503973b2018-03-12 15:59:30 +02004408{
Ronald Cron6d051732020-10-01 14:10:20 +02004409 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronc45b4af2020-09-29 16:18:05 +02004410
Gilles Peskine449bd832023-01-11 14:50:10 +01004411 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004412 status = PSA_ERROR_BAD_STATE;
4413 goto exit;
4414 }
Ronald Cronc45b4af2020-09-29 16:18:05 +02004415
Gilles Peskine449bd832023-01-11 14:50:10 +01004416 if (operation->iv_set || !operation->iv_required) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004417 status = PSA_ERROR_BAD_STATE;
4418 goto exit;
4419 }
Ronald Crona0d68172021-03-26 10:15:08 +01004420
Gilles Peskine449bd832023-01-11 14:50:10 +01004421 if (iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004422 status = PSA_ERROR_INVALID_ARGUMENT;
4423 goto exit;
4424 }
Steven Cooremand3feccd2020-09-01 15:56:14 +02004425
Gilles Peskine449bd832023-01-11 14:50:10 +01004426 status = psa_driver_wrapper_cipher_set_iv(operation,
4427 iv,
4428 iv_length);
Steven Cooremand3feccd2020-09-01 15:56:14 +02004429
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004430exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004431 if (status == PSA_SUCCESS) {
itayzafrir534bd7c2018-08-02 13:56:32 +03004432 operation->iv_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01004433 } else {
4434 psa_cipher_abort(operation);
4435 }
4436 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004437}
4438
Gilles Peskine449bd832023-01-11 14:50:10 +01004439psa_status_t psa_cipher_update(psa_cipher_operation_t *operation,
4440 const uint8_t *input,
4441 size_t input_length,
4442 uint8_t *output,
4443 size_t output_size,
4444 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004445{
Steven Cooremanffecb7b2020-08-25 15:13:13 +02004446 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron6d051732020-10-01 14:10:20 +02004447
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004449 status = PSA_ERROR_BAD_STATE;
4450 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004451 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004452
Gilles Peskine449bd832023-01-11 14:50:10 +01004453 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004454 status = PSA_ERROR_BAD_STATE;
4455 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004456 }
Jaeden Ameroab439972019-02-15 14:12:05 +00004457
Gilles Peskine449bd832023-01-11 14:50:10 +01004458 status = psa_driver_wrapper_cipher_update(operation,
4459 input,
4460 input_length,
4461 output,
4462 output_size,
4463 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004464
4465exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004466 if (status != PSA_SUCCESS) {
4467 psa_cipher_abort(operation);
4468 }
Ronald Cron6d051732020-10-01 14:10:20 +02004469
Gilles Peskine449bd832023-01-11 14:50:10 +01004470 return status;
mohammad1603503973b2018-03-12 15:59:30 +02004471}
4472
Gilles Peskine449bd832023-01-11 14:50:10 +01004473psa_status_t psa_cipher_finish(psa_cipher_operation_t *operation,
4474 uint8_t *output,
4475 size_t output_size,
4476 size_t *output_length)
mohammad1603503973b2018-03-12 15:59:30 +02004477{
David Saadab4ecc272019-02-14 13:48:10 +02004478 psa_status_t status = PSA_ERROR_GENERIC_ERROR;
Ronald Cron6d051732020-10-01 14:10:20 +02004479
Gilles Peskine449bd832023-01-11 14:50:10 +01004480 if (operation->id == 0) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004481 status = PSA_ERROR_BAD_STATE;
4482 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004483 }
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004484
Gilles Peskine449bd832023-01-11 14:50:10 +01004485 if (operation->iv_required && !operation->iv_set) {
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004486 status = PSA_ERROR_BAD_STATE;
4487 goto exit;
Steven Cooreman7df02922020-09-09 15:28:49 +02004488 }
Moran Pekerbed71a22018-04-22 20:19:20 +03004489
Gilles Peskine449bd832023-01-11 14:50:10 +01004490 status = psa_driver_wrapper_cipher_finish(operation,
4491 output,
4492 output_size,
4493 output_length);
Dave Rodgman38e62ae2021-06-23 11:38:39 +01004494
4495exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004496 if (status == PSA_SUCCESS) {
4497 return psa_cipher_abort(operation);
4498 } else {
Steven Cooremanef8575e2020-09-11 11:44:50 +02004499 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004500 (void) psa_cipher_abort(operation);
Janos Follath315b51c2018-07-09 16:04:51 +01004501
Gilles Peskine449bd832023-01-11 14:50:10 +01004502 return status;
Steven Cooremanef8575e2020-09-11 11:44:50 +02004503 }
mohammad1603503973b2018-03-12 15:59:30 +02004504}
4505
Gilles Peskine449bd832023-01-11 14:50:10 +01004506psa_status_t psa_cipher_abort(psa_cipher_operation_t *operation)
Gilles Peskinee553c652018-06-04 16:22:46 +02004507{
Gilles Peskine449bd832023-01-11 14:50:10 +01004508 if (operation->id == 0) {
Steven Cooremana07b9972020-09-10 14:54:14 +02004509 /* The object has (apparently) been initialized but it is not (yet)
Gilles Peskine81736312018-06-26 15:04:31 +02004510 * in use. It's ok to call abort on such an object, and there's
4511 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 return PSA_SUCCESS;
Gilles Peskine81736312018-06-26 15:04:31 +02004513 }
Gilles Peskine16c0f4f2018-06-20 16:05:20 +02004514
Gilles Peskine449bd832023-01-11 14:50:10 +01004515 psa_driver_wrapper_cipher_abort(operation);
Gilles Peskinee553c652018-06-04 16:22:46 +02004516
Ronald Cron49fafa92021-03-10 08:34:23 +01004517 operation->id = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004518 operation->iv_set = 0;
Moran Pekerad9d82c2018-04-30 12:31:04 +03004519 operation->iv_required = 0;
Moran Peker41deec42018-04-04 15:43:05 +03004520
Gilles Peskine449bd832023-01-11 14:50:10 +01004521 return PSA_SUCCESS;
mohammad1603503973b2018-03-12 15:59:30 +02004522}
4523
Gilles Peskine449bd832023-01-11 14:50:10 +01004524psa_status_t psa_cipher_encrypt(mbedtls_svc_key_id_t key,
4525 psa_algorithm_t alg,
David Horstmann36df4b22023-12-13 15:55:25 +00004526 const uint8_t *input_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 size_t input_length,
David Horstmann36df4b22023-12-13 15:55:25 +00004528 uint8_t *output_external,
Gilles Peskine449bd832023-01-11 14:50:10 +01004529 size_t output_size,
4530 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004531{
4532 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004533 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004534 psa_key_slot_t *slot = NULL;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004535 uint8_t local_iv[PSA_CIPHER_IV_MAX_SIZE];
4536 size_t default_iv_length = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004537 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004538
David Horstmann62a56d92023-12-14 18:12:47 +00004539 LOCAL_INPUT_DECLARE(input_external, input);
4540 LOCAL_OUTPUT_DECLARE(output_external, output);
4541
David Horstmann36df4b22023-12-13 15:55:25 +00004542 LOCAL_INPUT_ALLOC(input_external, input_length, input);
David Horstmann36df4b22023-12-13 15:55:25 +00004543 LOCAL_OUTPUT_ALLOC(output_external, output_size, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004544
Gilles Peskine449bd832023-01-11 14:50:10 +01004545 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004546 status = PSA_ERROR_INVALID_ARGUMENT;
4547 goto exit;
4548 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004549
Gilles Peskine449bd832023-01-11 14:50:10 +01004550 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4551 PSA_KEY_USAGE_ENCRYPT,
4552 alg);
4553 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004554 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004555 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004556
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004557 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004558 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004559 };
4560
Gilles Peskine449bd832023-01-11 14:50:10 +01004561 default_iv_length = PSA_CIPHER_IV_LENGTH(slot->attr.type, alg);
4562 if (default_iv_length > PSA_CIPHER_IV_MAX_SIZE) {
Ronald Cronc6e6f502021-07-09 18:44:58 +02004563 status = PSA_ERROR_GENERIC_ERROR;
4564 goto exit;
4565 }
4566
Gilles Peskine449bd832023-01-11 14:50:10 +01004567 if (default_iv_length > 0) {
4568 if (output_size < default_iv_length) {
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004569 status = PSA_ERROR_BUFFER_TOO_SMALL;
4570 goto exit;
4571 }
4572
Gilles Peskine449bd832023-01-11 14:50:10 +01004573 status = psa_generate_random(local_iv, default_iv_length);
4574 if (status != PSA_SUCCESS) {
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004575 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004576 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004577 }
4578
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004579 status = psa_driver_wrapper_cipher_encrypt(
4580 &attributes, slot->key.data, slot->key.bytes,
Ronald Cronc6e6f502021-07-09 18:44:58 +02004581 alg, local_iv, default_iv_length, input, input_length,
Ronald Cronafbc7ed2023-01-24 16:02:04 +01004582 psa_crypto_buffer_offset(output, default_iv_length),
Gilles Peskine449bd832023-01-11 14:50:10 +01004583 output_size - default_iv_length, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004584
4585exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004586 unlock_status = psa_unlock_key_slot(slot);
4587 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004588 status = unlock_status;
Ronald Cronc6e6f502021-07-09 18:44:58 +02004589 }
Ronald Cron23919522021-07-08 19:00:07 +02004590
Gilles Peskine449bd832023-01-11 14:50:10 +01004591 if (status == PSA_SUCCESS) {
4592 if (default_iv_length > 0) {
4593 memcpy(output, local_iv, default_iv_length);
4594 }
4595 *output_length += default_iv_length;
4596 } else {
4597 *output_length = 0;
4598 }
4599
David Horstmann62a56d92023-12-14 18:12:47 +00004600 LOCAL_INPUT_FREE(input_external, input);
4601 LOCAL_OUTPUT_FREE(output_external, output);
David Horstmannc6977b42023-11-27 17:43:05 +00004602
Gilles Peskine449bd832023-01-11 14:50:10 +01004603 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004604}
4605
Gilles Peskine449bd832023-01-11 14:50:10 +01004606psa_status_t psa_cipher_decrypt(mbedtls_svc_key_id_t key,
4607 psa_algorithm_t alg,
4608 const uint8_t *input,
4609 size_t input_length,
4610 uint8_t *output,
4611 size_t output_size,
4612 size_t *output_length)
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004613{
4614 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004615 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron23919522021-07-08 19:00:07 +02004616 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004617 psa_key_attributes_t attributes;
gabor-mezei-arm6f4e5bb2021-06-25 15:21:11 +02004618
Gilles Peskine449bd832023-01-11 14:50:10 +01004619 if (!PSA_ALG_IS_CIPHER(alg)) {
Ronald Cron23919522021-07-08 19:00:07 +02004620 status = PSA_ERROR_INVALID_ARGUMENT;
4621 goto exit;
4622 }
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004623
Gilles Peskine449bd832023-01-11 14:50:10 +01004624 status = psa_get_and_lock_key_slot_with_policy(key, &slot,
4625 PSA_KEY_USAGE_DECRYPT,
4626 alg);
4627 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004628 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004629 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004630
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004631 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01004632 .core = slot->attr
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004633 };
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004634
Gilles Peskine449bd832023-01-11 14:50:10 +01004635 if (alg == PSA_ALG_CCM_STAR_NO_TAG &&
4636 input_length < PSA_BLOCK_CIPHER_BLOCK_LENGTH(slot->attr.type)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +02004637 status = PSA_ERROR_INVALID_ARGUMENT;
4638 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004639 } else if (input_length < PSA_CIPHER_IV_LENGTH(slot->attr.type, alg)) {
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004640 status = PSA_ERROR_INVALID_ARGUMENT;
4641 goto exit;
4642 }
4643
gabor-mezei-arma9449a02021-03-25 11:17:10 +01004644 status = psa_driver_wrapper_cipher_decrypt(
4645 &attributes, slot->key.data, slot->key.bytes,
4646 alg, input, input_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004647 output, output_size, output_length);
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004648
gabor-mezei-arm258ae072021-06-25 15:25:38 +02004649exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004650 unlock_status = psa_unlock_key_slot(slot);
4651 if (status == PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004652 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004653 }
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004654
Gilles Peskine449bd832023-01-11 14:50:10 +01004655 if (status != PSA_SUCCESS) {
Ronald Cron23919522021-07-08 19:00:07 +02004656 *output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01004657 }
Ronald Cron23919522021-07-08 19:00:07 +02004658
Gilles Peskine449bd832023-01-11 14:50:10 +01004659 return status;
gabor-mezei-armba0fa752021-03-01 15:04:24 +01004660}
4661
4662
mohammad16035955c982018-04-26 00:53:03 +03004663/****************************************************************/
4664/* AEAD */
4665/****************************************************************/
Gilles Peskine7bcfc0a2018-06-18 21:49:39 +02004666
Paul Elliottbaff51c2021-09-28 17:44:45 +01004667/* Helper function to get the base algorithm from its variants. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004668static psa_algorithm_t psa_aead_get_base_algorithm(psa_algorithm_t alg)
Paul Elliottbaff51c2021-09-28 17:44:45 +01004669{
Gilles Peskine449bd832023-01-11 14:50:10 +01004670 return PSA_ALG_AEAD_WITH_DEFAULT_LENGTH_TAG(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004671}
4672
4673/* Helper function to perform common nonce length checks. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004674static psa_status_t psa_aead_check_nonce_length(psa_algorithm_t alg,
4675 size_t nonce_length)
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004676{
Gilles Peskine449bd832023-01-11 14:50:10 +01004677 psa_algorithm_t base_alg = psa_aead_get_base_algorithm(alg);
Paul Elliottbaff51c2021-09-28 17:44:45 +01004678
Gilles Peskine449bd832023-01-11 14:50:10 +01004679 switch (base_alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004680#if defined(PSA_WANT_ALG_GCM)
4681 case PSA_ALG_GCM:
4682 /* Not checking max nonce size here as GCM spec allows almost
Gilles Peskine449bd832023-01-11 14:50:10 +01004683 * arbitrarily large nonces. Please note that we do not generally
4684 * recommend the usage of nonces of greater length than
4685 * PSA_AEAD_NONCE_MAX_SIZE, as large nonces are hashed to a shorter
4686 * size, which can then lead to collisions if you encrypt a very
4687 * large number of messages.*/
4688 if (nonce_length != 0) {
4689 return PSA_SUCCESS;
4690 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004691 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004692#endif /* PSA_WANT_ALG_GCM */
4693#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004694 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01004695 if (nonce_length >= 7 && nonce_length <= 13) {
4696 return PSA_SUCCESS;
4697 }
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004698 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004699#endif /* PSA_WANT_ALG_CCM */
4700#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004701 case PSA_ALG_CHACHA20_POLY1305:
Gilles Peskine449bd832023-01-11 14:50:10 +01004702 if (nonce_length == 12) {
4703 return PSA_SUCCESS;
4704 } else if (nonce_length == 8) {
4705 return PSA_ERROR_NOT_SUPPORTED;
4706 }
Bence Szépkúti6d48e202021-11-15 20:04:15 +01004707 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01004708#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004709 default:
Przemek Stekiel4c499272022-09-27 13:55:37 +02004710 (void) nonce_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01004711 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02004712 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004713
Gilles Peskine449bd832023-01-11 14:50:10 +01004714 return PSA_ERROR_INVALID_ARGUMENT;
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004715}
4716
Gilles Peskine449bd832023-01-11 14:50:10 +01004717static psa_status_t psa_aead_check_algorithm(psa_algorithm_t alg)
Bence Szépkútiaa3a6e42022-01-13 16:26:03 +01004718{
Gilles Peskine449bd832023-01-11 14:50:10 +01004719 if (!PSA_ALG_IS_AEAD(alg) || PSA_ALG_IS_WILDCARD(alg)) {
4720 return PSA_ERROR_INVALID_ARGUMENT;
4721 }
Bence Szépkúti08f34652021-12-08 21:07:13 +01004722
Gilles Peskine449bd832023-01-11 14:50:10 +01004723 return PSA_SUCCESS;
Bence Szépkúti08f34652021-12-08 21:07:13 +01004724}
4725
Gilles Peskine449bd832023-01-11 14:50:10 +01004726psa_status_t psa_aead_encrypt(mbedtls_svc_key_id_t key,
4727 psa_algorithm_t alg,
4728 const uint8_t *nonce,
4729 size_t nonce_length,
4730 const uint8_t *additional_data,
4731 size_t additional_data_length,
4732 const uint8_t *plaintext,
4733 size_t plaintext_length,
4734 uint8_t *ciphertext,
4735 size_t ciphertext_size,
4736 size_t *ciphertext_length)
mohammad16035955c982018-04-26 00:53:03 +03004737{
Ronald Cron215633c2021-03-16 17:15:37 +01004738 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4739 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004740
mohammad1603f08a5502018-06-03 15:05:47 +03004741 *ciphertext_length = 0;
mohammad1603e58e6842018-05-09 04:58:32 -07004742
Gilles Peskine449bd832023-01-11 14:50:10 +01004743 status = psa_aead_check_algorithm(alg);
4744 if (status != PSA_SUCCESS) {
4745 return status;
4746 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004747
Ronald Cron9a986162021-03-26 12:40:07 +01004748 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004749 key, &slot, PSA_KEY_USAGE_ENCRYPT, alg);
4750 if (status != PSA_SUCCESS) {
4751 return status;
4752 }
mohammad16035955c982018-04-26 00:53:03 +03004753
Ronald Cron215633c2021-03-16 17:15:37 +01004754 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004755 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004756 };
mohammad16035955c982018-04-26 00:53:03 +03004757
Gilles Peskine449bd832023-01-11 14:50:10 +01004758 status = psa_aead_check_nonce_length(alg, nonce_length);
4759 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004760 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004761 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004762
Ronald Cronde822812021-03-17 16:08:20 +01004763 status = psa_driver_wrapper_aead_encrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004764 &attributes, slot->key.data, slot->key.bytes,
4765 alg,
4766 nonce, nonce_length,
4767 additional_data, additional_data_length,
4768 plaintext, plaintext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004769 ciphertext, ciphertext_size, ciphertext_length);
Gilles Peskine2d277862018-06-18 15:41:12 +02004770
Gilles Peskine449bd832023-01-11 14:50:10 +01004771 if (status != PSA_SUCCESS && ciphertext_size != 0) {
4772 memset(ciphertext, 0, ciphertext_size);
4773 }
Gilles Peskine2d277862018-06-18 15:41:12 +02004774
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004775exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004776 psa_unlock_key_slot(slot);
mohammad16035955c982018-04-26 00:53:03 +03004777
Gilles Peskine449bd832023-01-11 14:50:10 +01004778 return status;
Gilles Peskineee652a32018-06-01 19:23:52 +02004779}
4780
Gilles Peskine449bd832023-01-11 14:50:10 +01004781psa_status_t psa_aead_decrypt(mbedtls_svc_key_id_t key,
4782 psa_algorithm_t alg,
4783 const uint8_t *nonce,
4784 size_t nonce_length,
4785 const uint8_t *additional_data,
4786 size_t additional_data_length,
4787 const uint8_t *ciphertext,
4788 size_t ciphertext_length,
4789 uint8_t *plaintext,
4790 size_t plaintext_size,
4791 size_t *plaintext_length)
mohammad16035955c982018-04-26 00:53:03 +03004792{
Ronald Cron215633c2021-03-16 17:15:37 +01004793 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4794 psa_key_slot_t *slot;
Gilles Peskine2d277862018-06-18 15:41:12 +02004795
Gilles Peskineee652a32018-06-01 19:23:52 +02004796 *plaintext_length = 0;
mohammad16039e5a5152018-04-26 12:07:35 +03004797
Gilles Peskine449bd832023-01-11 14:50:10 +01004798 status = psa_aead_check_algorithm(alg);
4799 if (status != PSA_SUCCESS) {
4800 return status;
4801 }
Steven Cooremanea7ab132021-03-17 16:28:00 +01004802
Ronald Cron9a986162021-03-26 12:40:07 +01004803 status = psa_get_and_lock_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01004804 key, &slot, PSA_KEY_USAGE_DECRYPT, alg);
4805 if (status != PSA_SUCCESS) {
4806 return status;
4807 }
mohammad16035955c982018-04-26 00:53:03 +03004808
Ronald Cron215633c2021-03-16 17:15:37 +01004809 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01004810 .core = slot->attr
Ronald Cron215633c2021-03-16 17:15:37 +01004811 };
Gilles Peskinef7e7b012019-05-06 15:27:16 +02004812
Gilles Peskine449bd832023-01-11 14:50:10 +01004813 status = psa_aead_check_nonce_length(alg, nonce_length);
4814 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004815 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004816 }
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004817
Ronald Cronde822812021-03-17 16:08:20 +01004818 status = psa_driver_wrapper_aead_decrypt(
Ronald Cron215633c2021-03-16 17:15:37 +01004819 &attributes, slot->key.data, slot->key.bytes,
4820 alg,
4821 nonce, nonce_length,
4822 additional_data, additional_data_length,
4823 ciphertext, ciphertext_length,
Gilles Peskine449bd832023-01-11 14:50:10 +01004824 plaintext, plaintext_size, plaintext_length);
Gilles Peskinea40d7742018-06-01 16:28:30 +02004825
Gilles Peskine449bd832023-01-11 14:50:10 +01004826 if (status != PSA_SUCCESS && plaintext_size != 0) {
4827 memset(plaintext, 0, plaintext_size);
4828 }
mohammad160360a64d02018-06-03 17:20:42 +03004829
Paul Elliottbb0f9e12021-09-28 11:14:27 +01004830exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004831 psa_unlock_key_slot(slot);
Ronald Cron215633c2021-03-16 17:15:37 +01004832
Gilles Peskine449bd832023-01-11 14:50:10 +01004833 return status;
mohammad16035955c982018-04-26 00:53:03 +03004834}
4835
Gilles Peskine449bd832023-01-11 14:50:10 +01004836static psa_status_t psa_validate_tag_length(psa_algorithm_t alg)
4837{
4838 const uint8_t tag_len = PSA_ALG_AEAD_GET_TAG_LENGTH(alg);
Andrzej Kurekf8816012021-12-19 17:00:12 +01004839
Gilles Peskine449bd832023-01-11 14:50:10 +01004840 switch (PSA_ALG_AEAD_WITH_SHORTENED_TAG(alg, 0)) {
Przemek Stekiel86679c72022-10-06 17:06:56 +02004841#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004842 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004843 /* CCM allows the following tag lengths: 4, 6, 8, 10, 12, 14, 16.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01004844 if (tag_len < 4 || tag_len > 16 || tag_len % 2) {
4845 return PSA_ERROR_INVALID_ARGUMENT;
4846 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004847 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004848#endif /* PSA_WANT_ALG_CCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004849
Przemek Stekiel86679c72022-10-06 17:06:56 +02004850#if defined(PSA_WANT_ALG_GCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01004851 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004852 /* GCM allows the following tag lengths: 4, 8, 12, 13, 14, 15, 16. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004853 if (tag_len != 4 && tag_len != 8 && (tag_len < 12 || tag_len > 16)) {
4854 return PSA_ERROR_INVALID_ARGUMENT;
4855 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004856 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004857#endif /* PSA_WANT_ALG_GCM */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004858
Przemek Stekiel86679c72022-10-06 17:06:56 +02004859#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Gilles Peskine449bd832023-01-11 14:50:10 +01004860 case PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CHACHA20_POLY1305, 0):
Andrzej Kurekf8816012021-12-19 17:00:12 +01004861 /* We only support the default tag length. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004862 if (tag_len != 16) {
4863 return PSA_ERROR_INVALID_ARGUMENT;
4864 }
Andrzej Kurekf8816012021-12-19 17:00:12 +01004865 break;
Przemek Stekiel86679c72022-10-06 17:06:56 +02004866#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Andrzej Kurekf8816012021-12-19 17:00:12 +01004867
4868 default:
4869 (void) tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01004870 return PSA_ERROR_NOT_SUPPORTED;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004871 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004872 return PSA_SUCCESS;
Andrzej Kurekf8816012021-12-19 17:00:12 +01004873}
4874
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004875/* Set the key for a multipart authenticated operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004876static psa_status_t psa_aead_setup(psa_aead_operation_t *operation,
4877 int is_encrypt,
4878 mbedtls_svc_key_id_t key,
4879 psa_algorithm_t alg)
Paul Elliottc2b71442021-06-24 18:17:52 +01004880{
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004881 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
4882 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
4883 psa_key_slot_t *slot = NULL;
4884 psa_key_usage_t key_usage = 0;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004885 psa_key_attributes_t attributes;
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004886
Gilles Peskine449bd832023-01-11 14:50:10 +01004887 status = psa_aead_check_algorithm(alg);
4888 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004889 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004890 }
Paul Elliottc2b71442021-06-24 18:17:52 +01004891
Gilles Peskine449bd832023-01-11 14:50:10 +01004892 if (operation->id != 0) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004893 status = PSA_ERROR_BAD_STATE;
4894 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004895 }
4896
Gilles Peskine449bd832023-01-11 14:50:10 +01004897 if (operation->nonce_set || operation->lengths_set ||
4898 operation->ad_started || operation->body_started) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004899 status = PSA_ERROR_BAD_STATE;
4900 goto exit;
Paul Elliottc2b71442021-06-24 18:17:52 +01004901 }
4902
Gilles Peskine449bd832023-01-11 14:50:10 +01004903 if (is_encrypt) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004904 key_usage = PSA_KEY_USAGE_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004905 } else {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004906 key_usage = PSA_KEY_USAGE_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +01004907 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004908
Gilles Peskine449bd832023-01-11 14:50:10 +01004909 status = psa_get_and_lock_key_slot_with_policy(key, &slot, key_usage,
4910 alg);
4911 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004912 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004913 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004914
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01004915 attributes = (psa_key_attributes_t) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004916 .core = slot->attr
4917 };
4918
Gilles Peskine449bd832023-01-11 14:50:10 +01004919 if ((status = psa_validate_tag_length(alg)) != PSA_SUCCESS) {
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004920 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004921 }
Przemek Stekiel6ab50762022-10-08 17:54:30 +02004922
Gilles Peskine449bd832023-01-11 14:50:10 +01004923 if (is_encrypt) {
4924 status = psa_driver_wrapper_aead_encrypt_setup(operation,
4925 &attributes,
4926 slot->key.data,
4927 slot->key.bytes,
4928 alg);
4929 } else {
4930 status = psa_driver_wrapper_aead_decrypt_setup(operation,
4931 &attributes,
4932 slot->key.data,
4933 slot->key.bytes,
4934 alg);
4935 }
4936 if (status != PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004937 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01004938 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004939
Gilles Peskine449bd832023-01-11 14:50:10 +01004940 operation->key_type = psa_get_key_type(&attributes);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004941
4942exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01004943 unlock_status = psa_unlock_key_slot(slot);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004944
Gilles Peskine449bd832023-01-11 14:50:10 +01004945 if (status == PSA_SUCCESS) {
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004946 status = unlock_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01004947 operation->alg = psa_aead_get_base_algorithm(alg);
Paul Elliottd9343f22021-08-23 18:59:49 +01004948 operation->is_encrypt = is_encrypt;
Gilles Peskine449bd832023-01-11 14:50:10 +01004949 } else {
4950 psa_aead_abort(operation);
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004951 }
Paul Elliotte0a12bd2021-08-19 18:55:56 +01004952
Gilles Peskine449bd832023-01-11 14:50:10 +01004953 return status;
Paul Elliottc2b71442021-06-24 18:17:52 +01004954}
4955
Paul Elliott302ff6b2021-04-20 18:10:30 +01004956/* Set the key for a multipart authenticated encryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004957psa_status_t psa_aead_encrypt_setup(psa_aead_operation_t *operation,
4958 mbedtls_svc_key_id_t key,
4959 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004960{
Gilles Peskine449bd832023-01-11 14:50:10 +01004961 return psa_aead_setup(operation, 1, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004962}
4963
4964/* Set the key for a multipart authenticated decryption operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01004965psa_status_t psa_aead_decrypt_setup(psa_aead_operation_t *operation,
4966 mbedtls_svc_key_id_t key,
4967 psa_algorithm_t alg)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004968{
Gilles Peskine449bd832023-01-11 14:50:10 +01004969 return psa_aead_setup(operation, 0, key, alg);
Paul Elliott302ff6b2021-04-20 18:10:30 +01004970}
4971
4972/* Generate a random nonce / IV for multipart AEAD operation */
Gilles Peskine449bd832023-01-11 14:50:10 +01004973psa_status_t psa_aead_generate_nonce(psa_aead_operation_t *operation,
4974 uint8_t *nonce,
4975 size_t nonce_size,
4976 size_t *nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01004977{
4978 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Croncae59092021-11-26 18:53:58 +01004979 uint8_t local_nonce[PSA_AEAD_NONCE_MAX_SIZE];
Sergeybef1f632023-03-06 15:25:06 -07004980 size_t required_nonce_size = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004981
Paul Elliott8eb9daf2021-06-04 16:42:21 +01004982 *nonce_length = 0;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004983
Gilles Peskine449bd832023-01-11 14:50:10 +01004984 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01004985 status = PSA_ERROR_BAD_STATE;
4986 goto exit;
4987 }
4988
Gilles Peskine449bd832023-01-11 14:50:10 +01004989 if (operation->nonce_set || !operation->is_encrypt) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01004990 status = PSA_ERROR_BAD_STATE;
4991 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01004992 }
4993
Paul Elliotte193ea82021-10-01 13:00:16 +01004994 /* For CCM, this size may not be correct according to the PSA
4995 * specification. The PSA Crypto 1.0.1 specification states:
4996 *
4997 * CCM encodes the plaintext length pLen in L octets, with L the smallest
4998 * integer >= 2 where pLen < 2^(8L). The nonce length is then 15 - L bytes.
4999 *
5000 * However this restriction that L has to be the smallest integer is not
5001 * applied in practice, and it is not implementable here since the
5002 * plaintext length may or may not be known at this time. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005003 required_nonce_size = PSA_AEAD_NONCE_LENGTH(operation->key_type,
5004 operation->alg);
5005 if (nonce_size < required_nonce_size) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005006 status = PSA_ERROR_BUFFER_TOO_SMALL;
5007 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005008 }
5009
Gilles Peskine449bd832023-01-11 14:50:10 +01005010 status = psa_generate_random(local_nonce, required_nonce_size);
5011 if (status != PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005012 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005013 }
Paul Elliott302ff6b2021-04-20 18:10:30 +01005014
Gilles Peskine449bd832023-01-11 14:50:10 +01005015 status = psa_aead_set_nonce(operation, local_nonce, required_nonce_size);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005016
Paul Elliott39dc6b82021-05-11 19:16:09 +01005017exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005018 if (status == PSA_SUCCESS) {
5019 memcpy(nonce, local_nonce, required_nonce_size);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005020 *nonce_length = required_nonce_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01005021 } else {
5022 psa_aead_abort(operation);
Ronald Croncae59092021-11-26 18:53:58 +01005023 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005024
Gilles Peskine449bd832023-01-11 14:50:10 +01005025 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005026}
5027
5028/* Set the nonce for a multipart authenticated encryption or decryption
5029 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005030psa_status_t psa_aead_set_nonce(psa_aead_operation_t *operation,
5031 const uint8_t *nonce,
5032 size_t nonce_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005033{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005034 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5035
Gilles Peskine449bd832023-01-11 14:50:10 +01005036 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005037 status = PSA_ERROR_BAD_STATE;
5038 goto exit;
5039 }
5040
Gilles Peskine449bd832023-01-11 14:50:10 +01005041 if (operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005042 status = PSA_ERROR_BAD_STATE;
5043 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005044 }
5045
Gilles Peskine449bd832023-01-11 14:50:10 +01005046 status = psa_aead_check_nonce_length(operation->alg, nonce_length);
5047 if (status != PSA_SUCCESS) {
Paul Elliottbb0f9e12021-09-28 11:14:27 +01005048 status = PSA_ERROR_INVALID_ARGUMENT;
5049 goto exit;
Paul Elliott4ed1ed12021-09-27 18:09:28 +01005050 }
Paul Elliott1a98aca2021-05-20 18:24:07 +01005051
Gilles Peskine449bd832023-01-11 14:50:10 +01005052 status = psa_driver_wrapper_aead_set_nonce(operation, nonce,
5053 nonce_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005054
Paul Elliott39dc6b82021-05-11 19:16:09 +01005055exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005056 if (status == PSA_SUCCESS) {
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005057 operation->nonce_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005058 } else {
5059 psa_aead_abort(operation);
5060 }
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005061
Gilles Peskine449bd832023-01-11 14:50:10 +01005062 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005063}
5064
5065/* Declare the lengths of the message and additional data for multipart AEAD. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005066psa_status_t psa_aead_set_lengths(psa_aead_operation_t *operation,
5067 size_t ad_length,
5068 size_t plaintext_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005069{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005070 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5071
Gilles Peskine449bd832023-01-11 14:50:10 +01005072 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005073 status = PSA_ERROR_BAD_STATE;
5074 goto exit;
5075 }
5076
Gilles Peskine449bd832023-01-11 14:50:10 +01005077 if (operation->lengths_set || operation->ad_started ||
5078 operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005079 status = PSA_ERROR_BAD_STATE;
5080 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005081 }
5082
Gilles Peskine449bd832023-01-11 14:50:10 +01005083 switch (operation->alg) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005084#if defined(PSA_WANT_ALG_GCM)
5085 case PSA_ALG_GCM:
5086 /* Lengths can only be too large for GCM if size_t is bigger than 32
Gilles Peskine449bd832023-01-11 14:50:10 +01005087 * bits. Without the guard this code will generate warnings on 32bit
5088 * builds. */
Paul Elliott325d3742021-09-27 17:56:28 +01005089#if SIZE_MAX > UINT32_MAX
Gilles Peskine449bd832023-01-11 14:50:10 +01005090 if (((uint64_t) ad_length) >> 61 != 0 ||
5091 ((uint64_t) plaintext_length) > 0xFFFFFFFE0ull) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005092 status = PSA_ERROR_INVALID_ARGUMENT;
5093 goto exit;
5094 }
Paul Elliott325d3742021-09-27 17:56:28 +01005095#endif
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005096 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005097#endif /* PSA_WANT_ALG_GCM */
5098#if defined(PSA_WANT_ALG_CCM)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005099 case PSA_ALG_CCM:
Gilles Peskine449bd832023-01-11 14:50:10 +01005100 if (ad_length > 0xFF00) {
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005101 status = PSA_ERROR_INVALID_ARGUMENT;
5102 goto exit;
5103 }
5104 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005105#endif /* PSA_WANT_ALG_CCM */
5106#if defined(PSA_WANT_ALG_CHACHA20_POLY1305)
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005107 case PSA_ALG_CHACHA20_POLY1305:
5108 /* No length restrictions for ChaChaPoly. */
5109 break;
Paul Elliotte716e6c2021-09-29 14:10:20 +01005110#endif /* PSA_WANT_ALG_CHACHA20_POLY1305 */
Przemyslaw Stekiel4cad4fc2021-10-13 11:12:08 +02005111 default:
5112 break;
5113 }
Paul Elliott325d3742021-09-27 17:56:28 +01005114
Gilles Peskine449bd832023-01-11 14:50:10 +01005115 status = psa_driver_wrapper_aead_set_lengths(operation, ad_length,
5116 plaintext_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005117
Paul Elliott39dc6b82021-05-11 19:16:09 +01005118exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005119 if (status == PSA_SUCCESS) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005120 operation->ad_remaining = ad_length;
5121 operation->body_remaining = plaintext_length;
Paul Elliott39dc6b82021-05-11 19:16:09 +01005122 operation->lengths_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005123 } else {
5124 psa_aead_abort(operation);
Paul Elliottee4ffe02021-05-20 17:25:06 +01005125 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005126
Gilles Peskine449bd832023-01-11 14:50:10 +01005127 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005128}
Paul Elliott3d7d52c2021-09-01 10:33:14 +01005129
5130/* Pass additional data to an active multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005131psa_status_t psa_aead_update_ad(psa_aead_operation_t *operation,
5132 const uint8_t *input,
5133 size_t input_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005134{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005135 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5136
Gilles Peskine449bd832023-01-11 14:50:10 +01005137 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005138 status = PSA_ERROR_BAD_STATE;
5139 goto exit;
5140 }
5141
Gilles Peskine449bd832023-01-11 14:50:10 +01005142 if (!operation->nonce_set || operation->body_started) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005143 status = PSA_ERROR_BAD_STATE;
5144 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005145 }
5146
Gilles Peskine449bd832023-01-11 14:50:10 +01005147 if (operation->lengths_set) {
5148 if (operation->ad_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005149 status = PSA_ERROR_INVALID_ARGUMENT;
5150 goto exit;
5151 }
5152
5153 operation->ad_remaining -= input_length;
5154 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005155#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005156 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005157 status = PSA_ERROR_BAD_STATE;
5158 goto exit;
5159 }
5160#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005161
Gilles Peskine449bd832023-01-11 14:50:10 +01005162 status = psa_driver_wrapper_aead_update_ad(operation, input,
5163 input_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005164
Paul Elliott39dc6b82021-05-11 19:16:09 +01005165exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005166 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005167 operation->ad_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005168 } else {
5169 psa_aead_abort(operation);
5170 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005171
Gilles Peskine449bd832023-01-11 14:50:10 +01005172 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005173}
5174
5175/* Encrypt or decrypt a message fragment in an active multipart AEAD
5176 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005177psa_status_t psa_aead_update(psa_aead_operation_t *operation,
5178 const uint8_t *input,
5179 size_t input_length,
5180 uint8_t *output,
5181 size_t output_size,
5182 size_t *output_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005183{
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005184 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005185
5186 *output_length = 0;
5187
Gilles Peskine449bd832023-01-11 14:50:10 +01005188 if (operation->id == 0) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005189 status = PSA_ERROR_BAD_STATE;
5190 goto exit;
5191 }
5192
Gilles Peskine449bd832023-01-11 14:50:10 +01005193 if (!operation->nonce_set) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005194 status = PSA_ERROR_BAD_STATE;
5195 goto exit;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005196 }
5197
Gilles Peskine449bd832023-01-11 14:50:10 +01005198 if (operation->lengths_set) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005199 /* Additional data length was supplied, but not all the additional
5200 data was supplied.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005201 if (operation->ad_remaining != 0) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005202 status = PSA_ERROR_INVALID_ARGUMENT;
5203 goto exit;
5204 }
5205
5206 /* Too much data provided. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005207 if (operation->body_remaining < input_length) {
Paul Elliottee4ffe02021-05-20 17:25:06 +01005208 status = PSA_ERROR_INVALID_ARGUMENT;
5209 goto exit;
5210 }
5211
5212 operation->body_remaining -= input_length;
5213 }
Paul Elliotte193ea82021-10-01 13:00:16 +01005214#if defined(PSA_WANT_ALG_CCM)
Gilles Peskine449bd832023-01-11 14:50:10 +01005215 else if (operation->alg == PSA_ALG_CCM) {
Paul Elliotte193ea82021-10-01 13:00:16 +01005216 status = PSA_ERROR_BAD_STATE;
5217 goto exit;
5218 }
5219#endif /* PSA_WANT_ALG_CCM */
Paul Elliottee4ffe02021-05-20 17:25:06 +01005220
Gilles Peskine449bd832023-01-11 14:50:10 +01005221 status = psa_driver_wrapper_aead_update(operation, input, input_length,
5222 output, output_size,
5223 output_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005224
Paul Elliott39dc6b82021-05-11 19:16:09 +01005225exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005226 if (status == PSA_SUCCESS) {
Paul Elliott39dc6b82021-05-11 19:16:09 +01005227 operation->body_started = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005228 } else {
5229 psa_aead_abort(operation);
5230 }
Paul Elliott39dc6b82021-05-11 19:16:09 +01005231
Gilles Peskine449bd832023-01-11 14:50:10 +01005232 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005233}
5234
Gilles Peskine449bd832023-01-11 14:50:10 +01005235static psa_status_t psa_aead_final_checks(const psa_aead_operation_t *operation)
Paul Elliottad53dcc2021-06-23 08:50:14 +01005236{
Gilles Peskine449bd832023-01-11 14:50:10 +01005237 if (operation->id == 0 || !operation->nonce_set) {
5238 return PSA_ERROR_BAD_STATE;
5239 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005240
Gilles Peskine449bd832023-01-11 14:50:10 +01005241 if (operation->lengths_set && (operation->ad_remaining != 0 ||
5242 operation->body_remaining != 0)) {
5243 return PSA_ERROR_INVALID_ARGUMENT;
5244 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005245
Gilles Peskine449bd832023-01-11 14:50:10 +01005246 return PSA_SUCCESS;
Paul Elliottad53dcc2021-06-23 08:50:14 +01005247}
5248
Paul Elliott302ff6b2021-04-20 18:10:30 +01005249/* Finish encrypting a message in a multipart AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005250psa_status_t psa_aead_finish(psa_aead_operation_t *operation,
5251 uint8_t *ciphertext,
5252 size_t ciphertext_size,
5253 size_t *ciphertext_length,
5254 uint8_t *tag,
5255 size_t tag_size,
5256 size_t *tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005257{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005258 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5259
Paul Elliott302ff6b2021-04-20 18:10:30 +01005260 *ciphertext_length = 0;
Paul Elliottf88a5652021-06-22 17:53:45 +01005261 *tag_length = tag_size;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005262
Gilles Peskine449bd832023-01-11 14:50:10 +01005263 status = psa_aead_final_checks(operation);
5264 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005265 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005266 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005267
Gilles Peskine449bd832023-01-11 14:50:10 +01005268 if (!operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005269 status = PSA_ERROR_BAD_STATE;
5270 goto exit;
5271 }
5272
Gilles Peskine449bd832023-01-11 14:50:10 +01005273 status = psa_driver_wrapper_aead_finish(operation, ciphertext,
5274 ciphertext_size,
5275 ciphertext_length,
5276 tag, tag_size, tag_length);
Paul Elliottcbbde5f2021-05-10 18:19:46 +01005277
Paul Elliott39dc6b82021-05-11 19:16:09 +01005278exit:
Paul Elliottdc42ca82023-02-24 18:11:59 +00005279
5280
Paul Elliottf47b0952021-05-21 18:02:33 +01005281 /* In case the operation fails and the user fails to check for failure or
Paul Elliott4c916e82021-09-19 18:34:50 +01005282 * the zero tag size, make sure the tag is set to something implausible.
5283 * Even if the operation succeeds, make sure we clear the rest of the
5284 * buffer to prevent potential leakage of anything previously placed in
5285 * the same buffer.*/
Paul Elliottdc42ca82023-02-24 18:11:59 +00005286 psa_wipe_tag_output_buffer(tag, status, tag_size, *tag_length);
Paul Elliottf47b0952021-05-21 18:02:33 +01005287
Gilles Peskine449bd832023-01-11 14:50:10 +01005288 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005289
Gilles Peskine449bd832023-01-11 14:50:10 +01005290 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005291}
5292
5293/* Finish authenticating and decrypting a message in a multipart AEAD
5294 operation.*/
Gilles Peskine449bd832023-01-11 14:50:10 +01005295psa_status_t psa_aead_verify(psa_aead_operation_t *operation,
5296 uint8_t *plaintext,
5297 size_t plaintext_size,
5298 size_t *plaintext_length,
5299 const uint8_t *tag,
5300 size_t tag_length)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005301{
Paul Elliott39dc6b82021-05-11 19:16:09 +01005302 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5303
Paul Elliott302ff6b2021-04-20 18:10:30 +01005304 *plaintext_length = 0;
5305
Gilles Peskine449bd832023-01-11 14:50:10 +01005306 status = psa_aead_final_checks(operation);
5307 if (status != PSA_SUCCESS) {
Paul Elliottad53dcc2021-06-23 08:50:14 +01005308 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01005309 }
Paul Elliottad53dcc2021-06-23 08:50:14 +01005310
Gilles Peskine449bd832023-01-11 14:50:10 +01005311 if (operation->is_encrypt) {
Paul Elliottcee785c2021-05-20 14:29:20 +01005312 status = PSA_ERROR_BAD_STATE;
5313 goto exit;
5314 }
5315
Gilles Peskine449bd832023-01-11 14:50:10 +01005316 status = psa_driver_wrapper_aead_verify(operation, plaintext,
5317 plaintext_size,
5318 plaintext_length,
5319 tag, tag_length);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005320
5321exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005322 psa_aead_abort(operation);
Paul Elliott39dc6b82021-05-11 19:16:09 +01005323
Gilles Peskine449bd832023-01-11 14:50:10 +01005324 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005325}
5326
5327/* Abort an AEAD operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005328psa_status_t psa_aead_abort(psa_aead_operation_t *operation)
Paul Elliott302ff6b2021-04-20 18:10:30 +01005329{
5330 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5331
Gilles Peskine449bd832023-01-11 14:50:10 +01005332 if (operation->id == 0) {
Paul Elliott302ff6b2021-04-20 18:10:30 +01005333 /* The object has (apparently) been initialized but it is not (yet)
5334 * in use. It's ok to call abort on such an object, and there's
5335 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005336 return PSA_SUCCESS;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005337 }
5338
Gilles Peskine449bd832023-01-11 14:50:10 +01005339 status = psa_driver_wrapper_aead_abort(operation);
Paul Elliott302ff6b2021-04-20 18:10:30 +01005340
Gilles Peskine449bd832023-01-11 14:50:10 +01005341 memset(operation, 0, sizeof(*operation));
Paul Elliott302ff6b2021-04-20 18:10:30 +01005342
Gilles Peskine449bd832023-01-11 14:50:10 +01005343 return status;
Paul Elliott302ff6b2021-04-20 18:10:30 +01005344}
5345
Gilles Peskinee59236f2018-01-27 23:32:46 +01005346/****************************************************************/
Gilles Peskineeab56e42018-07-12 17:12:33 +02005347/* Generators */
5348/****************************************************************/
5349
Przemek Stekiel69c46792022-06-10 12:59:51 +02005350#if defined(BUILTIN_ALG_ANY_HKDF) || \
John Durkop07cc04a2020-11-16 22:08:34 -08005351 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005352 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) || \
Kusumit Ghoderaoaf0b5342023-05-03 11:58:46 +05305353 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) || \
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305354 defined(PSA_HAVE_SOFT_PBKDF2)
John Durkop07cc04a2020-11-16 22:08:34 -08005355#define AT_LEAST_ONE_BUILTIN_KDF
Steven Cooreman094a77e2021-05-06 17:58:36 +02005356#endif /* At least one builtin KDF */
5357
Przemek Stekiel69c46792022-06-10 12:59:51 +02005358#if defined(BUILTIN_ALG_ANY_HKDF) || \
Steven Cooreman094a77e2021-05-06 17:58:36 +02005359 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5360 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
5361static psa_status_t psa_key_derivation_start_hmac(
5362 psa_mac_operation_t *operation,
5363 psa_algorithm_t hash_alg,
5364 const uint8_t *hmac_key,
Gilles Peskine449bd832023-01-11 14:50:10 +01005365 size_t hmac_key_length)
Steven Cooreman094a77e2021-05-06 17:58:36 +02005366{
5367 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
5368 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01005369 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
5370 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(hmac_key_length));
5371 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_HASH);
Steven Cooreman094a77e2021-05-06 17:58:36 +02005372
Steven Cooreman72f736a2021-05-07 14:14:37 +02005373 operation->is_sign = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01005374 operation->mac_size = PSA_HASH_LENGTH(hash_alg);
Steven Cooreman72f736a2021-05-07 14:14:37 +02005375
Gilles Peskine449bd832023-01-11 14:50:10 +01005376 status = psa_driver_wrapper_mac_sign_setup(operation,
5377 &attributes,
5378 hmac_key, hmac_key_length,
5379 PSA_ALG_HMAC(hash_alg));
Steven Cooreman094a77e2021-05-06 17:58:36 +02005380
Gilles Peskine449bd832023-01-11 14:50:10 +01005381 psa_reset_key_attributes(&attributes);
5382 return status;
Steven Cooreman094a77e2021-05-06 17:58:36 +02005383}
5384#endif /* KDF algorithms reliant on HMAC */
John Durkop07cc04a2020-11-16 22:08:34 -08005385
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005386#define HKDF_STATE_INIT 0 /* no input yet */
5387#define HKDF_STATE_STARTED 1 /* got salt */
5388#define HKDF_STATE_KEYED 2 /* got key */
5389#define HKDF_STATE_OUTPUT 3 /* output started */
5390
Gilles Peskinecbe66502019-05-16 16:59:18 +02005391static psa_algorithm_t psa_key_derivation_get_kdf_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01005392 const psa_key_derivation_operation_t *operation)
Gilles Peskine969c5d62019-01-16 15:53:06 +01005393{
Gilles Peskine449bd832023-01-11 14:50:10 +01005394 if (PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
5395 return PSA_ALG_KEY_AGREEMENT_GET_KDF(operation->alg);
5396 } else {
5397 return operation->alg;
5398 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01005399}
5400
Gilles Peskine449bd832023-01-11 14:50:10 +01005401psa_status_t psa_key_derivation_abort(psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005402{
5403 psa_status_t status = PSA_SUCCESS;
Gilles Peskine449bd832023-01-11 14:50:10 +01005404 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
5405 if (kdf_alg == 0) {
Gilles Peskineeab56e42018-07-12 17:12:33 +02005406 /* The object has (apparently) been initialized but it is not
5407 * in use. It's ok to call abort on such an object, and there's
5408 * nothing to do. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005409 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005410#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005411 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5412 mbedtls_free(operation->ctx.hkdf.info);
5413 status = psa_mac_abort(&operation->ctx.hkdf.hmac);
5414 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005415#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005416#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5417 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005418 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5419 /* TLS-1.2 PSK-to-MS KDF uses the same core as TLS-1.2 PRF */
5420 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5421 if (operation->ctx.tls12_prf.secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005422 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005423 operation->ctx.tls12_prf.secret_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02005424 }
5425
Gilles Peskine449bd832023-01-11 14:50:10 +01005426 if (operation->ctx.tls12_prf.seed != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005427 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.seed,
Gilles Peskine449bd832023-01-11 14:50:10 +01005428 operation->ctx.tls12_prf.seed_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005429 }
5430
Gilles Peskine449bd832023-01-11 14:50:10 +01005431 if (operation->ctx.tls12_prf.label != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005432 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.label,
Gilles Peskine449bd832023-01-11 14:50:10 +01005433 operation->ctx.tls12_prf.label_length);
Janos Follath6a1d2622019-06-11 10:37:28 +01005434 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005435#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005436 if (operation->ctx.tls12_prf.other_secret != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005437 mbedtls_zeroize_and_free(operation->ctx.tls12_prf.other_secret,
Gilles Peskine449bd832023-01-11 14:50:10 +01005438 operation->ctx.tls12_prf.other_secret_length);
Przemek Stekiele3ee2212022-04-07 14:29:56 +02005439 }
Przemek Stekiel6c764412022-11-22 14:05:12 +01005440#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Steven Cooremana6df6042021-04-29 19:32:25 +02005441 status = PSA_SUCCESS;
Janos Follath6a1d2622019-06-11 10:37:28 +01005442
5443 /* We leave the fields Ai and output_block to be erased safely by the
5444 * mbedtls_platform_zeroize() in the end of this function. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005445 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005446#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
5447 * defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS) */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005448#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005449 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
5450 mbedtls_platform_zeroize(operation->ctx.tls12_ecjpake_to_pms.data,
5451 sizeof(operation->ctx.tls12_ecjpake_to_pms.data));
5452 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005453#endif /* defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS) */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305454#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305455 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305456 if (operation->ctx.pbkdf2.salt != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01005457 mbedtls_zeroize_and_free(operation->ctx.pbkdf2.salt,
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305458 operation->ctx.pbkdf2.salt_length);
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305459 }
Kusumit Ghoderaof5fedf12023-05-03 12:29:48 +05305460
5461 status = PSA_SUCCESS;
5462 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305463#endif /* defined(PSA_HAVE_SOFT_PBKDF2) */
Gilles Peskineeab56e42018-07-12 17:12:33 +02005464 {
5465 status = PSA_ERROR_BAD_STATE;
5466 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005467 mbedtls_platform_zeroize(operation, sizeof(*operation));
5468 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005469}
5470
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005471psa_status_t psa_key_derivation_get_capacity(const psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01005472 size_t *capacity)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005473{
Gilles Peskine449bd832023-01-11 14:50:10 +01005474 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005475 /* This is a blank key derivation operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005476 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005477 }
5478
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005479 *capacity = operation->capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005480 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005481}
5482
Gilles Peskine449bd832023-01-11 14:50:10 +01005483psa_status_t psa_key_derivation_set_capacity(psa_key_derivation_operation_t *operation,
5484 size_t capacity)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005485{
Gilles Peskine449bd832023-01-11 14:50:10 +01005486 if (operation->alg == 0) {
5487 return PSA_ERROR_BAD_STATE;
5488 }
5489 if (capacity > operation->capacity) {
5490 return PSA_ERROR_INVALID_ARGUMENT;
5491 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005492 operation->capacity = capacity;
Gilles Peskine449bd832023-01-11 14:50:10 +01005493 return PSA_SUCCESS;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005494}
5495
Przemek Stekiel69c46792022-06-10 12:59:51 +02005496#if defined(BUILTIN_ALG_ANY_HKDF)
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005497/* Read some bytes from an HKDF-based operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005498static psa_status_t psa_key_derivation_hkdf_read(psa_hkdf_key_derivation_t *hkdf,
5499 psa_algorithm_t kdf_alg,
5500 uint8_t *output,
5501 size_t output_length)
Gilles Peskinebef7f142018-07-12 17:22:21 +02005502{
Gilles Peskine449bd832023-01-11 14:50:10 +01005503 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
5504 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005505 size_t hmac_output_length;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005506 psa_status_t status;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005507#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005508 const uint8_t last_block = PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ? 0 : 0xff;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005509#else
5510 const uint8_t last_block = 0xff;
5511#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005512
Gilles Peskine449bd832023-01-11 14:50:10 +01005513 if (hkdf->state < HKDF_STATE_KEYED ||
5514 (!hkdf->info_set
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005515#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01005516 && !PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02005517#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01005518 )) {
5519 return PSA_ERROR_BAD_STATE;
5520 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01005521 hkdf->state = HKDF_STATE_OUTPUT;
5522
Gilles Peskine449bd832023-01-11 14:50:10 +01005523 while (output_length != 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005524 /* Copy what remains of the current block */
5525 uint8_t n = hash_length - hkdf->offset_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005526 if (n > output_length) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005527 n = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005528 }
5529 memcpy(output, hkdf->output_block + hkdf->offset_in_block, n);
Gilles Peskinebef7f142018-07-12 17:22:21 +02005530 output += n;
5531 output_length -= n;
5532 hkdf->offset_in_block += n;
Gilles Peskine449bd832023-01-11 14:50:10 +01005533 if (output_length == 0) {
Gilles Peskinebef7f142018-07-12 17:22:21 +02005534 break;
Gilles Peskine449bd832023-01-11 14:50:10 +01005535 }
Przemek Stekiel03d948c2022-05-19 11:45:20 +02005536 /* We can't be wanting more output after the last block, otherwise
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02005537 * the capacity check in psa_key_derivation_output_bytes() would have
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005538 * prevented this call. It could happen only if the operation
Gilles Peskined54931c2018-07-17 21:06:59 +02005539 * object was corrupted or if this function is called directly
5540 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005541 if (hkdf->block_number == last_block) {
5542 return PSA_ERROR_BAD_STATE;
5543 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005544
5545 /* We need a new block */
5546 ++hkdf->block_number;
5547 hkdf->offset_in_block = 0;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02005548
Gilles Peskine449bd832023-01-11 14:50:10 +01005549 status = psa_key_derivation_start_hmac(&hkdf->hmac,
5550 hash_alg,
5551 hkdf->prk,
5552 hash_length);
5553 if (status != PSA_SUCCESS) {
5554 return status;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005555 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005556
5557 if (hkdf->block_number != 1) {
5558 status = psa_mac_update(&hkdf->hmac,
5559 hkdf->output_block,
5560 hash_length);
5561 if (status != PSA_SUCCESS) {
5562 return status;
5563 }
5564 }
5565 status = psa_mac_update(&hkdf->hmac,
5566 hkdf->info,
5567 hkdf->info_length);
5568 if (status != PSA_SUCCESS) {
5569 return status;
5570 }
5571 status = psa_mac_update(&hkdf->hmac,
5572 &hkdf->block_number, 1);
5573 if (status != PSA_SUCCESS) {
5574 return status;
5575 }
5576 status = psa_mac_sign_finish(&hkdf->hmac,
5577 hkdf->output_block,
5578 sizeof(hkdf->output_block),
5579 &hmac_output_length);
5580 if (status != PSA_SUCCESS) {
5581 return status;
5582 }
Gilles Peskinebef7f142018-07-12 17:22:21 +02005583 }
5584
Gilles Peskine449bd832023-01-11 14:50:10 +01005585 return PSA_SUCCESS;
Gilles Peskinebef7f142018-07-12 17:22:21 +02005586}
Przemek Stekiel69c46792022-06-10 12:59:51 +02005587#endif /* BUILTIN_ALG_ANY_HKDF */
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005588
John Durkop07cc04a2020-11-16 22:08:34 -08005589#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5590 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Janos Follath7742fee2019-06-17 12:58:10 +01005591static psa_status_t psa_key_derivation_tls12_prf_generate_next_block(
5592 psa_tls12_prf_key_derivation_t *tls12_prf,
Gilles Peskine449bd832023-01-11 14:50:10 +01005593 psa_algorithm_t alg)
Janos Follath7742fee2019-06-17 12:58:10 +01005594{
Gilles Peskine449bd832023-01-11 14:50:10 +01005595 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(alg);
5596 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Steven Cooremana6df6042021-04-29 19:32:25 +02005597 psa_mac_operation_t hmac = PSA_MAC_OPERATION_INIT;
5598 size_t hmac_output_length;
Janos Follathea29bfb2019-06-19 12:21:20 +01005599 psa_status_t status, cleanup_status;
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005600
Janos Follath7742fee2019-06-17 12:58:10 +01005601 /* We can't be wanting more output after block 0xff, otherwise
5602 * the capacity check in psa_key_derivation_output_bytes() would have
5603 * prevented this call. It could happen only if the operation
5604 * object was corrupted or if this function is called directly
5605 * inside the library. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005606 if (tls12_prf->block_number == 0xff) {
5607 return PSA_ERROR_CORRUPTION_DETECTED;
5608 }
Janos Follath7742fee2019-06-17 12:58:10 +01005609
5610 /* We need a new block */
5611 ++tls12_prf->block_number;
Janos Follath844eb0e2019-06-19 12:10:49 +01005612 tls12_prf->left_in_block = hash_length;
Janos Follath7742fee2019-06-17 12:58:10 +01005613
5614 /* Recall the definition of the TLS-1.2-PRF from RFC 5246:
5615 *
5616 * PRF(secret, label, seed) = P_<hash>(secret, label + seed)
5617 *
5618 * P_hash(secret, seed) = HMAC_hash(secret, A(1) + seed) +
5619 * HMAC_hash(secret, A(2) + seed) +
5620 * HMAC_hash(secret, A(3) + seed) + ...
5621 *
5622 * A(0) = seed
Janos Follathea29bfb2019-06-19 12:21:20 +01005623 * A(i) = HMAC_hash(secret, A(i-1))
Janos Follath7742fee2019-06-17 12:58:10 +01005624 *
Janos Follathea29bfb2019-06-19 12:21:20 +01005625 * The `psa_tls12_prf_key_derivation` structure saves the block
Janos Follath7742fee2019-06-17 12:58:10 +01005626 * `HMAC_hash(secret, A(i) + seed)` from which the output
Janos Follath76c39842019-06-26 12:50:36 +01005627 * is currently extracted as `output_block` and where i is
5628 * `block_number`.
Janos Follath7742fee2019-06-17 12:58:10 +01005629 */
5630
Gilles Peskine449bd832023-01-11 14:50:10 +01005631 status = psa_key_derivation_start_hmac(&hmac,
5632 hash_alg,
5633 tls12_prf->secret,
5634 tls12_prf->secret_length);
5635 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005636 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005637 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005638
5639 /* Calculate A(i) where i = tls12_prf->block_number. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005640 if (tls12_prf->block_number == 1) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005641 /* A(1) = HMAC_hash(secret, A(0)), where A(0) = seed. (The RFC overloads
5642 * the variable seed and in this instance means it in the context of the
5643 * P_hash function, where seed = label + seed.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005644 status = psa_mac_update(&hmac,
5645 tls12_prf->label,
5646 tls12_prf->label_length);
5647 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005648 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005649 }
5650 status = psa_mac_update(&hmac,
5651 tls12_prf->seed,
5652 tls12_prf->seed_length);
5653 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005654 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005655 }
5656 } else {
Janos Follathea29bfb2019-06-19 12:21:20 +01005657 /* A(i) = HMAC_hash(secret, A(i-1)) */
Gilles Peskine449bd832023-01-11 14:50:10 +01005658 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5659 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005660 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005661 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005662 }
5663
Gilles Peskine449bd832023-01-11 14:50:10 +01005664 status = psa_mac_sign_finish(&hmac,
5665 tls12_prf->Ai, hash_length,
5666 &hmac_output_length);
5667 if (hmac_output_length != hash_length) {
Steven Cooremana6df6042021-04-29 19:32:25 +02005668 status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01005669 }
5670 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005671 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005672 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005673
5674 /* Calculate HMAC_hash(secret, A(i) + label + seed). */
Gilles Peskine449bd832023-01-11 14:50:10 +01005675 status = psa_key_derivation_start_hmac(&hmac,
5676 hash_alg,
5677 tls12_prf->secret,
5678 tls12_prf->secret_length);
5679 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005680 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005681 }
5682 status = psa_mac_update(&hmac, tls12_prf->Ai, hash_length);
5683 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005684 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005685 }
5686 status = psa_mac_update(&hmac, tls12_prf->label, tls12_prf->label_length);
5687 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005688 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005689 }
5690 status = psa_mac_update(&hmac, tls12_prf->seed, tls12_prf->seed_length);
5691 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005692 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005693 }
5694 status = psa_mac_sign_finish(&hmac,
5695 tls12_prf->output_block, hash_length,
5696 &hmac_output_length);
5697 if (status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005698 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01005699 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005700
Janos Follath7742fee2019-06-17 12:58:10 +01005701
5702cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01005703 cleanup_status = psa_mac_abort(&hmac);
5704 if (status == PSA_SUCCESS && cleanup_status != PSA_SUCCESS) {
Janos Follathea29bfb2019-06-19 12:21:20 +01005705 status = cleanup_status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005706 }
Janos Follathea29bfb2019-06-19 12:21:20 +01005707
Gilles Peskine449bd832023-01-11 14:50:10 +01005708 return status;
Janos Follath7742fee2019-06-17 12:58:10 +01005709}
Hanno Beckerc8a41d72018-10-09 17:33:01 +01005710
Janos Follath844eb0e2019-06-19 12:10:49 +01005711static psa_status_t psa_key_derivation_tls12_prf_read(
5712 psa_tls12_prf_key_derivation_t *tls12_prf,
5713 psa_algorithm_t alg,
5714 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005715 size_t output_length)
Janos Follath844eb0e2019-06-19 12:10:49 +01005716{
Gilles Peskine449bd832023-01-11 14:50:10 +01005717 psa_algorithm_t hash_alg = PSA_ALG_TLS12_PRF_GET_HASH(alg);
5718 uint8_t hash_length = PSA_HASH_LENGTH(hash_alg);
Janos Follath844eb0e2019-06-19 12:10:49 +01005719 psa_status_t status;
5720 uint8_t offset, length;
5721
Gilles Peskine449bd832023-01-11 14:50:10 +01005722 switch (tls12_prf->state) {
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005723 case PSA_TLS12_PRF_STATE_LABEL_SET:
5724 tls12_prf->state = PSA_TLS12_PRF_STATE_OUTPUT;
5725 break;
5726 case PSA_TLS12_PRF_STATE_OUTPUT:
5727 break;
5728 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01005729 return PSA_ERROR_BAD_STATE;
Gilles Peskineb1edaec2021-06-11 22:41:46 +02005730 }
5731
Gilles Peskine449bd832023-01-11 14:50:10 +01005732 while (output_length != 0) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005733 /* Check if we have fully processed the current block. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005734 if (tls12_prf->left_in_block == 0) {
5735 status = psa_key_derivation_tls12_prf_generate_next_block(tls12_prf,
5736 alg);
5737 if (status != PSA_SUCCESS) {
5738 return status;
5739 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005740
5741 continue;
5742 }
5743
Gilles Peskine449bd832023-01-11 14:50:10 +01005744 if (tls12_prf->left_in_block > output_length) {
Janos Follath844eb0e2019-06-19 12:10:49 +01005745 length = (uint8_t) output_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01005746 } else {
Janos Follath844eb0e2019-06-19 12:10:49 +01005747 length = tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005748 }
Janos Follath844eb0e2019-06-19 12:10:49 +01005749
5750 offset = hash_length - tls12_prf->left_in_block;
Gilles Peskine449bd832023-01-11 14:50:10 +01005751 memcpy(output, tls12_prf->output_block + offset, length);
Janos Follath844eb0e2019-06-19 12:10:49 +01005752 output += length;
5753 output_length -= length;
5754 tls12_prf->left_in_block -= length;
5755 }
5756
Gilles Peskine449bd832023-01-11 14:50:10 +01005757 return PSA_SUCCESS;
Janos Follath844eb0e2019-06-19 12:10:49 +01005758}
John Durkop07cc04a2020-11-16 22:08:34 -08005759#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5760 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskinebef7f142018-07-12 17:22:21 +02005761
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005762#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
5763static psa_status_t psa_key_derivation_tls12_ecjpake_to_pms_read(
5764 psa_tls12_ecjpake_to_pms_t *ecjpake,
5765 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005766 size_t output_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005767{
5768 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04005769 size_t output_size = 0;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005770
Gilles Peskine449bd832023-01-11 14:50:10 +01005771 if (output_length != 32) {
5772 return PSA_ERROR_INVALID_ARGUMENT;
5773 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005774
Gilles Peskine449bd832023-01-11 14:50:10 +01005775 status = psa_hash_compute(PSA_ALG_SHA_256, ecjpake->data,
5776 PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE, output, output_length,
5777 &output_size);
5778 if (status != PSA_SUCCESS) {
5779 return status;
5780 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005781
Gilles Peskine449bd832023-01-11 14:50:10 +01005782 if (output_size != output_length) {
5783 return PSA_ERROR_GENERIC_ERROR;
5784 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005785
Gilles Peskine449bd832023-01-11 14:50:10 +01005786 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005787}
5788#endif
5789
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305790#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305791static psa_status_t psa_key_derivation_pbkdf2_generate_block(
5792 psa_pbkdf2_key_derivation_t *pbkdf2,
5793 psa_algorithm_t prf_alg,
5794 uint8_t prf_output_length,
5795 psa_key_attributes_t *attributes)
5796{
5797 psa_status_t status;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305798 psa_mac_operation_t mac_operation = PSA_MAC_OPERATION_INIT;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305799 size_t mac_output_length;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305800 uint8_t U_i[PSA_MAC_MAX_SIZE];
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305801 uint8_t *U_accumulator = pbkdf2->output_block;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305802 uint64_t i;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305803 uint8_t block_counter[4];
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305804
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305805 mac_operation.is_sign = 1;
5806 mac_operation.mac_size = prf_output_length;
5807 MBEDTLS_PUT_UINT32_BE(pbkdf2->block_number, block_counter, 0);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305808
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305809 status = psa_driver_wrapper_mac_sign_setup(&mac_operation,
5810 attributes,
5811 pbkdf2->password,
5812 pbkdf2->password_length,
5813 prf_alg);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305814 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305815 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305816 }
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305817 status = psa_mac_update(&mac_operation, pbkdf2->salt, pbkdf2->salt_length);
5818 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305819 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305820 }
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305821 status = psa_mac_update(&mac_operation, block_counter, sizeof(block_counter));
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305822 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305823 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305824 }
5825 status = psa_mac_sign_finish(&mac_operation, U_i, sizeof(U_i),
5826 &mac_output_length);
5827 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305828 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305829 }
5830
5831 if (mac_output_length != prf_output_length) {
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305832 status = PSA_ERROR_CORRUPTION_DETECTED;
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305833 goto cleanup;
Kusumit Ghoderaob821a5f2023-06-08 16:35:55 +05305834 }
5835
Kusumit Ghoderao257ea002023-06-14 15:55:11 +05305836 memcpy(U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305837
5838 for (i = 1; i < pbkdf2->input_cost; i++) {
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305839 /* We are passing prf_output_length as mac_size because the driver
5840 * function directly sets mac_output_length as mac_size upon success.
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05305841 * See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305842 status = psa_driver_wrapper_mac_compute(attributes,
5843 pbkdf2->password,
5844 pbkdf2->password_length,
5845 prf_alg, U_i, prf_output_length,
Kusumit Ghoderao4536bb62023-06-22 15:42:59 +05305846 U_i, prf_output_length,
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305847 &mac_output_length);
5848 if (status != PSA_SUCCESS) {
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305849 goto cleanup;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305850 }
5851
Kusumit Ghoderao109ee3d2023-06-08 16:36:45 +05305852 mbedtls_xor(U_accumulator, U_accumulator, U_i, prf_output_length);
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305853 }
Kusumit Ghoderao246e51f2023-06-15 22:15:43 +05305854
5855cleanup:
5856 /* Zeroise buffers to clear sensitive data from memory. */
5857 mbedtls_platform_zeroize(U_i, PSA_MAC_MAX_SIZE);
5858 return status;
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305859}
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305860
5861static psa_status_t psa_key_derivation_pbkdf2_read(
5862 psa_pbkdf2_key_derivation_t *pbkdf2,
5863 psa_algorithm_t kdf_alg,
5864 uint8_t *output,
5865 size_t output_length)
5866{
5867 psa_status_t status;
5868 psa_algorithm_t prf_alg;
5869 uint8_t prf_output_length;
5870 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
5871 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(pbkdf2->password_length));
5872 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
5873
5874 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
5875 prf_alg = PSA_ALG_HMAC(PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg));
5876 prf_output_length = PSA_HASH_LENGTH(prf_alg);
5877 psa_set_key_type(&attributes, PSA_KEY_TYPE_HMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305878 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
5879 prf_alg = PSA_ALG_CMAC;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05305880 prf_output_length = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderaoa2520a52023-06-22 15:42:19 +05305881 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
Kusumit Ghoderaod9ec1af2023-06-08 20:19:51 +05305882 } else {
5883 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305884 }
5885
5886 switch (pbkdf2->state) {
5887 case PSA_PBKDF2_STATE_PASSWORD_SET:
5888 /* Initially we need a new block so bytes_used is equal to block size*/
5889 pbkdf2->bytes_used = prf_output_length;
5890 pbkdf2->state = PSA_PBKDF2_STATE_OUTPUT;
5891 break;
5892 case PSA_PBKDF2_STATE_OUTPUT:
5893 break;
5894 default:
5895 return PSA_ERROR_BAD_STATE;
5896 }
5897
5898 while (output_length != 0) {
5899 uint8_t n = prf_output_length - pbkdf2->bytes_used;
5900 if (n > output_length) {
5901 n = (uint8_t) output_length;
5902 }
5903 memcpy(output, pbkdf2->output_block + pbkdf2->bytes_used, n);
5904 output += n;
5905 output_length -= n;
5906 pbkdf2->bytes_used += n;
5907
5908 if (output_length == 0) {
5909 break;
5910 }
5911
5912 /* We need a new block */
5913 pbkdf2->bytes_used = 0;
5914 pbkdf2->block_number++;
5915
5916 status = psa_key_derivation_pbkdf2_generate_block(pbkdf2, prf_alg,
5917 prf_output_length,
5918 &attributes);
5919 if (status != PSA_SUCCESS) {
5920 return status;
5921 }
5922 }
5923
5924 return PSA_SUCCESS;
5925}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305926#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderaoa4346cd2023-06-05 14:50:20 +05305927
Janos Follath6c6c8fc2019-06-17 12:38:20 +01005928psa_status_t psa_key_derivation_output_bytes(
5929 psa_key_derivation_operation_t *operation,
5930 uint8_t *output,
Gilles Peskine449bd832023-01-11 14:50:10 +01005931 size_t output_length)
Gilles Peskineeab56e42018-07-12 17:12:33 +02005932{
5933 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01005934 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskineeab56e42018-07-12 17:12:33 +02005935
Gilles Peskine449bd832023-01-11 14:50:10 +01005936 if (operation->alg == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005937 /* This is a blank operation. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005938 return PSA_ERROR_BAD_STATE;
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005939 }
5940
Gilles Peskine449bd832023-01-11 14:50:10 +01005941 if (output_length > operation->capacity) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005942 operation->capacity = 0;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005943 /* Go through the error path to wipe all confidential data now
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005944 * that the operation object is useless. */
David Saadab4ecc272019-02-14 13:48:10 +02005945 status = PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005946 goto exit;
5947 }
Gilles Peskine449bd832023-01-11 14:50:10 +01005948 if (output_length == 0 && operation->capacity == 0) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005949 /* Edge case: this is a finished operation, and 0 bytes
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005950 * were requested. The right error in this case could
Gilles Peskineeab56e42018-07-12 17:12:33 +02005951 * be either INSUFFICIENT_CAPACITY or BAD_STATE. Return
5952 * INSUFFICIENT_CAPACITY, which is right for a finished
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005953 * operation, for consistency with the case when
Gilles Peskineeab56e42018-07-12 17:12:33 +02005954 * output_length > 0. */
Gilles Peskine449bd832023-01-11 14:50:10 +01005955 return PSA_ERROR_INSUFFICIENT_DATA;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005956 }
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005957 operation->capacity -= output_length;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005958
Przemek Stekiel69c46792022-06-10 12:59:51 +02005959#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01005960 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
5961 status = psa_key_derivation_hkdf_read(&operation->ctx.hkdf, kdf_alg,
5962 output, output_length);
5963 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02005964#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08005965#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
5966 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005967 if (PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
5968 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
5969 status = psa_key_derivation_tls12_prf_read(&operation->ctx.tls12_prf,
5970 kdf_alg, output,
5971 output_length);
5972 } else
John Durkop07cc04a2020-11-16 22:08:34 -08005973#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF ||
5974 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005975#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01005976 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005977 status = psa_key_derivation_tls12_ecjpake_to_pms_read(
Gilles Peskine449bd832023-01-11 14:50:10 +01005978 &operation->ctx.tls12_ecjpake_to_pms, output, output_length);
5979 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005980#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305981#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05305982 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaof6a0d572023-06-05 14:55:56 +05305983 status = psa_key_derivation_pbkdf2_read(&operation->ctx.pbkdf2, kdf_alg,
5984 output, output_length);
Kusumit Ghoderao056f0c52023-05-03 15:58:34 +05305985 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05305986#endif /* PSA_HAVE_SOFT_PBKDF2 */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04005987
Gilles Peskineeab56e42018-07-12 17:12:33 +02005988 {
Steven Cooreman74afe472021-02-10 17:19:22 +01005989 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01005990 return PSA_ERROR_BAD_STATE;
Gilles Peskineeab56e42018-07-12 17:12:33 +02005991 }
5992
5993exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01005994 if (status != PSA_SUCCESS) {
Jaeden Amerocf2010c2019-02-15 13:05:49 +00005995 /* Preserve the algorithm upon errors, but clear all sensitive state.
Gilles Peskine51ae0e42019-05-16 17:31:03 +02005996 * This allows us to differentiate between exhausted operations and
5997 * blank operations, so we can return PSA_ERROR_BAD_STATE on blank
5998 * operations. */
5999 psa_algorithm_t alg = operation->alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006000 psa_key_derivation_abort(operation);
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006001 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006002 memset(output, '!', output_length);
Gilles Peskineeab56e42018-07-12 17:12:33 +02006003 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006004 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006005}
6006
David Brown7807bf72021-02-09 16:28:23 -07006007#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006008static void psa_des_set_key_parity(uint8_t *data, size_t data_size)
Gilles Peskine08542d82018-07-19 17:05:42 +02006009{
Gilles Peskine449bd832023-01-11 14:50:10 +01006010 if (data_size >= 8) {
6011 mbedtls_des_key_set_parity(data);
6012 }
6013 if (data_size >= 16) {
6014 mbedtls_des_key_set_parity(data + 8);
6015 }
6016 if (data_size >= 24) {
6017 mbedtls_des_key_set_parity(data + 16);
6018 }
Gilles Peskine08542d82018-07-19 17:05:42 +02006019}
David Brown7807bf72021-02-09 16:28:23 -07006020#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine08542d82018-07-19 17:05:42 +02006021
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006022/*
Gilles Peskine449bd832023-01-11 14:50:10 +01006023 * ECC keys on a Weierstrass elliptic curve require the generation
6024 * of a private key which is an integer
6025 * in the range [1, N - 1], where N is the boundary of the private key domain:
6026 * N is the prime p for Diffie-Hellman, or the order of the
6027 * curve’s base point for ECC.
6028 *
6029 * Let m be the bit size of N, such that 2^m > N >= 2^(m-1).
6030 * This function generates the private key using the following process:
6031 *
6032 * 1. Draw a byte string of length ceiling(m/8) bytes.
6033 * 2. If m is not a multiple of 8, set the most significant
6034 * (8 * ceiling(m/8) - m) bits of the first byte in the string to zero.
6035 * 3. Convert the string to integer k by decoding it as a big-endian byte string.
6036 * 4. If k > N - 2, discard the result and return to step 1.
6037 * 5. Output k + 1 as the private key.
6038 *
6039 * This method allows compliance to NIST standards, specifically the methods titled
6040 * Key-Pair Generation by Testing Candidates in the following publications:
6041 * - NIST Special Publication 800-56A: Recommendation for Pair-Wise Key-Establishment
6042 * Schemes Using Discrete Logarithm Cryptography [SP800-56A] §5.6.1.1.4 for
6043 * Diffie-Hellman keys.
6044 *
6045 * - [SP800-56A] §5.6.1.2.2 or FIPS Publication 186-4: Digital Signature
6046 * Standard (DSS) [FIPS186-4] §B.4.2 for elliptic curve keys.
6047 *
6048 * Note: Function allocates memory for *data buffer, so given *data should be
6049 * always NULL.
6050 */
Valerio Setti86587ab2023-06-27 13:09:30 +02006051#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
6052#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006053static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006054 psa_key_slot_t *slot,
6055 size_t bits,
6056 psa_key_derivation_operation_t *operation,
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006057 uint8_t **data
6058 )
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006059{
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006060 unsigned key_out_of_range = 1;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006061 mbedtls_mpi k;
6062 mbedtls_mpi diff_N_2;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006063 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006064 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006065 size_t m;
6066 size_t m_bytes;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006067
Gilles Peskine449bd832023-01-11 14:50:10 +01006068 mbedtls_mpi_init(&k);
6069 mbedtls_mpi_init(&diff_N_2);
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006070
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006071 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(
Gilles Peskine449bd832023-01-11 14:50:10 +01006072 slot->attr.type);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006073 mbedtls_ecp_group_id grp_id =
Gilles Peskine449bd832023-01-11 14:50:10 +01006074 mbedtls_ecc_group_of_psa(curve, bits, 0);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006075
Gilles Peskine449bd832023-01-11 14:50:10 +01006076 if (grp_id == MBEDTLS_ECP_DP_NONE) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006077 ret = MBEDTLS_ERR_ASN1_INVALID_DATA;
Przemyslaw Stekiel871a3362021-12-02 08:46:39 +01006078 goto cleanup;
6079 }
6080
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006081 mbedtls_ecp_group ecp_group;
Gilles Peskine449bd832023-01-11 14:50:10 +01006082 mbedtls_ecp_group_init(&ecp_group);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006083
Gilles Peskine449bd832023-01-11 14:50:10 +01006084 MBEDTLS_MPI_CHK(mbedtls_ecp_group_load(&ecp_group, grp_id));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006085
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006086 /* N is the boundary of the private key domain (ecp_group.N). */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006087 /* Let m be the bit size of N. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006088 m = ecp_group.nbits;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006089
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006090 m_bytes = PSA_BITS_TO_BYTES(m);
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006091
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006092 /* Calculate N - 2 - it will be needed later. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006093 MBEDTLS_MPI_CHK(mbedtls_mpi_sub_int(&diff_N_2, &ecp_group.N, 2));
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006094
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006095 /* Note: This function is always called with *data == NULL and it
6096 * allocates memory for the data buffer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006097 *data = mbedtls_calloc(1, m_bytes);
6098 if (*data == NULL) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006099 ret = MBEDTLS_ERR_ASN1_ALLOC_FAILED;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006100 goto cleanup;
6101 }
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006102
Gilles Peskine449bd832023-01-11 14:50:10 +01006103 while (key_out_of_range) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006104 /* 1. Draw a byte string of length ceiling(m/8) bytes. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006105 if ((status = psa_key_derivation_output_bytes(operation, *data, m_bytes)) != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006106 goto cleanup;
Gilles Peskine449bd832023-01-11 14:50:10 +01006107 }
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006108
6109 /* 2. If m is not a multiple of 8 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006110 if (m % 8 != 0) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006111 /* Set the most significant
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006112 * (8 * ceiling(m/8) - m) bits of the first byte in
6113 * the string to zero.
6114 */
Gilles Peskine449bd832023-01-11 14:50:10 +01006115 uint8_t clear_bit_mask = (1 << (m % 8)) - 1;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006116 (*data)[0] &= clear_bit_mask;
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006117 }
6118
6119 /* 3. Convert the string to integer k by decoding it as a
Gilles Peskine449bd832023-01-11 14:50:10 +01006120 * big-endian byte string.
6121 */
6122 MBEDTLS_MPI_CHK(mbedtls_mpi_read_binary(&k, *data, m_bytes));
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006123
6124 /* 4. If k > N - 2, discard the result and return to step 1.
Gilles Peskine449bd832023-01-11 14:50:10 +01006125 * Result of comparison is returned. When it indicates error
6126 * then this function is called again.
6127 */
6128 MBEDTLS_MPI_CHK(mbedtls_mpi_lt_mpi_ct(&diff_N_2, &k, &key_out_of_range));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006129 }
6130
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006131 /* 5. Output k + 1 as the private key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006132 MBEDTLS_MPI_CHK(mbedtls_mpi_add_int(&k, &k, 1));
6133 MBEDTLS_MPI_CHK(mbedtls_mpi_write_binary(&k, *data, m_bytes));
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006134cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01006135 if (ret != 0) {
6136 status = mbedtls_to_psa_error(ret);
6137 }
6138 if (status != PSA_SUCCESS) {
6139 mbedtls_free(*data);
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006140 *data = NULL;
6141 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006142 mbedtls_mpi_free(&k);
6143 mbedtls_mpi_free(&diff_N_2);
6144 return status;
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006145}
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006146
6147/* ECC keys on a Montgomery elliptic curve draws a byte string whose length
6148 * is determined by the curve, and sets the mandatory bits accordingly. That is:
6149 *
6150 * - Curve25519 (PSA_ECC_FAMILY_MONTGOMERY, 255 bits):
6151 * draw a 32-byte string and process it as specified in
6152 * Elliptic Curves for Security [RFC7748] §5.
6153 *
6154 * - Curve448 (PSA_ECC_FAMILY_MONTGOMERY, 448 bits):
6155 * draw a 56-byte string and process it as specified in [RFC7748] §5.
6156 *
6157 * Note: Function allocates memory for *data buffer, so given *data should be
6158 * always NULL.
6159 */
6160
6161static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6162 size_t bits,
6163 psa_key_derivation_operation_t *operation,
6164 uint8_t **data
6165 )
6166{
6167 size_t output_length;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006168 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006169
Gilles Peskine449bd832023-01-11 14:50:10 +01006170 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006171 case 255:
6172 output_length = 32;
6173 break;
6174 case 448:
6175 output_length = 56;
6176 break;
6177 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006178 return PSA_ERROR_INVALID_ARGUMENT;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006179 break;
6180 }
6181
Gilles Peskine449bd832023-01-11 14:50:10 +01006182 *data = mbedtls_calloc(1, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006183
Gilles Peskine449bd832023-01-11 14:50:10 +01006184 if (*data == NULL) {
6185 return PSA_ERROR_INSUFFICIENT_MEMORY;
6186 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006187
Gilles Peskine449bd832023-01-11 14:50:10 +01006188 status = psa_key_derivation_output_bytes(operation, *data, output_length);
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006189
Gilles Peskine449bd832023-01-11 14:50:10 +01006190 if (status != PSA_SUCCESS) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006191 return status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006192 }
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006193
Gilles Peskine449bd832023-01-11 14:50:10 +01006194 switch (bits) {
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006195 case 255:
6196 (*data)[0] &= 248;
6197 (*data)[31] &= 127;
6198 (*data)[31] |= 64;
6199 break;
6200 case 448:
6201 (*data)[0] &= 252;
6202 (*data)[55] |= 128;
6203 break;
6204 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006205 return PSA_ERROR_CORRUPTION_DETECTED;
Przemyslaw Stekielaeaa4f02022-02-21 08:17:43 +01006206 break;
6207 }
6208
6209 return status;
6210}
Valerio Setti86587ab2023-06-27 13:09:30 +02006211#else /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6212static psa_status_t psa_generate_derived_ecc_key_weierstrass_helper(
6213 psa_key_slot_t *slot, size_t bits,
6214 psa_key_derivation_operation_t *operation, uint8_t **data)
6215{
6216 (void) slot;
6217 (void) bits;
6218 (void) operation;
6219 (void) data;
6220 return PSA_ERROR_NOT_SUPPORTED;
6221}
6222
6223static psa_status_t psa_generate_derived_ecc_key_montgomery_helper(
6224 size_t bits, psa_key_derivation_operation_t *operation, uint8_t **data)
6225{
6226 (void) bits;
6227 (void) operation;
6228 (void) data;
6229 return PSA_ERROR_NOT_SUPPORTED;
6230}
6231#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
6232#endif /* PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE */
Przemyslaw Stekield8cdcba2021-11-15 12:38:53 +01006233
Adrian L. Shaw5a5a79a2019-05-03 15:44:28 +01006234static psa_status_t psa_generate_derived_key_internal(
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006235 psa_key_slot_t *slot,
6236 size_t bits,
Gilles Peskine449bd832023-01-11 14:50:10 +01006237 psa_key_derivation_operation_t *operation)
Gilles Peskineeab56e42018-07-12 17:12:33 +02006238{
6239 uint8_t *data = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +01006240 size_t bytes = PSA_BITS_TO_BYTES(bits);
Archanad8a83dc2021-06-14 10:04:16 +05306241 size_t storage_size = bytes;
Przemek Stekiela81aed22022-03-01 15:13:30 +01006242 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006243 psa_key_attributes_t attributes;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006244
Gilles Peskine449bd832023-01-11 14:50:10 +01006245 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(slot->attr.type)) {
6246 return PSA_ERROR_INVALID_ARGUMENT;
6247 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006248
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006249#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) || \
Valerio Settidd24f292023-06-26 12:21:17 +02006250 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE)
Gilles Peskine449bd832023-01-11 14:50:10 +01006251 if (PSA_KEY_TYPE_IS_ECC(slot->attr.type)) {
6252 psa_ecc_family_t curve = PSA_KEY_TYPE_ECC_GET_FAMILY(slot->attr.type);
6253 if (PSA_ECC_FAMILY_IS_WEIERSTRASS(curve)) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006254 /* Weierstrass elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006255 status = psa_generate_derived_ecc_key_weierstrass_helper(slot, bits, operation, &data);
6256 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel6d3d18b2022-01-20 22:41:17 +01006257 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006258 }
6259 } else {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006260 /* Montgomery elliptic curve */
Gilles Peskine449bd832023-01-11 14:50:10 +01006261 status = psa_generate_derived_ecc_key_montgomery_helper(bits, operation, &data);
6262 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006263 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006264 }
Przemyslaw Stekiel58ce8d82021-11-25 13:53:28 +01006265 }
Przemyslaw Stekiel1dfd1222021-11-18 13:35:00 +01006266 } else
Valerio Setti8ffdb5d2023-06-20 13:14:08 +02006267#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE) ||
Valerio Settidd24f292023-06-26 12:21:17 +02006268 defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_DERIVE) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006269 if (key_type_is_raw_bytes(slot->attr.type)) {
6270 if (bits % 8 != 0) {
6271 return PSA_ERROR_INVALID_ARGUMENT;
6272 }
6273 data = mbedtls_calloc(1, bytes);
6274 if (data == NULL) {
6275 return PSA_ERROR_INSUFFICIENT_MEMORY;
6276 }
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006277
Gilles Peskine449bd832023-01-11 14:50:10 +01006278 status = psa_key_derivation_output_bytes(operation, data, bytes);
6279 if (status != PSA_SUCCESS) {
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006280 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006281 }
David Brown12ca5032021-02-11 11:02:00 -07006282#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01006283 if (slot->attr.type == PSA_KEY_TYPE_DES) {
6284 psa_des_set_key_parity(data, bytes);
6285 }
Przemek Stekielf110dc02022-03-01 14:48:05 +01006286#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006287 } else {
6288 return PSA_ERROR_NOT_SUPPORTED;
Przemyslaw Stekiel1608e332021-11-09 10:46:40 +01006289 }
Ronald Crondd04d422020-11-28 15:14:42 +01006290
Ronald Cronbf33c932020-11-28 18:06:53 +01006291 slot->attr.bits = (psa_key_bits_t) bits;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01006292 attributes = (psa_key_attributes_t) {
Gilles Peskine449bd832023-01-11 14:50:10 +01006293 .core = slot->attr
Ronald Cron2ebfdcc2020-11-28 15:54:54 +01006294 };
6295
Gilles Peskine449bd832023-01-11 14:50:10 +01006296 if (psa_key_lifetime_is_external(attributes.core.lifetime)) {
6297 status = psa_driver_wrapper_get_key_buffer_size(&attributes,
6298 &storage_size);
6299 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306300 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006301 }
Archanad8a83dc2021-06-14 10:04:16 +05306302 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006303 status = psa_allocate_buffer_to_slot(slot, storage_size);
6304 if (status != PSA_SUCCESS) {
Archanad8a83dc2021-06-14 10:04:16 +05306305 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01006306 }
Archanad8a83dc2021-06-14 10:04:16 +05306307
Gilles Peskine449bd832023-01-11 14:50:10 +01006308 status = psa_driver_wrapper_import_key(&attributes,
6309 data, bytes,
6310 slot->key.data,
6311 slot->key.bytes,
6312 &slot->key.bytes, &bits);
6313 if (bits != slot->attr.bits) {
Ronald Cronbf33c932020-11-28 18:06:53 +01006314 status = PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006315 }
Gilles Peskineeab56e42018-07-12 17:12:33 +02006316
6317exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01006318 mbedtls_free(data);
6319 return status;
Gilles Peskineeab56e42018-07-12 17:12:33 +02006320}
6321
Gilles Peskine449bd832023-01-11 14:50:10 +01006322psa_status_t psa_key_derivation_output_key(const psa_key_attributes_t *attributes,
6323 psa_key_derivation_operation_t *operation,
6324 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006325{
6326 psa_status_t status;
6327 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02006328 psa_se_drv_table_entry_t *driver = NULL;
Gilles Peskine0f84d622019-09-12 19:03:13 +02006329
Ronald Cron81709fc2020-11-14 12:10:32 +01006330 *key = MBEDTLS_SVC_KEY_ID_INIT;
6331
Gilles Peskine0f84d622019-09-12 19:03:13 +02006332 /* Reject any attempt to create a zero-length key so that we don't
6333 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006334 if (psa_get_key_bits(attributes) == 0) {
6335 return PSA_ERROR_INVALID_ARGUMENT;
6336 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02006337
Gilles Peskine449bd832023-01-11 14:50:10 +01006338 if (operation->alg == PSA_ALG_NONE) {
6339 return PSA_ERROR_BAD_STATE;
6340 }
Dave Rodgmand69da6c2021-11-16 10:32:48 +00006341
Gilles Peskine449bd832023-01-11 14:50:10 +01006342 if (!operation->can_output_key) {
6343 return PSA_ERROR_NOT_PERMITTED;
6344 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02006345
Gilles Peskine449bd832023-01-11 14:50:10 +01006346 status = psa_start_key_creation(PSA_KEY_CREATION_DERIVE, attributes,
6347 &slot, &driver);
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006348#if defined(MBEDTLS_PSA_CRYPTO_SE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01006349 if (driver != NULL) {
Gilles Peskinef4ee6622019-07-24 13:44:30 +02006350 /* Deriving a key in a secure element is not implemented yet. */
6351 status = PSA_ERROR_NOT_SUPPORTED;
6352 }
6353#endif /* MBEDTLS_PSA_CRYPTO_SE_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01006354 if (status == PSA_SUCCESS) {
6355 status = psa_generate_derived_key_internal(slot,
6356 attributes->core.bits,
6357 operation);
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006358 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006359 if (status == PSA_SUCCESS) {
6360 status = psa_finish_key_creation(slot, driver, key);
6361 }
6362 if (status != PSA_SUCCESS) {
6363 psa_fail_key_creation(slot, driver);
6364 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02006365
Gilles Peskine449bd832023-01-11 14:50:10 +01006366 return status;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02006367}
6368
Gilles Peskineeab56e42018-07-12 17:12:33 +02006369
6370
6371/****************************************************************/
Gilles Peskineea0fb492018-07-12 17:17:20 +02006372/* Key derivation */
6373/****************************************************************/
6374
Steven Cooreman932ffb72021-02-15 12:14:32 +01006375#if defined(AT_LEAST_ONE_BUILTIN_KDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006376static int is_kdf_alg_supported(psa_algorithm_t kdf_alg)
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006377{
6378#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006379 if (PSA_ALG_IS_HKDF(kdf_alg)) {
6380 return 1;
6381 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006382#endif
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006383#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006384 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6385 return 1;
6386 }
Przemek Stekielb57a44b2022-06-06 08:33:45 +02006387#endif
6388#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006389 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6390 return 1;
6391 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006392#endif
6393#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006394 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
6395 return 1;
6396 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006397#endif
6398#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006399 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
6400 return 1;
6401 }
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006402#endif
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006403#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006404 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6405 return 1;
6406 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006407#endif
Kusumit Ghoderaod132cac2023-05-03 12:00:27 +05306408#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
6409 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
6410 return 1;
6411 }
6412#endif
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306413#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
6414 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
6415 return 1;
6416 }
6417#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01006418 return 0;
Gilles Peskine9efde4f2021-04-29 21:10:00 +02006419}
6420
Gilles Peskine449bd832023-01-11 14:50:10 +01006421static psa_status_t psa_hash_try_support(psa_algorithm_t alg)
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006422{
6423 psa_hash_operation_t operation = PSA_HASH_OPERATION_INIT;
Gilles Peskine449bd832023-01-11 14:50:10 +01006424 psa_status_t status = psa_hash_setup(&operation, alg);
6425 psa_hash_abort(&operation);
6426 return status;
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006427}
6428
Gilles Peskine969c5d62019-01-16 15:53:06 +01006429static psa_status_t psa_key_derivation_setup_kdf(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006430 psa_key_derivation_operation_t *operation,
Gilles Peskine449bd832023-01-11 14:50:10 +01006431 psa_algorithm_t kdf_alg)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006432{
Janos Follath5fe19732019-06-20 15:09:30 +01006433 /* Make sure that operation->ctx is properly zero-initialised. (Macro
6434 * initialisers for this union leave some bytes unspecified.) */
Gilles Peskine449bd832023-01-11 14:50:10 +01006435 memset(&operation->ctx, 0, sizeof(operation->ctx));
Janos Follath5fe19732019-06-20 15:09:30 +01006436
Gilles Peskine969c5d62019-01-16 15:53:06 +01006437 /* Make sure that kdf_alg is a supported key derivation algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006438 if (!is_kdf_alg_supported(kdf_alg)) {
6439 return PSA_ERROR_NOT_SUPPORTED;
6440 }
John Durkop07cc04a2020-11-16 22:08:34 -08006441
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006442 /* All currently supported key derivation algorithms (apart from
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306443 * ecjpake to pms and pbkdf2_aes_cmac_128) are based on a hash algorithm. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006444 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
6445 size_t hash_size = PSA_HASH_LENGTH(hash_alg);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306446 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6447 hash_size = PSA_HASH_LENGTH(PSA_ALG_SHA_256);
6448 } else if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05306449 hash_size = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao2cd64962023-06-22 15:38:57 +05306450 } else {
Gilles Peskine449bd832023-01-11 14:50:10 +01006451 if (hash_size == 0) {
6452 return PSA_ERROR_NOT_SUPPORTED;
6453 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006454
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006455 /* Make sure that hash_alg is a supported hash algorithm. Otherwise
6456 * we might fail later, which is somewhat unfriendly and potentially
6457 * risk-prone. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006458 psa_status_t status = psa_hash_try_support(hash_alg);
6459 if (status != PSA_SUCCESS) {
6460 return status;
6461 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006462 }
Gilles Peskine0cc417d2021-04-29 21:18:14 +02006463
Gilles Peskine449bd832023-01-11 14:50:10 +01006464 if ((PSA_ALG_IS_TLS12_PRF(kdf_alg) ||
6465 PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) &&
6466 !(hash_alg == PSA_ALG_SHA_256 || hash_alg == PSA_ALG_SHA_384)) {
6467 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006468 }
Andrzej Kurek77638292022-09-16 12:24:52 -04006469#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT) || \
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006470 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006471 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg) ||
6472 (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS)) {
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006473 operation->capacity = hash_size;
Gilles Peskine449bd832023-01-11 14:50:10 +01006474 } else
Andrzej Kurekb510cd22022-09-26 10:50:22 -04006475#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT ||
6476 MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Gilles Peskine449bd832023-01-11 14:50:10 +01006477 operation->capacity = 255 * hash_size;
6478 return PSA_SUCCESS;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006479}
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006480
Gilles Peskine449bd832023-01-11 14:50:10 +01006481static psa_status_t psa_key_agreement_try_support(psa_algorithm_t alg)
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006482{
6483#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01006484 if (alg == PSA_ALG_ECDH) {
6485 return PSA_SUCCESS;
6486 }
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006487#endif
Przemek Stekielfb3dd542022-12-01 14:59:15 +01006488#if defined(PSA_WANT_ALG_FFDH)
6489 if (alg == PSA_ALG_FFDH) {
6490 return PSA_SUCCESS;
6491 }
6492#endif
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006493 (void) alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006494 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine0c3a0712021-04-29 21:34:33 +02006495}
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006496
6497static int psa_key_derivation_allows_free_form_secret_input(
6498 psa_algorithm_t kdf_alg)
6499{
6500#if defined(PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS)
6501 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
6502 return 0;
6503 }
6504#endif
6505 (void) kdf_alg;
6506 return 1;
6507}
John Durkop07cc04a2020-11-16 22:08:34 -08006508#endif /* AT_LEAST_ONE_BUILTIN_KDF */
Gilles Peskine969c5d62019-01-16 15:53:06 +01006509
Gilles Peskine449bd832023-01-11 14:50:10 +01006510psa_status_t psa_key_derivation_setup(psa_key_derivation_operation_t *operation,
6511 psa_algorithm_t alg)
Gilles Peskine969c5d62019-01-16 15:53:06 +01006512{
6513 psa_status_t status;
6514
Gilles Peskine449bd832023-01-11 14:50:10 +01006515 if (operation->alg != 0) {
6516 return PSA_ERROR_BAD_STATE;
Gilles Peskine969c5d62019-01-16 15:53:06 +01006517 }
Gilles Peskine969c5d62019-01-16 15:53:06 +01006518
Gilles Peskine449bd832023-01-11 14:50:10 +01006519 if (PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
6520 return PSA_ERROR_INVALID_ARGUMENT;
6521 } else if (PSA_ALG_IS_KEY_AGREEMENT(alg)) {
6522#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6523 psa_algorithm_t kdf_alg = PSA_ALG_KEY_AGREEMENT_GET_KDF(alg);
6524 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(alg);
6525 status = psa_key_agreement_try_support(ka_alg);
6526 if (status != PSA_SUCCESS) {
6527 return status;
6528 }
Gilles Peskinebb3814c2022-12-16 01:12:12 +01006529 if (!psa_key_derivation_allows_free_form_secret_input(kdf_alg)) {
6530 return PSA_ERROR_INVALID_ARGUMENT;
6531 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006532 status = psa_key_derivation_setup_kdf(operation, kdf_alg);
6533#else
6534 return PSA_ERROR_NOT_SUPPORTED;
6535#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6536 } else if (PSA_ALG_IS_KEY_DERIVATION(alg)) {
6537#if defined(AT_LEAST_ONE_BUILTIN_KDF)
6538 status = psa_key_derivation_setup_kdf(operation, alg);
6539#else
6540 return PSA_ERROR_NOT_SUPPORTED;
6541#endif /* AT_LEAST_ONE_BUILTIN_KDF */
6542 } else {
6543 return PSA_ERROR_INVALID_ARGUMENT;
6544 }
6545
6546 if (status == PSA_SUCCESS) {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02006547 operation->alg = alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01006548 }
6549 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006550}
6551
Przemek Stekiel69c46792022-06-10 12:59:51 +02006552#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01006553static psa_status_t psa_hkdf_input(psa_hkdf_key_derivation_t *hkdf,
6554 psa_algorithm_t kdf_alg,
6555 psa_key_derivation_step_t step,
6556 const uint8_t *data,
6557 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006558{
Gilles Peskine449bd832023-01-11 14:50:10 +01006559 psa_algorithm_t hash_alg = PSA_ALG_HKDF_GET_HASH(kdf_alg);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006560 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006561 switch (step) {
Gilles Peskine03410b52019-05-16 16:05:19 +02006562 case PSA_KEY_DERIVATION_INPUT_SALT:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006563#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006564 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
6565 return PSA_ERROR_INVALID_ARGUMENT;
6566 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006567#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Gilles Peskine449bd832023-01-11 14:50:10 +01006568 if (hkdf->state != HKDF_STATE_INIT) {
6569 return PSA_ERROR_BAD_STATE;
6570 } else {
6571 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6572 hash_alg,
6573 data, data_length);
6574 if (status != PSA_SUCCESS) {
6575 return status;
6576 }
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006577 hkdf->state = HKDF_STATE_STARTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01006578 return PSA_SUCCESS;
Steven Cooremand1ed1d92021-04-29 19:11:25 +02006579 }
Gilles Peskine03410b52019-05-16 16:05:19 +02006580 case PSA_KEY_DERIVATION_INPUT_SECRET:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006581#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006582 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg)) {
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006583 /* We shouldn't be in different state as HKDF_EXPAND only allows
6584 * two inputs: SECRET (this case) and INFO which does not modify
6585 * the state. It could happen only if the hkdf
6586 * object was corrupted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006587 if (hkdf->state != HKDF_STATE_INIT) {
6588 return PSA_ERROR_BAD_STATE;
6589 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006590
Przemek Stekiel2fb0dcd2022-05-19 10:34:37 +02006591 /* Allow only input that fits expected prk size */
Gilles Peskine449bd832023-01-11 14:50:10 +01006592 if (data_length != PSA_HASH_LENGTH(hash_alg)) {
6593 return PSA_ERROR_INVALID_ARGUMENT;
6594 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006595
Gilles Peskine449bd832023-01-11 14:50:10 +01006596 memcpy(hkdf->prk, data, data_length);
6597 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006598#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND */
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006599 {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006600 /* HKDF: If no salt was provided, use an empty salt.
6601 * HKDF-EXTRACT: salt is mandatory. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006602 if (hkdf->state == HKDF_STATE_INIT) {
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006603#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006604 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6605 return PSA_ERROR_BAD_STATE;
6606 }
Przemek Stekiel0586f4c2022-06-03 16:00:25 +02006607#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006608 status = psa_key_derivation_start_hmac(&hkdf->hmac,
6609 hash_alg,
6610 NULL, 0);
6611 if (status != PSA_SUCCESS) {
6612 return status;
6613 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006614 hkdf->state = HKDF_STATE_STARTED;
6615 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006616 if (hkdf->state != HKDF_STATE_STARTED) {
6617 return PSA_ERROR_BAD_STATE;
6618 }
6619 status = psa_mac_update(&hkdf->hmac,
6620 data, data_length);
6621 if (status != PSA_SUCCESS) {
6622 return status;
6623 }
6624 status = psa_mac_sign_finish(&hkdf->hmac,
6625 hkdf->prk,
6626 sizeof(hkdf->prk),
6627 &data_length);
6628 if (status != PSA_SUCCESS) {
6629 return status;
6630 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006631 }
Przemek Stekiel17520fe2022-05-10 13:53:33 +02006632
Gilles Peskine2b522db2019-04-12 15:11:49 +02006633 hkdf->state = HKDF_STATE_KEYED;
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006634 hkdf->block_number = 0;
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006635#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006636 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006637 /* The only block of output is the PRK. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006638 memcpy(hkdf->output_block, hkdf->prk, PSA_HASH_LENGTH(hash_alg));
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006639 hkdf->offset_in_block = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01006640 } else
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006641#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006642 {
6643 /* Block 0 is empty, and the next block will be
6644 * generated by psa_key_derivation_hkdf_read(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01006645 hkdf->offset_in_block = PSA_HASH_LENGTH(hash_alg);
Przemek Stekiel03d948c2022-05-19 11:45:20 +02006646 }
6647
Gilles Peskine449bd832023-01-11 14:50:10 +01006648 return PSA_SUCCESS;
Gilles Peskine03410b52019-05-16 16:05:19 +02006649 case PSA_KEY_DERIVATION_INPUT_INFO:
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006650#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT)
Gilles Peskine449bd832023-01-11 14:50:10 +01006651 if (PSA_ALG_IS_HKDF_EXTRACT(kdf_alg)) {
6652 return PSA_ERROR_INVALID_ARGUMENT;
6653 }
Przemek Stekiel3e8249c2022-06-03 14:05:07 +02006654#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Przemek Stekielcde3f782022-06-03 16:12:27 +02006655#if defined(MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXPAND)
Gilles Peskine449bd832023-01-11 14:50:10 +01006656 if (PSA_ALG_IS_HKDF_EXPAND(kdf_alg) &&
6657 hkdf->state == HKDF_STATE_INIT) {
6658 return PSA_ERROR_BAD_STATE;
6659 }
Przemek Stekielcde3f782022-06-03 16:12:27 +02006660#endif /* MBEDTLS_PSA_BUILTIN_ALG_HKDF_EXTRACT */
Gilles Peskine449bd832023-01-11 14:50:10 +01006661 if (hkdf->state == HKDF_STATE_OUTPUT) {
6662 return PSA_ERROR_BAD_STATE;
6663 }
6664 if (hkdf->info_set) {
6665 return PSA_ERROR_BAD_STATE;
6666 }
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006667 hkdf->info_length = data_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01006668 if (data_length != 0) {
6669 hkdf->info = mbedtls_calloc(1, data_length);
6670 if (hkdf->info == NULL) {
6671 return PSA_ERROR_INSUFFICIENT_MEMORY;
6672 }
6673 memcpy(hkdf->info, data, data_length);
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006674 }
6675 hkdf->info_set = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01006676 return PSA_SUCCESS;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006677 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006678 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006679 }
6680}
Przemek Stekiel69c46792022-06-10 12:59:51 +02006681#endif /* BUILTIN_ALG_ANY_HKDF */
Janos Follathb03233e2019-06-11 15:30:30 +01006682
John Durkop07cc04a2020-11-16 22:08:34 -08006683#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) || \
6684 defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01006685static psa_status_t psa_tls12_prf_set_seed(psa_tls12_prf_key_derivation_t *prf,
6686 const uint8_t *data,
6687 size_t data_length)
Janos Follathf08e2652019-06-13 09:05:41 +01006688{
Gilles Peskine449bd832023-01-11 14:50:10 +01006689 if (prf->state != PSA_TLS12_PRF_STATE_INIT) {
6690 return PSA_ERROR_BAD_STATE;
6691 }
Janos Follathf08e2652019-06-13 09:05:41 +01006692
Gilles Peskine449bd832023-01-11 14:50:10 +01006693 if (data_length != 0) {
6694 prf->seed = mbedtls_calloc(1, data_length);
6695 if (prf->seed == NULL) {
6696 return PSA_ERROR_INSUFFICIENT_MEMORY;
6697 }
Janos Follathf08e2652019-06-13 09:05:41 +01006698
Gilles Peskine449bd832023-01-11 14:50:10 +01006699 memcpy(prf->seed, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006700 prf->seed_length = data_length;
6701 }
Janos Follathf08e2652019-06-13 09:05:41 +01006702
Gilles Peskine43f958b2020-12-13 14:55:14 +01006703 prf->state = PSA_TLS12_PRF_STATE_SEED_SET;
Janos Follathf08e2652019-06-13 09:05:41 +01006704
Gilles Peskine449bd832023-01-11 14:50:10 +01006705 return PSA_SUCCESS;
Janos Follathf08e2652019-06-13 09:05:41 +01006706}
6707
Gilles Peskine449bd832023-01-11 14:50:10 +01006708static psa_status_t psa_tls12_prf_set_key(psa_tls12_prf_key_derivation_t *prf,
6709 const uint8_t *data,
6710 size_t data_length)
Janos Follath81550542019-06-13 14:26:34 +01006711{
Gilles Peskine449bd832023-01-11 14:50:10 +01006712 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET &&
6713 prf->state != PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6714 return PSA_ERROR_BAD_STATE;
6715 }
Janos Follath81550542019-06-13 14:26:34 +01006716
Gilles Peskine449bd832023-01-11 14:50:10 +01006717 if (data_length != 0) {
6718 prf->secret = mbedtls_calloc(1, data_length);
6719 if (prf->secret == NULL) {
6720 return PSA_ERROR_INSUFFICIENT_MEMORY;
6721 }
Steven Cooremana6df6042021-04-29 19:32:25 +02006722
Gilles Peskine449bd832023-01-11 14:50:10 +01006723 memcpy(prf->secret, data, data_length);
Steven Cooremana6df6042021-04-29 19:32:25 +02006724 prf->secret_length = data_length;
6725 }
Janos Follath81550542019-06-13 14:26:34 +01006726
Gilles Peskine43f958b2020-12-13 14:55:14 +01006727 prf->state = PSA_TLS12_PRF_STATE_KEY_SET;
Janos Follath81550542019-06-13 14:26:34 +01006728
Gilles Peskine449bd832023-01-11 14:50:10 +01006729 return PSA_SUCCESS;
Janos Follath81550542019-06-13 14:26:34 +01006730}
6731
Gilles Peskine449bd832023-01-11 14:50:10 +01006732static psa_status_t psa_tls12_prf_set_label(psa_tls12_prf_key_derivation_t *prf,
6733 const uint8_t *data,
6734 size_t data_length)
Janos Follath63028dd2019-06-13 09:15:47 +01006735{
Gilles Peskine449bd832023-01-11 14:50:10 +01006736 if (prf->state != PSA_TLS12_PRF_STATE_KEY_SET) {
6737 return PSA_ERROR_BAD_STATE;
6738 }
Janos Follath63028dd2019-06-13 09:15:47 +01006739
Gilles Peskine449bd832023-01-11 14:50:10 +01006740 if (data_length != 0) {
6741 prf->label = mbedtls_calloc(1, data_length);
6742 if (prf->label == NULL) {
6743 return PSA_ERROR_INSUFFICIENT_MEMORY;
6744 }
Janos Follath63028dd2019-06-13 09:15:47 +01006745
Gilles Peskine449bd832023-01-11 14:50:10 +01006746 memcpy(prf->label, data, data_length);
Janos Follathd6dce9f2019-07-04 09:11:38 +01006747 prf->label_length = data_length;
6748 }
Janos Follath63028dd2019-06-13 09:15:47 +01006749
Gilles Peskine43f958b2020-12-13 14:55:14 +01006750 prf->state = PSA_TLS12_PRF_STATE_LABEL_SET;
Janos Follath63028dd2019-06-13 09:15:47 +01006751
Gilles Peskine449bd832023-01-11 14:50:10 +01006752 return PSA_SUCCESS;
Janos Follath63028dd2019-06-13 09:15:47 +01006753}
6754
Gilles Peskine449bd832023-01-11 14:50:10 +01006755static psa_status_t psa_tls12_prf_input(psa_tls12_prf_key_derivation_t *prf,
6756 psa_key_derivation_step_t step,
6757 const uint8_t *data,
6758 size_t data_length)
Janos Follathb03233e2019-06-11 15:30:30 +01006759{
Gilles Peskine449bd832023-01-11 14:50:10 +01006760 switch (step) {
Janos Follathf08e2652019-06-13 09:05:41 +01006761 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01006762 return psa_tls12_prf_set_seed(prf, data, data_length);
Janos Follath81550542019-06-13 14:26:34 +01006763 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006764 return psa_tls12_prf_set_key(prf, data, data_length);
Janos Follath63028dd2019-06-13 09:15:47 +01006765 case PSA_KEY_DERIVATION_INPUT_LABEL:
Gilles Peskine449bd832023-01-11 14:50:10 +01006766 return psa_tls12_prf_set_label(prf, data, data_length);
Janos Follathb03233e2019-06-11 15:30:30 +01006767 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006768 return PSA_ERROR_INVALID_ARGUMENT;
Janos Follathb03233e2019-06-11 15:30:30 +01006769 }
6770}
John Durkop07cc04a2020-11-16 22:08:34 -08006771#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF) ||
6772 * MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
6773
6774#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
6775static psa_status_t psa_tls12_prf_psk_to_ms_set_key(
6776 psa_tls12_prf_key_derivation_t *prf,
John Durkop07cc04a2020-11-16 22:08:34 -08006777 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006778 size_t data_length)
John Durkop07cc04a2020-11-16 22:08:34 -08006779{
6780 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01006781 const size_t pms_len = (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET ?
6782 4 + data_length + prf->other_secret_length :
6783 4 + 2 * data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006784
Gilles Peskine449bd832023-01-11 14:50:10 +01006785 if (data_length > PSA_TLS12_PSK_TO_MS_PSK_MAX_SIZE) {
6786 return PSA_ERROR_INVALID_ARGUMENT;
6787 }
John Durkop07cc04a2020-11-16 22:08:34 -08006788
Gilles Peskine449bd832023-01-11 14:50:10 +01006789 uint8_t *pms = mbedtls_calloc(1, pms_len);
6790 if (pms == NULL) {
6791 return PSA_ERROR_INSUFFICIENT_MEMORY;
6792 }
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006793 uint8_t *cur = pms;
6794
6795 /* pure-PSK:
6796 * Quoting RFC 4279, Section 2:
John Durkop07cc04a2020-11-16 22:08:34 -08006797 *
6798 * The premaster secret is formed as follows: if the PSK is N octets
6799 * long, concatenate a uint16 with the value N, N zero octets, a second
6800 * uint16 with the value N, and the PSK itself.
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006801 *
6802 * mixed-PSK:
6803 * In a DHE-PSK, RSA-PSK, ECDHE-PSK the premaster secret is formed as
6804 * follows: concatenate a uint16 with the length of the other secret,
6805 * the other secret itself, uint16 with the length of PSK, and the
6806 * PSK itself.
6807 * For details please check:
6808 * - RFC 4279, Section 4 for the definition of RSA-PSK,
6809 * - RFC 4279, Section 3 for the definition of DHE-PSK,
6810 * - RFC 5489 for the definition of ECDHE-PSK.
John Durkop07cc04a2020-11-16 22:08:34 -08006811 */
6812
Gilles Peskine449bd832023-01-11 14:50:10 +01006813 if (prf->state == PSA_TLS12_PRF_STATE_OTHER_KEY_SET) {
6814 *cur++ = MBEDTLS_BYTE_1(prf->other_secret_length);
6815 *cur++ = MBEDTLS_BYTE_0(prf->other_secret_length);
6816 if (prf->other_secret_length != 0) {
6817 memcpy(cur, prf->other_secret, prf->other_secret_length);
6818 mbedtls_platform_zeroize(prf->other_secret, prf->other_secret_length);
Przemek Stekiel2503f7e2022-04-12 12:08:01 +02006819 cur += prf->other_secret_length;
6820 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006821 } else {
6822 *cur++ = MBEDTLS_BYTE_1(data_length);
6823 *cur++ = MBEDTLS_BYTE_0(data_length);
6824 memset(cur, 0, data_length);
Przemek Stekielc8fa5a12022-04-07 14:17:13 +02006825 cur += data_length;
6826 }
6827
Gilles Peskine449bd832023-01-11 14:50:10 +01006828 *cur++ = MBEDTLS_BYTE_1(data_length);
6829 *cur++ = MBEDTLS_BYTE_0(data_length);
6830 memcpy(cur, data, data_length);
John Durkop07cc04a2020-11-16 22:08:34 -08006831 cur += data_length;
6832
Dave Rodgmane4a6f5a2023-11-04 12:20:09 +00006833 status = psa_tls12_prf_set_key(prf, pms, (size_t) (cur - pms));
John Durkop07cc04a2020-11-16 22:08:34 -08006834
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01006835 mbedtls_zeroize_and_free(pms, pms_len);
Gilles Peskine449bd832023-01-11 14:50:10 +01006836 return status;
John Durkop07cc04a2020-11-16 22:08:34 -08006837}
Janos Follath6660f0e2019-06-17 08:44:03 +01006838
Przemek Stekiele47201b2022-04-19 13:53:28 +02006839static psa_status_t psa_tls12_prf_psk_to_ms_set_other_key(
6840 psa_tls12_prf_key_derivation_t *prf,
6841 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006842 size_t data_length)
Przemek Stekiele47201b2022-04-19 13:53:28 +02006843{
Gilles Peskine449bd832023-01-11 14:50:10 +01006844 if (prf->state != PSA_TLS12_PRF_STATE_SEED_SET) {
6845 return PSA_ERROR_BAD_STATE;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006846 }
Gilles Peskine449bd832023-01-11 14:50:10 +01006847
6848 if (data_length != 0) {
6849 prf->other_secret = mbedtls_calloc(1, data_length);
6850 if (prf->other_secret == NULL) {
6851 return PSA_ERROR_INSUFFICIENT_MEMORY;
6852 }
6853
6854 memcpy(prf->other_secret, data, data_length);
6855 prf->other_secret_length = data_length;
6856 } else {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006857 prf->other_secret_length = 0;
6858 }
6859
6860 prf->state = PSA_TLS12_PRF_STATE_OTHER_KEY_SET;
6861
Gilles Peskine449bd832023-01-11 14:50:10 +01006862 return PSA_SUCCESS;
Przemek Stekiele47201b2022-04-19 13:53:28 +02006863}
6864
Janos Follath6660f0e2019-06-17 08:44:03 +01006865static psa_status_t psa_tls12_prf_psk_to_ms_input(
6866 psa_tls12_prf_key_derivation_t *prf,
Janos Follath6660f0e2019-06-17 08:44:03 +01006867 psa_key_derivation_step_t step,
6868 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006869 size_t data_length)
Janos Follath6660f0e2019-06-17 08:44:03 +01006870{
Gilles Peskine449bd832023-01-11 14:50:10 +01006871 switch (step) {
Przemek Stekiele47201b2022-04-19 13:53:28 +02006872 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006873 return psa_tls12_prf_psk_to_ms_set_key(prf,
6874 data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006875 break;
6876 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01006877 return psa_tls12_prf_psk_to_ms_set_other_key(prf,
6878 data,
6879 data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006880 break;
6881 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01006882 return psa_tls12_prf_input(prf, step, data, data_length);
Przemek Stekiele47201b2022-04-19 13:53:28 +02006883 break;
Janos Follath6660f0e2019-06-17 08:44:03 +01006884
Przemek Stekiele47201b2022-04-19 13:53:28 +02006885 }
Janos Follath6660f0e2019-06-17 08:44:03 +01006886}
John Durkop07cc04a2020-11-16 22:08:34 -08006887#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01006888
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006889#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
6890static psa_status_t psa_tls12_ecjpake_to_pms_input(
6891 psa_tls12_ecjpake_to_pms_t *ecjpake,
Andrzej Kurek702776f2022-09-16 06:22:44 -04006892 psa_key_derivation_step_t step,
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006893 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01006894 size_t data_length)
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006895{
Gilles Peskine449bd832023-01-11 14:50:10 +01006896 if (data_length != PSA_TLS12_ECJPAKE_TO_PMS_INPUT_SIZE ||
6897 step != PSA_KEY_DERIVATION_INPUT_SECRET) {
6898 return PSA_ERROR_INVALID_ARGUMENT;
Andrzej Kurek5603efd2022-09-26 10:49:16 -04006899 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006900
6901 /* Check if the passed point is in an uncompressed form */
Gilles Peskine449bd832023-01-11 14:50:10 +01006902 if (data[0] != 0x04) {
6903 return PSA_ERROR_INVALID_ARGUMENT;
6904 }
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006905
6906 /* Only K.X has to be extracted - bytes 1 to 32 inclusive. */
Gilles Peskine449bd832023-01-11 14:50:10 +01006907 memcpy(ecjpake->data, data + 1, PSA_TLS12_ECJPAKE_TO_PMS_DATA_SIZE);
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006908
Gilles Peskine449bd832023-01-11 14:50:10 +01006909 return PSA_SUCCESS;
Andrzej Kurek08d34b82022-07-29 10:00:16 -04006910}
6911#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306912
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05306913#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306914static psa_status_t psa_pbkdf2_set_input_cost(
6915 psa_pbkdf2_key_derivation_t *pbkdf2,
6916 psa_key_derivation_step_t step,
6917 uint64_t data)
6918{
6919 if (step != PSA_KEY_DERIVATION_INPUT_COST) {
6920 return PSA_ERROR_INVALID_ARGUMENT;
6921 }
6922
6923 if (pbkdf2->state != PSA_PBKDF2_STATE_INIT) {
6924 return PSA_ERROR_BAD_STATE;
6925 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306926
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306927 if (data > PSA_VENDOR_PBKDF2_MAX_ITERATIONS) {
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306928 return PSA_ERROR_NOT_SUPPORTED;
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306929 }
Kusumit Ghoderao3fc4ca72023-05-08 15:57:41 +05306930
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306931 if (data == 0) {
6932 return PSA_ERROR_INVALID_ARGUMENT;
6933 }
Kusumit Ghoderaoe66a8ad2023-05-24 12:30:43 +05306934
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05306935 pbkdf2->input_cost = data;
6936 pbkdf2->state = PSA_PBKDF2_STATE_INPUT_COST_SET;
6937
6938 return PSA_SUCCESS;
6939}
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306940
6941static psa_status_t psa_pbkdf2_set_salt(psa_pbkdf2_key_derivation_t *pbkdf2,
6942 const uint8_t *data,
6943 size_t data_length)
6944{
Gilles Peskineead17662023-08-20 22:02:51 +02006945 if (pbkdf2->state == PSA_PBKDF2_STATE_INPUT_COST_SET) {
6946 pbkdf2->state = PSA_PBKDF2_STATE_SALT_SET;
6947 } else if (pbkdf2->state == PSA_PBKDF2_STATE_SALT_SET) {
6948 /* Appending to existing salt. No state change. */
6949 } else {
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306950 return PSA_ERROR_BAD_STATE;
6951 }
6952
Gilles Peskineca57d782023-07-20 19:08:06 +02006953 if (data_length == 0) {
Gilles Peskineead17662023-08-20 22:02:51 +02006954 /* Appending an empty string, nothing to do. */
6955 } else {
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306956 uint8_t *next_salt;
Kusumit Ghoderaob538bb72023-05-24 12:32:14 +05306957
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306958 next_salt = mbedtls_calloc(1, data_length + pbkdf2->salt_length);
6959 if (next_salt == NULL) {
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306960 return PSA_ERROR_INSUFFICIENT_MEMORY;
6961 }
6962
Gilles Peskineead17662023-08-20 22:02:51 +02006963 if (pbkdf2->salt_length != 0) {
6964 memcpy(next_salt, pbkdf2->salt, pbkdf2->salt_length);
6965 }
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306966 memcpy(next_salt + pbkdf2->salt_length, data, data_length);
Kusumit Ghoderaod0422f32023-05-08 15:56:19 +05306967 pbkdf2->salt_length += data_length;
Kusumit Ghoderaod7a3f802023-05-24 22:19:47 +05306968 mbedtls_free(pbkdf2->salt);
6969 pbkdf2->salt = next_salt;
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306970 }
Kusumit Ghoderao547a6c62023-05-03 12:18:19 +05306971 return PSA_SUCCESS;
6972}
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05306973
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306974#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306975static psa_status_t psa_pbkdf2_hmac_set_password(psa_algorithm_t hash_alg,
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05306976 const uint8_t *input,
6977 size_t input_len,
6978 uint8_t *output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306979 size_t *output_len)
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306980{
6981 psa_status_t status = PSA_SUCCESS;
6982 if (input_len > PSA_HASH_BLOCK_LENGTH(hash_alg)) {
6983 status = psa_hash_compute(hash_alg, input, input_len, output,
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306984 PSA_HMAC_MAX_HASH_BLOCK_SIZE, output_len);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306985 } else {
6986 memcpy(output, input, input_len);
Kusumit Ghoderao91f99f52023-05-24 22:21:48 +05306987 *output_len = PSA_HASH_BLOCK_LENGTH(hash_alg);
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306988 }
6989 return status;
6990}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306991#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05306992
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05306993#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05306994static psa_status_t psa_pbkdf2_cmac_set_password(const uint8_t *input,
6995 size_t input_len,
6996 uint8_t *output,
6997 size_t *output_len)
6998{
6999 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307000 if (input_len != PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC)) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307001 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Kusumit Ghoderao3fde8fe2023-06-27 10:41:43 +05307002 uint8_t zeros[16] = { 0 };
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307003 psa_set_key_type(&attributes, PSA_KEY_TYPE_AES);
7004 psa_set_key_bits(&attributes, PSA_BYTES_TO_BITS(sizeof(zeros)));
7005 psa_set_key_usage_flags(&attributes, PSA_KEY_USAGE_SIGN_MESSAGE);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307006 /* Passing PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC) as
Kusumit Ghoderao5f3345a2023-07-27 21:21:38 +05307007 * mac_size as the driver function sets mac_output_length = mac_size
7008 * on success. See https://github.com/Mbed-TLS/mbedtls/issues/7801 */
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307009 status = psa_driver_wrapper_mac_compute(&attributes,
7010 zeros, sizeof(zeros),
7011 PSA_ALG_CMAC, input, input_len,
7012 output,
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307013 PSA_MAC_LENGTH(PSA_KEY_TYPE_AES,
7014 128U,
7015 PSA_ALG_CMAC),
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307016 output_len);
7017 } else {
7018 memcpy(output, input, input_len);
Kusumit Ghoderaoa12e2d52023-07-27 21:18:30 +05307019 *output_len = PSA_MAC_LENGTH(PSA_KEY_TYPE_AES, 128U, PSA_ALG_CMAC);
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307020 }
7021 return status;
7022}
Kusumit Ghoderao0bca4c52023-07-27 21:20:14 +05307023#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307024
7025static psa_status_t psa_pbkdf2_set_password(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307026 psa_algorithm_t kdf_alg,
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307027 const uint8_t *data,
7028 size_t data_length)
7029{
Kusumit Ghoderaoaac9a582023-05-24 14:19:17 +05307030 psa_status_t status = PSA_SUCCESS;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307031 if (pbkdf2->state != PSA_PBKDF2_STATE_SALT_SET) {
7032 return PSA_ERROR_BAD_STATE;
7033 }
7034
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307035#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC)
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307036 if (PSA_ALG_IS_PBKDF2_HMAC(kdf_alg)) {
7037 psa_algorithm_t hash_alg = PSA_ALG_PBKDF2_HMAC_GET_HASH(kdf_alg);
7038 status = psa_pbkdf2_hmac_set_password(hash_alg, data, data_length,
7039 pbkdf2->password,
7040 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307041 } else
7042#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_HMAC */
7043#if defined(MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128)
7044 if (kdf_alg == PSA_ALG_PBKDF2_AES_CMAC_PRF_128) {
Kusumit Ghoderao3d5edb82023-06-22 15:41:25 +05307045 status = psa_pbkdf2_cmac_set_password(data, data_length,
7046 pbkdf2->password,
7047 &pbkdf2->password_length);
Kusumit Ghoderaof3e696d2023-07-28 13:30:50 +05307048 } else
7049#endif /* MBEDTLS_PSA_BUILTIN_ALG_PBKDF2_AES_CMAC_PRF_128 */
7050 {
7051 return PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307052 }
7053
7054 pbkdf2->state = PSA_PBKDF2_STATE_PASSWORD_SET;
7055
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307056 return status;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307057}
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307058
7059static psa_status_t psa_pbkdf2_input(psa_pbkdf2_key_derivation_t *pbkdf2,
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307060 psa_algorithm_t kdf_alg,
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307061 psa_key_derivation_step_t step,
7062 const uint8_t *data,
7063 size_t data_length)
7064{
7065 switch (step) {
7066 case PSA_KEY_DERIVATION_INPUT_SALT:
7067 return psa_pbkdf2_set_salt(pbkdf2, data, data_length);
7068 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307069 return psa_pbkdf2_set_password(pbkdf2, kdf_alg, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307070 default:
7071 return PSA_ERROR_INVALID_ARGUMENT;
7072 }
7073}
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307074#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307075
Gilles Peskineb8965192019-09-24 16:21:10 +02007076/** Check whether the given key type is acceptable for the given
7077 * input step of a key derivation.
7078 *
7079 * Secret inputs must have the type #PSA_KEY_TYPE_DERIVE.
7080 * Non-secret inputs must have the type #PSA_KEY_TYPE_RAW_DATA.
7081 * Both secret and non-secret inputs can alternatively have the type
7082 * #PSA_KEY_TYPE_NONE, which is never the type of a key object, meaning
7083 * that the input was passed as a buffer rather than via a key object.
7084 */
Gilles Peskine224b0d62019-09-23 18:13:17 +02007085static int psa_key_derivation_check_input_type(
7086 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007087 psa_key_type_t key_type)
Gilles Peskine224b0d62019-09-23 18:13:17 +02007088{
Gilles Peskine449bd832023-01-11 14:50:10 +01007089 switch (step) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007090 case PSA_KEY_DERIVATION_INPUT_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007091 if (key_type == PSA_KEY_TYPE_DERIVE) {
7092 return PSA_SUCCESS;
7093 }
7094 if (key_type == PSA_KEY_TYPE_NONE) {
7095 return PSA_SUCCESS;
7096 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007097 break;
Przemek Stekiela7695a22022-04-07 15:39:01 +02007098 case PSA_KEY_DERIVATION_INPUT_OTHER_SECRET:
Gilles Peskine449bd832023-01-11 14:50:10 +01007099 if (key_type == PSA_KEY_TYPE_DERIVE) {
7100 return PSA_SUCCESS;
7101 }
7102 if (key_type == PSA_KEY_TYPE_NONE) {
7103 return PSA_SUCCESS;
7104 }
Przemek Stekiela7695a22022-04-07 15:39:01 +02007105 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007106 case PSA_KEY_DERIVATION_INPUT_LABEL:
7107 case PSA_KEY_DERIVATION_INPUT_SALT:
7108 case PSA_KEY_DERIVATION_INPUT_INFO:
7109 case PSA_KEY_DERIVATION_INPUT_SEED:
Gilles Peskine449bd832023-01-11 14:50:10 +01007110 if (key_type == PSA_KEY_TYPE_RAW_DATA) {
7111 return PSA_SUCCESS;
7112 }
7113 if (key_type == PSA_KEY_TYPE_NONE) {
7114 return PSA_SUCCESS;
7115 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007116 break;
Kusumit Ghoderaof4fe3ee2023-05-03 12:21:07 +05307117 case PSA_KEY_DERIVATION_INPUT_PASSWORD:
7118 if (key_type == PSA_KEY_TYPE_PASSWORD) {
7119 return PSA_SUCCESS;
7120 }
7121 if (key_type == PSA_KEY_TYPE_DERIVE) {
7122 return PSA_SUCCESS;
7123 }
7124 if (key_type == PSA_KEY_TYPE_NONE) {
7125 return PSA_SUCCESS;
7126 }
7127 break;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007128 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007129 return PSA_ERROR_INVALID_ARGUMENT;
Gilles Peskine224b0d62019-09-23 18:13:17 +02007130}
7131
Janos Follathb80a94e2019-06-12 15:54:46 +01007132static psa_status_t psa_key_derivation_input_internal(
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007133 psa_key_derivation_operation_t *operation,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007134 psa_key_derivation_step_t step,
Gilles Peskine224b0d62019-09-23 18:13:17 +02007135 psa_key_type_t key_type,
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007136 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007137 size_t data_length)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007138{
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007139 psa_status_t status;
Gilles Peskine449bd832023-01-11 14:50:10 +01007140 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
Gilles Peskine46d7faf2019-09-23 19:22:55 +02007141
Gilles Peskine449bd832023-01-11 14:50:10 +01007142 status = psa_key_derivation_check_input_type(step, key_type);
7143 if (status != PSA_SUCCESS) {
Gilles Peskine224b0d62019-09-23 18:13:17 +02007144 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007145 }
Gilles Peskine224b0d62019-09-23 18:13:17 +02007146
Przemek Stekiel69c46792022-06-10 12:59:51 +02007147#if defined(BUILTIN_ALG_ANY_HKDF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007148 if (PSA_ALG_IS_ANY_HKDF(kdf_alg)) {
7149 status = psa_hkdf_input(&operation->ctx.hkdf, kdf_alg,
7150 step, data, data_length);
7151 } else
Przemek Stekiel69c46792022-06-10 12:59:51 +02007152#endif /* BUILTIN_ALG_ANY_HKDF */
John Durkop07cc04a2020-11-16 22:08:34 -08007153#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF)
Gilles Peskine449bd832023-01-11 14:50:10 +01007154 if (PSA_ALG_IS_TLS12_PRF(kdf_alg)) {
7155 status = psa_tls12_prf_input(&operation->ctx.tls12_prf,
7156 step, data, data_length);
7157 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007158#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PRF */
7159#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007160 if (PSA_ALG_IS_TLS12_PSK_TO_MS(kdf_alg)) {
7161 status = psa_tls12_prf_psk_to_ms_input(&operation->ctx.tls12_prf,
7162 step, data, data_length);
7163 } else
John Durkop07cc04a2020-11-16 22:08:34 -08007164#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_PSK_TO_MS */
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007165#if defined(MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007166 if (kdf_alg == PSA_ALG_TLS12_ECJPAKE_TO_PMS) {
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007167 status = psa_tls12_ecjpake_to_pms_input(
Gilles Peskine449bd832023-01-11 14:50:10 +01007168 &operation->ctx.tls12_ecjpake_to_pms, step, data, data_length);
7169 } else
Andrzej Kurek08d34b82022-07-29 10:00:16 -04007170#endif /* MBEDTLS_PSA_BUILTIN_ALG_TLS12_ECJPAKE_TO_PMS */
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307171#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307172 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderaobd6cefb2023-05-24 12:36:34 +05307173 status = psa_pbkdf2_input(&operation->ctx.pbkdf2, kdf_alg,
7174 step, data, data_length);
Kusumit Ghoderao24b38952023-05-03 12:25:26 +05307175 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307176#endif /* PSA_HAVE_SOFT_PBKDF2 */
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007177 {
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007178 /* This can't happen unless the operation object was not initialized */
Steven Cooreman74afe472021-02-10 17:19:22 +01007179 (void) data;
7180 (void) data_length;
7181 (void) kdf_alg;
Gilles Peskine449bd832023-01-11 14:50:10 +01007182 return PSA_ERROR_BAD_STATE;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007183 }
7184
Gilles Peskine224b0d62019-09-23 18:13:17 +02007185exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007186 if (status != PSA_SUCCESS) {
7187 psa_key_derivation_abort(operation);
7188 }
7189 return status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007190}
7191
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307192static psa_status_t psa_key_derivation_input_integer_internal(
7193 psa_key_derivation_operation_t *operation,
7194 psa_key_derivation_step_t step,
7195 uint64_t value)
7196{
7197 psa_status_t status;
7198 psa_algorithm_t kdf_alg = psa_key_derivation_get_kdf_alg(operation);
7199
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307200#if defined(PSA_HAVE_SOFT_PBKDF2)
Kusumit Ghoderao9ab03c32023-07-27 21:14:05 +05307201 if (PSA_ALG_IS_PBKDF2(kdf_alg)) {
Kusumit Ghoderao944bba12023-05-03 12:14:03 +05307202 status = psa_pbkdf2_set_input_cost(
7203 &operation->ctx.pbkdf2, step, value);
7204 } else
Kusumit Ghoderao2addf352023-07-27 21:09:26 +05307205#endif /* PSA_HAVE_SOFT_PBKDF2 */
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307206 {
Kusumit Ghoderao3a18dee2023-04-07 16:16:27 +05307207 (void) step;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307208 (void) value;
7209 (void) kdf_alg;
Kusumit Ghoderaoa14ae5a2023-04-19 14:16:26 +05307210 status = PSA_ERROR_INVALID_ARGUMENT;
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307211 }
7212
7213 if (status != PSA_SUCCESS) {
7214 psa_key_derivation_abort(operation);
7215 }
7216 return status;
7217}
7218
Janos Follath51f4a0f2019-06-14 11:35:55 +01007219psa_status_t psa_key_derivation_input_bytes(
7220 psa_key_derivation_operation_t *operation,
7221 psa_key_derivation_step_t step,
7222 const uint8_t *data,
Gilles Peskine449bd832023-01-11 14:50:10 +01007223 size_t data_length)
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007224{
Gilles Peskine449bd832023-01-11 14:50:10 +01007225 return psa_key_derivation_input_internal(operation, step,
7226 PSA_KEY_TYPE_NONE,
7227 data, data_length);
Gilles Peskine6cdfdb72019-01-08 10:31:27 +01007228}
7229
Kusumit Ghoderao50e0e112023-04-06 17:47:25 +05307230psa_status_t psa_key_derivation_input_integer(
7231 psa_key_derivation_operation_t *operation,
7232 psa_key_derivation_step_t step,
7233 uint64_t value)
7234{
7235 return psa_key_derivation_input_integer_internal(operation, step, value);
7236}
7237
Janos Follath51f4a0f2019-06-14 11:35:55 +01007238psa_status_t psa_key_derivation_input_key(
7239 psa_key_derivation_operation_t *operation,
7240 psa_key_derivation_step_t step,
Gilles Peskine449bd832023-01-11 14:50:10 +01007241 mbedtls_svc_key_id_t key)
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007242{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007243 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007244 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007245 psa_key_slot_t *slot;
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007246
Ronald Cron5c522922020-11-14 16:35:34 +01007247 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007248 key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7249 if (status != PSA_SUCCESS) {
7250 psa_key_derivation_abort(operation);
7251 return status;
Gilles Peskine593773d2019-09-23 18:17:40 +02007252 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007253
Kusumit Ghoderao3128c5d2023-05-03 12:27:57 +05307254 /* Passing a key object as a SECRET or PASSWORD input unlocks the
7255 * permission to output to a key object. */
7256 if (step == PSA_KEY_DERIVATION_INPUT_SECRET ||
7257 step == PSA_KEY_DERIVATION_INPUT_PASSWORD) {
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007258 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007259 }
Gilles Peskine178c9aa2019-09-24 18:21:06 +02007260
Gilles Peskine449bd832023-01-11 14:50:10 +01007261 status = psa_key_derivation_input_internal(operation,
7262 step, slot->attr.type,
7263 slot->key.data,
7264 slot->key.bytes);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007265
Gilles Peskine449bd832023-01-11 14:50:10 +01007266 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007267
Gilles Peskine449bd832023-01-11 14:50:10 +01007268 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineb70a0fd2019-01-07 22:59:38 +01007269}
Gilles Peskineea0fb492018-07-12 17:17:20 +02007270
7271
7272
7273/****************************************************************/
Gilles Peskine01d718c2018-09-18 12:01:02 +02007274/* Key agreement */
7275/****************************************************************/
7276
Gilles Peskine449bd832023-01-11 14:50:10 +01007277psa_status_t psa_key_agreement_raw_builtin(const psa_key_attributes_t *attributes,
7278 const uint8_t *key_buffer,
7279 size_t key_buffer_size,
7280 psa_algorithm_t alg,
7281 const uint8_t *peer_key,
7282 size_t peer_key_length,
7283 uint8_t *shared_secret,
7284 size_t shared_secret_size,
7285 size_t *shared_secret_length)
Gilles Peskineb7ecdf02018-09-18 12:11:27 +02007286{
Gilles Peskine449bd832023-01-11 14:50:10 +01007287 switch (alg) {
John Durkop6ba40d12020-11-10 08:50:04 -08007288#if defined(MBEDTLS_PSA_BUILTIN_ALG_ECDH)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007289 case PSA_ALG_ECDH:
Gilles Peskine449bd832023-01-11 14:50:10 +01007290 return mbedtls_psa_key_agreement_ecdh(attributes, key_buffer,
7291 key_buffer_size, alg,
7292 peer_key, peer_key_length,
7293 shared_secret,
7294 shared_secret_size,
7295 shared_secret_length);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007296#endif /* MBEDTLS_PSA_BUILTIN_ALG_ECDH */
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007297
7298#if defined(MBEDTLS_PSA_BUILTIN_ALG_FFDH)
7299 case PSA_ALG_FFDH:
Przemek Stekiel152bb462023-06-01 11:52:39 +02007300 return mbedtls_psa_ffdh_key_agreement(attributes,
Przemek Stekiel359f4622022-12-05 14:11:55 +01007301 peer_key,
7302 peer_key_length,
7303 key_buffer,
7304 key_buffer_size,
7305 shared_secret,
7306 shared_secret_size,
7307 shared_secret_length);
Przemek Stekielfb3dd542022-12-01 14:59:15 +01007308#endif /* MBEDTLS_PSA_BUILTIN_ALG_FFDH */
7309
Gilles Peskine01d718c2018-09-18 12:01:02 +02007310 default:
Aditya Deshpande17845b82022-10-13 17:21:01 +01007311 (void) attributes;
7312 (void) key_buffer;
7313 (void) key_buffer_size;
Gilles Peskine93f85002018-11-16 16:43:31 +01007314 (void) peer_key;
7315 (void) peer_key_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007316 (void) shared_secret;
7317 (void) shared_secret_size;
7318 (void) shared_secret_length;
Gilles Peskine449bd832023-01-11 14:50:10 +01007319 return PSA_ERROR_NOT_SUPPORTED;
Gilles Peskine01d718c2018-09-18 12:01:02 +02007320 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007321}
Gilles Peskine01d718c2018-09-18 12:01:02 +02007322
Aditya Deshpande17845b82022-10-13 17:21:01 +01007323/** Internal function for raw key agreement
7324 * Calls the driver wrapper which will hand off key agreement task
Aditya Deshpande40c05cc2022-10-14 16:41:40 +01007325 * to the driver's implementation if a driver is present.
7326 * Fallback specified in the driver wrapper is built-in raw key agreement
Aditya Deshpande17845b82022-10-13 17:21:01 +01007327 * (psa_key_agreement_raw_builtin).
7328 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007329static psa_status_t psa_key_agreement_raw_internal(psa_algorithm_t alg,
7330 psa_key_slot_t *private_key,
7331 const uint8_t *peer_key,
7332 size_t peer_key_length,
7333 uint8_t *shared_secret,
7334 size_t shared_secret_size,
7335 size_t *shared_secret_length)
Gilles Peskine51ae0e42019-05-16 17:31:03 +02007336{
Gilles Peskine449bd832023-01-11 14:50:10 +01007337 if (!PSA_ALG_IS_RAW_KEY_AGREEMENT(alg)) {
7338 return PSA_ERROR_NOT_SUPPORTED;
7339 }
Aditya Deshpande17845b82022-10-13 17:21:01 +01007340
7341 psa_key_attributes_t attributes = {
Gilles Peskine449bd832023-01-11 14:50:10 +01007342 .core = private_key->attr
Aditya Deshpande17845b82022-10-13 17:21:01 +01007343 };
7344
Gilles Peskine449bd832023-01-11 14:50:10 +01007345 return psa_driver_wrapper_key_agreement(&attributes,
7346 private_key->key.data,
7347 private_key->key.bytes, alg,
7348 peer_key, peer_key_length,
7349 shared_secret,
7350 shared_secret_size,
7351 shared_secret_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007352}
7353
Gilles Peskinea99d3fb2019-05-16 15:28:51 +02007354/* Note that if this function fails, you must call psa_key_derivation_abort()
Gilles Peskine01d718c2018-09-18 12:01:02 +02007355 * to potentially free embedded data structures and wipe confidential data.
7356 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007357static psa_status_t psa_key_agreement_internal(psa_key_derivation_operation_t *operation,
7358 psa_key_derivation_step_t step,
7359 psa_key_slot_t *private_key,
7360 const uint8_t *peer_key,
7361 size_t peer_key_length)
Gilles Peskine01d718c2018-09-18 12:01:02 +02007362{
7363 psa_status_t status;
Aditya Deshpande2f7fd762022-11-22 11:10:34 +00007364 uint8_t shared_secret[PSA_RAW_KEY_AGREEMENT_OUTPUT_MAX_SIZE];
Gilles Peskine01d718c2018-09-18 12:01:02 +02007365 size_t shared_secret_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007366 psa_algorithm_t ka_alg = PSA_ALG_KEY_AGREEMENT_GET_BASE(operation->alg);
Gilles Peskine01d718c2018-09-18 12:01:02 +02007367
7368 /* Step 1: run the secret agreement algorithm to generate the shared
7369 * secret. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007370 status = psa_key_agreement_raw_internal(ka_alg,
7371 private_key,
7372 peer_key, peer_key_length,
7373 shared_secret,
7374 sizeof(shared_secret),
7375 &shared_secret_length);
7376 if (status != PSA_SUCCESS) {
Gilles Peskine12313cd2018-06-20 00:20:32 +02007377 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007378 }
Gilles Peskine12313cd2018-06-20 00:20:32 +02007379
Gilles Peskineb0b255c2018-07-06 17:01:38 +02007380 /* Step 2: set up the key derivation to generate key material from
Gilles Peskine224b0d62019-09-23 18:13:17 +02007381 * the shared secret. A shared secret is permitted wherever a key
7382 * of type DERIVE is permitted. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007383 status = psa_key_derivation_input_internal(operation, step,
7384 PSA_KEY_TYPE_DERIVE,
7385 shared_secret,
7386 shared_secret_length);
Gilles Peskine12313cd2018-06-20 00:20:32 +02007387exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007388 mbedtls_platform_zeroize(shared_secret, shared_secret_length);
7389 return status;
Gilles Peskine12313cd2018-06-20 00:20:32 +02007390}
7391
Gilles Peskine449bd832023-01-11 14:50:10 +01007392psa_status_t psa_key_derivation_key_agreement(psa_key_derivation_operation_t *operation,
7393 psa_key_derivation_step_t step,
7394 mbedtls_svc_key_id_t private_key,
7395 const uint8_t *peer_key,
7396 size_t peer_key_length)
Gilles Peskine12313cd2018-06-20 00:20:32 +02007397{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007398 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007399 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskine2f060a82018-12-04 17:12:32 +01007400 psa_key_slot_t *slot;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007401
Gilles Peskine449bd832023-01-11 14:50:10 +01007402 if (!PSA_ALG_IS_KEY_AGREEMENT(operation->alg)) {
7403 return PSA_ERROR_INVALID_ARGUMENT;
7404 }
Ronald Cron5c522922020-11-14 16:35:34 +01007405 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007406 private_key, &slot, PSA_KEY_USAGE_DERIVE, operation->alg);
7407 if (status != PSA_SUCCESS) {
7408 return status;
7409 }
7410 status = psa_key_agreement_internal(operation, step,
7411 slot,
7412 peer_key, peer_key_length);
7413 if (status != PSA_SUCCESS) {
7414 psa_key_derivation_abort(operation);
7415 } else {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007416 /* If a private key has been added as SECRET, we allow the derived
7417 * key material to be used as a key in PSA Crypto. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007418 if (step == PSA_KEY_DERIVATION_INPUT_SECRET) {
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007419 operation->can_output_key = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +01007420 }
Steven Cooremanfa5e6312020-10-15 17:07:12 +02007421 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007422
Gilles Peskine449bd832023-01-11 14:50:10 +01007423 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007424
Gilles Peskine449bd832023-01-11 14:50:10 +01007425 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskineaf3baab2018-06-27 22:55:52 +02007426}
7427
Gilles Peskine449bd832023-01-11 14:50:10 +01007428psa_status_t psa_raw_key_agreement(psa_algorithm_t alg,
7429 mbedtls_svc_key_id_t private_key,
7430 const uint8_t *peer_key,
7431 size_t peer_key_length,
7432 uint8_t *output,
7433 size_t output_size,
7434 size_t *output_length)
Gilles Peskine0216fe12019-04-11 21:23:21 +02007435{
Ronald Cronf95a2b12020-10-22 15:24:49 +02007436 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron5c522922020-11-14 16:35:34 +01007437 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cronf95a2b12020-10-22 15:24:49 +02007438 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007439 size_t expected_length;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007440
Gilles Peskine449bd832023-01-11 14:50:10 +01007441 if (!PSA_ALG_IS_KEY_AGREEMENT(alg)) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007442 status = PSA_ERROR_INVALID_ARGUMENT;
7443 goto exit;
7444 }
Ronald Cron5c522922020-11-14 16:35:34 +01007445 status = psa_get_and_lock_transparent_key_slot_with_policy(
Gilles Peskine449bd832023-01-11 14:50:10 +01007446 private_key, &slot, PSA_KEY_USAGE_DERIVE, alg);
7447 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007448 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007449 }
Gilles Peskine0216fe12019-04-11 21:23:21 +02007450
Gilles Peskine3e561302022-04-14 00:17:15 +02007451 /* PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is in general an upper bound
7452 * for the output size. The PSA specification only guarantees that this
7453 * function works if output_size >= PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(...),
7454 * but it might be nice to allow smaller buffers if the output fits.
7455 * At the time of writing this comment, with only ECDH implemented,
7456 * PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() is exact so the point is moot.
7457 * If FFDH is implemented, PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE() can easily
7458 * be exact for it as well. */
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01007459 expected_length =
Gilles Peskine449bd832023-01-11 14:50:10 +01007460 PSA_RAW_KEY_AGREEMENT_OUTPUT_SIZE(slot->attr.type, slot->attr.bits);
7461 if (output_size < expected_length) {
Gilles Peskine3e561302022-04-14 00:17:15 +02007462 status = PSA_ERROR_BUFFER_TOO_SMALL;
7463 goto exit;
7464 }
7465
Gilles Peskine449bd832023-01-11 14:50:10 +01007466 status = psa_key_agreement_raw_internal(alg, slot,
7467 peer_key, peer_key_length,
7468 output, output_size,
7469 output_length);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007470
7471exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007472 if (status != PSA_SUCCESS) {
Gilles Peskine0216fe12019-04-11 21:23:21 +02007473 /* If an error happens and is not handled properly, the output
7474 * may be used as a key to protect sensitive data. Arrange for such
7475 * a key to be random, which is likely to result in decryption or
7476 * verification errors. This is better than filling the buffer with
7477 * some constant data such as zeros, which would result in the data
7478 * being protected with a reproducible, easily knowable key.
7479 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007480 psa_generate_random(output, output_size);
Gilles Peskine0216fe12019-04-11 21:23:21 +02007481 *output_length = output_size;
7482 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007483
Gilles Peskine449bd832023-01-11 14:50:10 +01007484 unlock_status = psa_unlock_key_slot(slot);
Ronald Cronf95a2b12020-10-22 15:24:49 +02007485
Gilles Peskine449bd832023-01-11 14:50:10 +01007486 return (status == PSA_SUCCESS) ? unlock_status : status;
Gilles Peskine0216fe12019-04-11 21:23:21 +02007487}
Gilles Peskine86a440b2018-11-12 18:39:40 +01007488
7489
Gilles Peskine30524eb2020-11-13 17:02:26 +01007490
Gilles Peskine86a440b2018-11-12 18:39:40 +01007491/****************************************************************/
7492/* Random generation */
Gilles Peskine53d991e2018-07-12 01:14:59 +02007493/****************************************************************/
Gilles Peskine12313cd2018-06-20 00:20:32 +02007494
Gilles Peskine672a7712023-04-28 21:00:28 +02007495#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
7496#include "entropy_poll.h"
7497#endif
7498
Gilles Peskine30524eb2020-11-13 17:02:26 +01007499/** Initialize the PSA random generator.
7500 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007501static void mbedtls_psa_random_init(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007502{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007503#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007504 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007505#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7506
Gilles Peskine30524eb2020-11-13 17:02:26 +01007507 /* Set default configuration if
7508 * mbedtls_psa_crypto_configure_entropy_sources() hasn't been called. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007509 if (rng->entropy_init == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007510 rng->entropy_init = mbedtls_entropy_init;
Gilles Peskine449bd832023-01-11 14:50:10 +01007511 }
7512 if (rng->entropy_free == NULL) {
Gilles Peskine30524eb2020-11-13 17:02:26 +01007513 rng->entropy_free = mbedtls_entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007514 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007515
Gilles Peskine449bd832023-01-11 14:50:10 +01007516 rng->entropy_init(&rng->entropy);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007517#if defined(MBEDTLS_PSA_INJECT_ENTROPY) && \
7518 defined(MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES)
7519 /* The PSA entropy injection feature depends on using NV seed as an entropy
7520 * source. Add NV seed as an entropy source for PSA entropy injection. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007521 mbedtls_entropy_add_source(&rng->entropy,
7522 mbedtls_nv_seed_poll, NULL,
7523 MBEDTLS_ENTROPY_BLOCK_SIZE,
7524 MBEDTLS_ENTROPY_SOURCE_STRONG);
Gilles Peskine30524eb2020-11-13 17:02:26 +01007525#endif
7526
Gilles Peskine449bd832023-01-11 14:50:10 +01007527 mbedtls_psa_drbg_init(MBEDTLS_PSA_RANDOM_STATE);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007528#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007529}
7530
7531/** Deinitialize the PSA random generator.
7532 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007533static void mbedtls_psa_random_free(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007534{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007535#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine449bd832023-01-11 14:50:10 +01007536 memset(rng, 0, sizeof(*rng));
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007537#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine449bd832023-01-11 14:50:10 +01007538 mbedtls_psa_drbg_free(MBEDTLS_PSA_RANDOM_STATE);
7539 rng->entropy_free(&rng->entropy);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007540#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007541}
7542
7543/** Seed the PSA random generator.
7544 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007545static psa_status_t mbedtls_psa_random_seed(mbedtls_psa_random_context_t *rng)
Gilles Peskine30524eb2020-11-13 17:02:26 +01007546{
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007547#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7548 /* Do nothing: the external RNG seeds itself. */
7549 (void) rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007550 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007551#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007552 const unsigned char drbg_seed[] = "PSA";
Gilles Peskine449bd832023-01-11 14:50:10 +01007553 int ret = mbedtls_psa_drbg_seed(&rng->entropy,
7554 drbg_seed, sizeof(drbg_seed) - 1);
7555 return mbedtls_to_psa_error(ret);
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007556#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskine30524eb2020-11-13 17:02:26 +01007557}
7558
Gilles Peskine449bd832023-01-11 14:50:10 +01007559psa_status_t psa_generate_random(uint8_t *output,
7560 size_t output_size)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007561{
Gilles Peskinee59236f2018-01-27 23:32:46 +01007562 GUARD_MODULE_INITIALIZED;
7563
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007564#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7565
7566 size_t output_length = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01007567 psa_status_t status = mbedtls_psa_external_get_random(&global_data.rng,
7568 output, output_size,
7569 &output_length);
7570 if (status != PSA_SUCCESS) {
7571 return status;
7572 }
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007573 /* Breaking up a request into smaller chunks is currently not supported
Tom Cosgrove1797b052022-12-04 17:19:59 +00007574 * for the external RNG interface. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007575 if (output_length != output_size) {
7576 return PSA_ERROR_INSUFFICIENT_ENTROPY;
7577 }
7578 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007579
7580#else /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7581
Gilles Peskine449bd832023-01-11 14:50:10 +01007582 while (output_size > 0) {
Gilles Peskine71ddab92021-01-04 21:01:07 +01007583 size_t request_size =
Gilles Peskine449bd832023-01-11 14:50:10 +01007584 (output_size > MBEDTLS_PSA_RANDOM_MAX_REQUEST ?
7585 MBEDTLS_PSA_RANDOM_MAX_REQUEST :
7586 output_size);
7587 int ret = mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE,
7588 output, request_size);
7589 if (ret != 0) {
7590 return mbedtls_to_psa_error(ret);
7591 }
Gilles Peskine71ddab92021-01-04 21:01:07 +01007592 output_size -= request_size;
7593 output += request_size;
Gilles Peskinef181eca2019-08-07 13:49:00 +02007594 }
Gilles Peskine449bd832023-01-11 14:50:10 +01007595 return PSA_SUCCESS;
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007596#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007597}
7598
Gilles Peskine8814fc42020-12-14 15:33:44 +01007599/* Wrapper function allowing the classic API to use the PSA RNG.
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007600 *
7601 * `mbedtls_psa_get_random(MBEDTLS_PSA_RANDOM_STATE, ...)` calls
7602 * `psa_generate_random(...)`. The state parameter is ignored since the
7603 * PSA API doesn't support passing an explicit state.
7604 *
7605 * In the non-external case, psa_generate_random() calls an
7606 * `mbedtls_xxx_drbg_random` function which has exactly the same signature
7607 * and semantics as mbedtls_psa_get_random(). As an optimization,
7608 * instead of doing this back-and-forth between the PSA API and the
7609 * classic API, psa_crypto_random_impl.h defines `mbedtls_psa_get_random`
7610 * as a constant function pointer to `mbedtls_xxx_drbg_random`.
Gilles Peskine8814fc42020-12-14 15:33:44 +01007611 */
Gilles Peskine449bd832023-01-11 14:50:10 +01007612#if defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
7613int mbedtls_psa_get_random(void *p_rng,
7614 unsigned char *output,
7615 size_t output_size)
Gilles Peskine8814fc42020-12-14 15:33:44 +01007616{
Gilles Peskine9c3e0602021-01-05 16:03:55 +01007617 /* This function takes a pointer to the RNG state because that's what
7618 * classic mbedtls functions using an RNG expect. The PSA RNG manages
7619 * its own state internally and doesn't let the caller access that state.
7620 * So we just ignore the state parameter, and in practice we'll pass
7621 * NULL. */
Gilles Peskine8814fc42020-12-14 15:33:44 +01007622 (void) p_rng;
Gilles Peskine449bd832023-01-11 14:50:10 +01007623 psa_status_t status = psa_generate_random(output, output_size);
7624 if (status == PSA_SUCCESS) {
7625 return 0;
7626 } else {
7627 return MBEDTLS_ERR_ENTROPY_SOURCE_FAILED;
7628 }
Gilles Peskine8814fc42020-12-14 15:33:44 +01007629}
7630#endif /* MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG */
7631
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007632#if defined(MBEDTLS_PSA_INJECT_ENTROPY)
Gilles Peskine449bd832023-01-11 14:50:10 +01007633psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed,
7634 size_t seed_size)
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007635{
Gilles Peskine449bd832023-01-11 14:50:10 +01007636 if (global_data.initialized) {
7637 return PSA_ERROR_NOT_PERMITTED;
7638 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007639
Gilles Peskine449bd832023-01-11 14:50:10 +01007640 if (((seed_size < MBEDTLS_ENTROPY_MIN_PLATFORM) ||
7641 (seed_size < MBEDTLS_ENTROPY_BLOCK_SIZE)) ||
7642 (seed_size > MBEDTLS_ENTROPY_MAX_SEED_SIZE)) {
7643 return PSA_ERROR_INVALID_ARGUMENT;
7644 }
Netanel Gonen21f37cb2018-11-19 11:53:55 +02007645
Gilles Peskine449bd832023-01-11 14:50:10 +01007646 return mbedtls_psa_storage_inject_entropy(seed, seed_size);
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007647}
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01007648#endif /* MBEDTLS_PSA_INJECT_ENTROPY */
Netanel Gonen2bcd3122018-11-19 11:53:02 +02007649
Ronald Cron3772afe2021-02-08 16:10:05 +01007650/** Validate the key type and size for key generation
Ronald Cron01b2aba2020-10-05 09:42:02 +02007651 *
Ronald Cron3772afe2021-02-08 16:10:05 +01007652 * \param type The key type
7653 * \param bits The number of bits of the key
Ronald Cron01b2aba2020-10-05 09:42:02 +02007654 *
7655 * \retval #PSA_SUCCESS
Ronald Cron3772afe2021-02-08 16:10:05 +01007656 * The key type and size are valid.
Ronald Cron01b2aba2020-10-05 09:42:02 +02007657 * \retval #PSA_ERROR_INVALID_ARGUMENT
7658 * The size in bits of the key is not valid.
7659 * \retval #PSA_ERROR_NOT_SUPPORTED
7660 * The type and/or the size in bits of the key or the combination of
7661 * the two is not supported.
7662 */
Ronald Cron3772afe2021-02-08 16:10:05 +01007663static psa_status_t psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007664 psa_key_type_t type, size_t bits)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007665{
Ronald Cronf3bb7612020-10-02 20:11:59 +02007666 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007667
Gilles Peskine449bd832023-01-11 14:50:10 +01007668 if (key_type_is_raw_bytes(type)) {
7669 status = psa_validate_unstructured_key_bit_size(type, bits);
7670 if (status != PSA_SUCCESS) {
7671 return status;
7672 }
7673 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007674#if defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007675 if (PSA_KEY_TYPE_IS_RSA(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7676 if (bits > PSA_VENDOR_RSA_MAX_KEY_BITS) {
7677 return PSA_ERROR_NOT_SUPPORTED;
7678 }
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00007679 if (bits < PSA_VENDOR_RSA_GENERATE_MIN_KEY_BITS) {
Waleed Elmelegyab570712023-07-05 16:40:58 +00007680 return PSA_ERROR_NOT_SUPPORTED;
7681 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007682
Ronald Cron01b2aba2020-10-05 09:42:02 +02007683 /* Accept only byte-aligned keys, for the same reasons as
7684 * in psa_import_rsa_key(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01007685 if (bits % 8 != 0) {
7686 return PSA_ERROR_NOT_SUPPORTED;
7687 }
7688 } else
Valerio Settif6d4dfb2023-07-10 10:55:12 +02007689#endif /* defined(PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007690
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007691#if defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007692 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Ronald Crond81ab562021-02-16 09:01:16 +01007693 /* To avoid empty block, return successfully here. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007694 return PSA_SUCCESS;
7695 } else
Valerio Setti6a9d0ee2023-06-21 10:07:21 +02007696#endif /* defined(PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007697
Valerio Settia55f0422023-07-10 15:34:41 +02007698#if defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007699 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
Przemek Stekield1cf1ba2023-04-27 12:04:21 +02007700 if (psa_is_dh_key_size_valid(bits) == 0) {
Przemek Stekielfedd1342022-12-01 15:00:02 +01007701 return PSA_ERROR_NOT_SUPPORTED;
7702 }
7703 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007704#endif /* defined(PSA_WANT_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Ronald Cron01b2aba2020-10-05 09:42:02 +02007705 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007706 return PSA_ERROR_NOT_SUPPORTED;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007707 }
7708
Gilles Peskine449bd832023-01-11 14:50:10 +01007709 return PSA_SUCCESS;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007710}
7711
Ronald Cron55ed0592020-10-05 10:30:40 +02007712psa_status_t psa_generate_key_internal(
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007713 const psa_key_attributes_t *attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +01007714 uint8_t *key_buffer, size_t key_buffer_size, size_t *key_buffer_length)
Ronald Cron01b2aba2020-10-05 09:42:02 +02007715{
7716 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Ronald Cron2a38a6b2020-10-02 20:02:04 +02007717 psa_key_type_t type = attributes->core.type;
Ronald Cron01b2aba2020-10-05 09:42:02 +02007718
Gilles Peskine449bd832023-01-11 14:50:10 +01007719 if ((attributes->domain_parameters == NULL) &&
7720 (attributes->domain_parameters_size != 0)) {
7721 return PSA_ERROR_INVALID_ARGUMENT;
7722 }
Ronald Cron01b2aba2020-10-05 09:42:02 +02007723
Gilles Peskine449bd832023-01-11 14:50:10 +01007724 if (key_type_is_raw_bytes(type)) {
7725 status = psa_generate_random(key_buffer, key_buffer_size);
7726 if (status != PSA_SUCCESS) {
7727 return status;
7728 }
Steven Cooreman81be2fa2020-07-24 22:04:59 +02007729
David Brown12ca5032021-02-11 11:02:00 -07007730#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES)
Gilles Peskine449bd832023-01-11 14:50:10 +01007731 if (type == PSA_KEY_TYPE_DES) {
7732 psa_des_set_key_parity(key_buffer, key_buffer_size);
7733 }
David Brown8107e312021-02-12 08:08:46 -07007734#endif /* MBEDTLS_PSA_BUILTIN_KEY_TYPE_DES */
Gilles Peskine449bd832023-01-11 14:50:10 +01007735 } else
Gilles Peskinee59236f2018-01-27 23:32:46 +01007736
Valerio Setti76df8c12023-07-11 14:11:28 +02007737#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007738 if (type == PSA_KEY_TYPE_RSA_KEY_PAIR) {
7739 return mbedtls_psa_rsa_generate_key(attributes,
7740 key_buffer,
7741 key_buffer_size,
7742 key_buffer_length);
7743 } else
Valerio Setti76df8c12023-07-11 14:11:28 +02007744#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_RSA_KEY_PAIR_GENERATE) */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007745
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007746#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE)
Gilles Peskine449bd832023-01-11 14:50:10 +01007747 if (PSA_KEY_TYPE_IS_ECC(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7748 return mbedtls_psa_ecp_generate_key(attributes,
7749 key_buffer,
7750 key_buffer_size,
7751 key_buffer_length);
7752 } else
Valerio Settibfeaf5b2023-06-20 13:27:46 +02007753#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_ECC_KEY_PAIR_GENERATE) */
Przemek Stekielfedd1342022-12-01 15:00:02 +01007754
Valerio Settia55f0422023-07-10 15:34:41 +02007755#if defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE)
Przemek Stekielfedd1342022-12-01 15:00:02 +01007756 if (PSA_KEY_TYPE_IS_DH(type) && PSA_KEY_TYPE_IS_KEY_PAIR(type)) {
7757 return mbedtls_psa_ffdh_generate_key(attributes,
7758 key_buffer,
7759 key_buffer_size,
7760 key_buffer_length);
7761 } else
Valerio Settia55f0422023-07-10 15:34:41 +02007762#endif /* defined(MBEDTLS_PSA_BUILTIN_KEY_TYPE_DH_KEY_PAIR_GENERATE) */
Steven Cooreman29149862020-08-05 15:43:42 +02007763 {
Gilles Peskine449bd832023-01-11 14:50:10 +01007764 (void) key_buffer_length;
7765 return PSA_ERROR_NOT_SUPPORTED;
Steven Cooreman29149862020-08-05 15:43:42 +02007766 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007767
Gilles Peskine449bd832023-01-11 14:50:10 +01007768 return PSA_SUCCESS;
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007769}
Darryl Green0c6575a2018-11-07 16:05:30 +00007770
Gilles Peskine449bd832023-01-11 14:50:10 +01007771psa_status_t psa_generate_key(const psa_key_attributes_t *attributes,
7772 mbedtls_svc_key_id_t *key)
Gilles Peskineff5f0e72019-04-18 12:53:30 +02007773{
7774 psa_status_t status;
7775 psa_key_slot_t *slot = NULL;
Gilles Peskine8abe6a22019-07-12 23:40:35 +02007776 psa_se_drv_table_entry_t *driver = NULL;
Ronald Cron2b56bc82020-10-05 10:02:26 +02007777 size_t key_buffer_size;
Gilles Peskine11792082019-08-06 18:36:36 +02007778
Ronald Cron81709fc2020-11-14 12:10:32 +01007779 *key = MBEDTLS_SVC_KEY_ID_INIT;
7780
Gilles Peskine0f84d622019-09-12 19:03:13 +02007781 /* Reject any attempt to create a zero-length key so that we don't
7782 * risk tripping up later, e.g. on a malloc(0) that returns NULL. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007783 if (psa_get_key_bits(attributes) == 0) {
7784 return PSA_ERROR_INVALID_ARGUMENT;
7785 }
Gilles Peskine0f84d622019-09-12 19:03:13 +02007786
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007787 /* Reject any attempt to create a public key. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007788 if (PSA_KEY_TYPE_IS_PUBLIC_KEY(attributes->core.type)) {
7789 return PSA_ERROR_INVALID_ARGUMENT;
7790 }
Przemyslaw Stekielc0fe8202021-10-07 11:08:56 +02007791
Gilles Peskine449bd832023-01-11 14:50:10 +01007792 status = psa_start_key_creation(PSA_KEY_CREATION_GENERATE, attributes,
7793 &slot, &driver);
7794 if (status != PSA_SUCCESS) {
Gilles Peskine11792082019-08-06 18:36:36 +02007795 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007796 }
Gilles Peskine11792082019-08-06 18:36:36 +02007797
Ronald Cron977c2472020-10-13 08:32:21 +02007798 /* In the case of a transparent key or an opaque key stored in local
Archana449608b2021-09-08 15:36:05 +05307799 * storage ( thus not in the case of generating a key in a secure element
7800 * with storage ( MBEDTLS_PSA_CRYPTO_SE_C ) ),we have to allocate a
7801 * buffer to hold the generated key material. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007802 if (slot->key.data == NULL) {
7803 if (PSA_KEY_LIFETIME_GET_LOCATION(attributes->core.lifetime) ==
7804 PSA_KEY_LOCATION_LOCAL_STORAGE) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007805 status = psa_validate_key_type_and_size_for_key_generation(
Gilles Peskine449bd832023-01-11 14:50:10 +01007806 attributes->core.type, attributes->core.bits);
7807 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007808 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007809 }
Ronald Cron3772afe2021-02-08 16:10:05 +01007810
7811 key_buffer_size = PSA_EXPORT_KEY_OUTPUT_SIZE(
Gilles Peskine449bd832023-01-11 14:50:10 +01007812 attributes->core.type,
7813 attributes->core.bits);
7814 } else {
Ronald Cron977c2472020-10-13 08:32:21 +02007815 status = psa_driver_wrapper_get_key_buffer_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01007816 attributes, &key_buffer_size);
7817 if (status != PSA_SUCCESS) {
Ronald Cron3772afe2021-02-08 16:10:05 +01007818 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007819 }
Ronald Cron977c2472020-10-13 08:32:21 +02007820 }
Ronald Cron977c2472020-10-13 08:32:21 +02007821
Gilles Peskine449bd832023-01-11 14:50:10 +01007822 status = psa_allocate_buffer_to_slot(slot, key_buffer_size);
7823 if (status != PSA_SUCCESS) {
Ronald Cron977c2472020-10-13 08:32:21 +02007824 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007825 }
Ronald Cron977c2472020-10-13 08:32:21 +02007826 }
7827
Gilles Peskine449bd832023-01-11 14:50:10 +01007828 status = psa_driver_wrapper_generate_key(attributes,
7829 slot->key.data, slot->key.bytes, &slot->key.bytes);
Gilles Peskine11792082019-08-06 18:36:36 +02007830
Gilles Peskine449bd832023-01-11 14:50:10 +01007831 if (status != PSA_SUCCESS) {
7832 psa_remove_key_data_from_memory(slot);
7833 }
Ronald Cron2b56bc82020-10-05 10:02:26 +02007834
Gilles Peskine11792082019-08-06 18:36:36 +02007835exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007836 if (status == PSA_SUCCESS) {
7837 status = psa_finish_key_creation(slot, driver, key);
7838 }
7839 if (status != PSA_SUCCESS) {
7840 psa_fail_key_creation(slot, driver);
7841 }
Ronald Cronf95a2b12020-10-22 15:24:49 +02007842
Gilles Peskine449bd832023-01-11 14:50:10 +01007843 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007844}
7845
Gilles Peskinee59236f2018-01-27 23:32:46 +01007846/****************************************************************/
7847/* Module setup */
7848/****************************************************************/
7849
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007850#if !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG)
Gilles Peskine5e769522018-11-20 21:59:56 +01007851psa_status_t mbedtls_psa_crypto_configure_entropy_sources(
Gilles Peskine449bd832023-01-11 14:50:10 +01007852 void (* entropy_init)(mbedtls_entropy_context *ctx),
7853 void (* entropy_free)(mbedtls_entropy_context *ctx))
Gilles Peskine5e769522018-11-20 21:59:56 +01007854{
Gilles Peskine449bd832023-01-11 14:50:10 +01007855 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7856 return PSA_ERROR_BAD_STATE;
7857 }
Gilles Peskine30524eb2020-11-13 17:02:26 +01007858 global_data.rng.entropy_init = entropy_init;
7859 global_data.rng.entropy_free = entropy_free;
Gilles Peskine449bd832023-01-11 14:50:10 +01007860 return PSA_SUCCESS;
Gilles Peskine5e769522018-11-20 21:59:56 +01007861}
Gilles Peskine4fc21fd2020-11-13 18:47:18 +01007862#endif /* !defined(MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG) */
Gilles Peskine5e769522018-11-20 21:59:56 +01007863
Gilles Peskine449bd832023-01-11 14:50:10 +01007864void mbedtls_psa_crypto_free(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007865{
Gilles Peskine449bd832023-01-11 14:50:10 +01007866 psa_wipe_all_key_slots();
7867 if (global_data.rng_state != RNG_NOT_INITIALIZED) {
7868 mbedtls_psa_random_free(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007869 }
7870 /* Wipe all remaining data, including configuration.
7871 * In particular, this sets all state indicator to the value
7872 * indicating "uninitialized". */
Gilles Peskine449bd832023-01-11 14:50:10 +01007873 mbedtls_platform_zeroize(&global_data, sizeof(global_data));
Ronald Cron9ba76912021-04-10 16:57:30 +02007874
7875 /* Terminate drivers */
Gilles Peskine449bd832023-01-11 14:50:10 +01007876 psa_driver_wrapper_free();
Gilles Peskinee59236f2018-01-27 23:32:46 +01007877}
7878
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007879#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
7880/** Recover a transaction that was interrupted by a power failure.
7881 *
7882 * This function is called during initialization, before psa_crypto_init()
7883 * returns. If this function returns a failure status, the initialization
7884 * fails.
7885 */
7886static psa_status_t psa_crypto_recover_transaction(
Gilles Peskine449bd832023-01-11 14:50:10 +01007887 const psa_crypto_transaction_t *transaction)
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007888{
Gilles Peskine449bd832023-01-11 14:50:10 +01007889 switch (transaction->unknown.type) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007890 case PSA_CRYPTO_TRANSACTION_CREATE_KEY:
7891 case PSA_CRYPTO_TRANSACTION_DESTROY_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01007892 /* TODO - fall through to the failure case until this
7893 * is implemented.
7894 * https://github.com/ARMmbed/mbed-crypto/issues/218
7895 */
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007896 default:
7897 /* We found an unsupported transaction in the storage.
7898 * We don't know what state the storage is in. Give up. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007899 return PSA_ERROR_DATA_INVALID;
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007900 }
7901}
7902#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
7903
Gilles Peskine449bd832023-01-11 14:50:10 +01007904psa_status_t psa_crypto_init(void)
Gilles Peskinee59236f2018-01-27 23:32:46 +01007905{
Gilles Peskine66fb1262018-12-10 16:29:04 +01007906 psa_status_t status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007907
Gilles Peskinec6b69072018-11-20 21:42:52 +01007908 /* Double initialization is explicitly allowed. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007909 if (global_data.initialized != 0) {
7910 return PSA_SUCCESS;
7911 }
Gilles Peskinee59236f2018-01-27 23:32:46 +01007912
Manuel Pégourié-Gonnard7abdf7e2023-03-09 11:17:43 +01007913 /* Init drivers */
7914 status = psa_driver_wrapper_init();
7915 if (status != PSA_SUCCESS) {
7916 goto exit;
7917 }
7918 global_data.drivers_initialized = 1;
7919
Gilles Peskine30524eb2020-11-13 17:02:26 +01007920 /* Initialize and seed the random generator. */
Gilles Peskine449bd832023-01-11 14:50:10 +01007921 mbedtls_psa_random_init(&global_data.rng);
Gilles Peskinec6b69072018-11-20 21:42:52 +01007922 global_data.rng_state = RNG_INITIALIZED;
Gilles Peskine449bd832023-01-11 14:50:10 +01007923 status = mbedtls_psa_random_seed(&global_data.rng);
7924 if (status != PSA_SUCCESS) {
Gilles Peskinee59236f2018-01-27 23:32:46 +01007925 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007926 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007927 global_data.rng_state = RNG_SEEDED;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007928
Gilles Peskine449bd832023-01-11 14:50:10 +01007929 status = psa_initialize_key_slots();
7930 if (status != PSA_SUCCESS) {
Gilles Peskine66fb1262018-12-10 16:29:04 +01007931 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007932 }
Gilles Peskinec6b69072018-11-20 21:42:52 +01007933
Gilles Peskine4b734222019-07-24 15:56:31 +02007934#if defined(PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS)
Gilles Peskine449bd832023-01-11 14:50:10 +01007935 status = psa_crypto_load_transaction();
7936 if (status == PSA_SUCCESS) {
7937 status = psa_crypto_recover_transaction(&psa_crypto_transaction);
7938 if (status != PSA_SUCCESS) {
Gilles Peskinef9bb29e2019-07-25 17:52:59 +02007939 goto exit;
Gilles Peskine449bd832023-01-11 14:50:10 +01007940 }
7941 status = psa_crypto_stop_transaction();
7942 } else if (status == PSA_ERROR_DOES_NOT_EXIST) {
Gilles Peskinefc762652019-07-22 19:30:34 +02007943 /* There's no transaction to complete. It's all good. */
7944 status = PSA_SUCCESS;
7945 }
Gilles Peskine4b734222019-07-24 15:56:31 +02007946#endif /* PSA_CRYPTO_STORAGE_HAS_TRANSACTIONS */
Gilles Peskinefc762652019-07-22 19:30:34 +02007947
Gilles Peskinec6b69072018-11-20 21:42:52 +01007948 /* All done. */
Gilles Peskinee59236f2018-01-27 23:32:46 +01007949 global_data.initialized = 1;
7950
7951exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01007952 if (status != PSA_SUCCESS) {
7953 mbedtls_psa_crypto_free();
7954 }
7955 return status;
Gilles Peskinee59236f2018-01-27 23:32:46 +01007956}
7957
Yanray Wangffc3c482023-07-11 12:01:04 +08007958#if defined(PSA_WANT_ALG_SOME_PAKE)
Przemek Stekielca8d2b22023-01-17 16:21:33 +01007959psa_status_t psa_crypto_driver_pake_get_password_len(
7960 const psa_crypto_driver_pake_inputs_t *inputs,
7961 size_t *password_len)
7962{
7963 if (inputs->password_len == 0) {
7964 return PSA_ERROR_BAD_STATE;
7965 }
7966
7967 *password_len = inputs->password_len;
7968
7969 return PSA_SUCCESS;
7970}
7971
7972psa_status_t psa_crypto_driver_pake_get_password(
7973 const psa_crypto_driver_pake_inputs_t *inputs,
7974 uint8_t *buffer, size_t buffer_size, size_t *buffer_length)
7975{
7976 if (inputs->password_len == 0) {
7977 return PSA_ERROR_BAD_STATE;
7978 }
7979
7980 if (buffer_size < inputs->password_len) {
7981 return PSA_ERROR_BUFFER_TOO_SMALL;
7982 }
7983
7984 memcpy(buffer, inputs->password, inputs->password_len);
7985 *buffer_length = inputs->password_len;
7986
7987 return PSA_SUCCESS;
7988}
7989
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01007990psa_status_t psa_crypto_driver_pake_get_user_len(
7991 const psa_crypto_driver_pake_inputs_t *inputs,
7992 size_t *user_len)
7993{
7994 if (inputs->user_len == 0) {
7995 return PSA_ERROR_BAD_STATE;
7996 }
7997
7998 *user_len = inputs->user_len;
7999
8000 return PSA_SUCCESS;
8001}
8002
8003psa_status_t psa_crypto_driver_pake_get_user(
8004 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008005 uint8_t *user_id, size_t user_id_size, size_t *user_id_len)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008006{
8007 if (inputs->user_len == 0) {
8008 return PSA_ERROR_BAD_STATE;
8009 }
8010
Przemek Stekielc0e62502023-03-14 11:49:36 +01008011 if (user_id_size < inputs->user_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008012 return PSA_ERROR_BUFFER_TOO_SMALL;
8013 }
8014
Przemek Stekielc0e62502023-03-14 11:49:36 +01008015 memcpy(user_id, inputs->user, inputs->user_len);
8016 *user_id_len = inputs->user_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008017
8018 return PSA_SUCCESS;
8019}
8020
8021psa_status_t psa_crypto_driver_pake_get_peer_len(
8022 const psa_crypto_driver_pake_inputs_t *inputs,
8023 size_t *peer_len)
8024{
8025 if (inputs->peer_len == 0) {
8026 return PSA_ERROR_BAD_STATE;
8027 }
8028
8029 *peer_len = inputs->peer_len;
8030
8031 return PSA_SUCCESS;
8032}
8033
8034psa_status_t psa_crypto_driver_pake_get_peer(
8035 const psa_crypto_driver_pake_inputs_t *inputs,
Przemek Stekielc0e62502023-03-14 11:49:36 +01008036 uint8_t *peer_id, size_t peer_id_size, size_t *peer_id_length)
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008037{
8038 if (inputs->peer_len == 0) {
8039 return PSA_ERROR_BAD_STATE;
8040 }
8041
Przemek Stekielc0e62502023-03-14 11:49:36 +01008042 if (peer_id_size < inputs->peer_len) {
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008043 return PSA_ERROR_BUFFER_TOO_SMALL;
8044 }
8045
Przemek Stekielc0e62502023-03-14 11:49:36 +01008046 memcpy(peer_id, inputs->peer, inputs->peer_len);
8047 *peer_id_length = inputs->peer_len;
Przemek Stekiel1e7a9272023-02-28 14:38:58 +01008048
8049 return PSA_SUCCESS;
8050}
8051
Przemek Stekielca8d2b22023-01-17 16:21:33 +01008052psa_status_t psa_crypto_driver_pake_get_cipher_suite(
8053 const psa_crypto_driver_pake_inputs_t *inputs,
8054 psa_pake_cipher_suite_t *cipher_suite)
8055{
8056 if (inputs->cipher_suite.algorithm == PSA_ALG_NONE) {
8057 return PSA_ERROR_BAD_STATE;
8058 }
8059
8060 *cipher_suite = inputs->cipher_suite;
8061
8062 return PSA_SUCCESS;
8063}
8064
Neil Armstronga7d08c32022-06-01 18:21:20 +02008065psa_status_t psa_pake_setup(
8066 psa_pake_operation_t *operation,
8067 const psa_pake_cipher_suite_t *cipher_suite)
8068{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008069 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008070
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008071 if (operation->stage != PSA_PAKE_OPERATION_STAGE_SETUP) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008072 status = PSA_ERROR_BAD_STATE;
8073 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008074 }
8075
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008076 if (PSA_ALG_IS_PAKE(cipher_suite->algorithm) == 0 ||
Przemek Stekiel51eac532022-12-07 11:04:51 +01008077 PSA_ALG_IS_HASH(cipher_suite->hash) == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008078 status = PSA_ERROR_INVALID_ARGUMENT;
8079 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008080 }
8081
Przemek Stekiel51eac532022-12-07 11:04:51 +01008082 memset(&operation->data.inputs, 0, sizeof(operation->data.inputs));
8083
Przemek Stekiele12ed362022-12-21 12:54:46 +01008084 operation->alg = cipher_suite->algorithm;
Przemek Stekiel656b2592023-03-22 13:15:33 +01008085 operation->primitive = PSA_PAKE_PRIMITIVE(cipher_suite->type,
8086 cipher_suite->family, cipher_suite->bits);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008087 operation->data.inputs.cipher_suite = *cipher_suite;
8088
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008089#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008090 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008091 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekieldde6a912023-01-26 08:46:37 +01008092 &operation->computation_stage.jpake;
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008093
David Horstmann16f01512023-06-14 17:21:07 +01008094 memset(computation_stage, 0, sizeof(*computation_stage));
David Horstmanne7f21e62023-05-12 18:17:21 +01008095 computation_stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008096 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008097#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008098 {
8099 status = PSA_ERROR_NOT_SUPPORTED;
8100 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008101 }
8102
Przemek Stekiel1c3cfb42023-01-26 10:35:02 +01008103 operation->stage = PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS;
8104
Przemek Stekiel51eac532022-12-07 11:04:51 +01008105 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008106exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008107 psa_pake_abort(operation);
8108 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008109}
8110
8111psa_status_t psa_pake_set_password_key(
8112 psa_pake_operation_t *operation,
8113 mbedtls_svc_key_id_t password)
8114{
Neil Armstrong5ae60962022-09-15 11:29:46 +02008115 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel6c764412022-11-22 14:05:12 +01008116 psa_status_t unlock_status = PSA_ERROR_CORRUPTION_DETECTED;
8117 psa_key_slot_t *slot = NULL;
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008118 psa_key_attributes_t attributes;
8119 psa_key_type_t type;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008120
Przemek Stekiel51eac532022-12-07 11:04:51 +01008121 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008122 status = PSA_ERROR_BAD_STATE;
8123 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008124 }
8125
Przemek Stekiel6c764412022-11-22 14:05:12 +01008126 status = psa_get_and_lock_key_slot_with_policy(password, &slot,
8127 PSA_KEY_USAGE_DERIVE,
Przemek Stekield5d28a22023-01-26 10:46:05 +01008128 operation->alg);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008129 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008130 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008131 }
8132
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008133 attributes = (psa_key_attributes_t) {
Przemek Stekiel6c764412022-11-22 14:05:12 +01008134 .core = slot->attr
8135 };
Neil Armstrong5ae60962022-09-15 11:29:46 +02008136
Agathiyan Bragadeesh4d47cea2023-07-17 16:57:24 +01008137 type = psa_get_key_type(&attributes);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008138
Przemek Stekiel51eac532022-12-07 11:04:51 +01008139 if (type != PSA_KEY_TYPE_PASSWORD &&
8140 type != PSA_KEY_TYPE_PASSWORD_HASH) {
8141 status = PSA_ERROR_INVALID_ARGUMENT;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008142 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008143 }
8144
Przemek Stekiel51eac532022-12-07 11:04:51 +01008145 operation->data.inputs.password = mbedtls_calloc(1, slot->key.bytes);
8146 if (operation->data.inputs.password == NULL) {
Przemek Stekiele12ed362022-12-21 12:54:46 +01008147 status = PSA_ERROR_INSUFFICIENT_MEMORY;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008148 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008149 }
8150
8151 memcpy(operation->data.inputs.password, slot->key.data, slot->key.bytes);
8152 operation->data.inputs.password_len = slot->key.bytes;
Przemek Stekiel9dd24402023-01-26 15:06:09 +01008153 operation->data.inputs.attributes = attributes;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008154exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008155 if (status != PSA_SUCCESS) {
8156 psa_pake_abort(operation);
8157 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008158 unlock_status = psa_unlock_key_slot(slot);
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008159 return (status == PSA_SUCCESS) ? unlock_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008160}
8161
8162psa_status_t psa_pake_set_user(
8163 psa_pake_operation_t *operation,
8164 const uint8_t *user_id,
8165 size_t user_id_len)
8166{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008167 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008168
8169 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008170 status = PSA_ERROR_BAD_STATE;
8171 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008172 }
8173
Przemek Stekiel51eac532022-12-07 11:04:51 +01008174 if (user_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008175 status = PSA_ERROR_INVALID_ARGUMENT;
8176 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008177 }
8178
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008179 if (operation->data.inputs.user_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008180 status = PSA_ERROR_BAD_STATE;
8181 goto exit;
8182 }
8183
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008184 operation->data.inputs.user = mbedtls_calloc(1, user_id_len);
8185 if (operation->data.inputs.user == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008186 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8187 goto exit;
8188 }
8189
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008190 memcpy(operation->data.inputs.user, user_id, user_id_len);
8191 operation->data.inputs.user_len = user_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008192
8193 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008194exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008195 psa_pake_abort(operation);
8196 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008197}
8198
8199psa_status_t psa_pake_set_peer(
8200 psa_pake_operation_t *operation,
8201 const uint8_t *peer_id,
8202 size_t peer_id_len)
8203{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008204 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008205
8206 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008207 status = PSA_ERROR_BAD_STATE;
8208 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008209 }
8210
Przemek Stekiel51eac532022-12-07 11:04:51 +01008211 if (peer_id_len == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008212 status = PSA_ERROR_INVALID_ARGUMENT;
8213 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008214 }
8215
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008216 if (operation->data.inputs.peer_len != 0) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008217 status = PSA_ERROR_BAD_STATE;
8218 goto exit;
8219 }
8220
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008221 operation->data.inputs.peer = mbedtls_calloc(1, peer_id_len);
8222 if (operation->data.inputs.peer == NULL) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008223 status = PSA_ERROR_INSUFFICIENT_MEMORY;
8224 goto exit;
8225 }
8226
Przemek Stekielf309d6b2023-03-10 09:54:45 +01008227 memcpy(operation->data.inputs.peer, peer_id, peer_id_len);
8228 operation->data.inputs.peer_len = peer_id_len;
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008229
8230 return PSA_SUCCESS;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008231exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008232 psa_pake_abort(operation);
8233 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008234}
8235
8236psa_status_t psa_pake_set_role(
8237 psa_pake_operation_t *operation,
8238 psa_pake_role_t role)
8239{
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008240 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008241
Przemek Stekiel51eac532022-12-07 11:04:51 +01008242 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008243 status = PSA_ERROR_BAD_STATE;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008244 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008245 }
8246
Przemek Stekiel09104b82023-03-06 14:11:51 +01008247 switch (operation->alg) {
8248#if defined(PSA_WANT_ALG_JPAKE)
8249 case PSA_ALG_JPAKE:
8250 if (role == PSA_PAKE_ROLE_NONE) {
8251 return PSA_SUCCESS;
8252 }
8253 status = PSA_ERROR_INVALID_ARGUMENT;
8254 break;
8255#endif
8256 default:
8257 (void) role;
8258 status = PSA_ERROR_NOT_SUPPORTED;
8259 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008260 }
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008261exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008262 psa_pake_abort(operation);
8263 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008264}
8265
David Horstmanne7f21e62023-05-12 18:17:21 +01008266/* Auxiliary function to convert core computation stage to single driver step. */
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008267#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008268static psa_crypto_driver_pake_step_t convert_jpake_computation_stage_to_driver_step(
Przemek Stekieldde6a912023-01-26 08:46:37 +01008269 psa_jpake_computation_stage_t *stage)
Przemek Stekielb09c4872023-01-17 12:05:38 +01008270{
David Horstmann74a3d8c2023-06-14 18:28:19 +01008271 psa_crypto_driver_pake_step_t key_share_step;
David Horstmann5da95602023-06-08 15:37:12 +01008272 if (stage->round == PSA_JPAKE_FIRST) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008273 int is_x1;
David Horstmann74a3d8c2023-06-14 18:28:19 +01008274
David Horstmann024e5c52023-06-14 15:48:21 +01008275 if (stage->io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008276 is_x1 = (stage->outputs < 1);
8277 } else {
8278 is_x1 = (stage->inputs < 1);
8279 }
8280
David Horstmann74a3d8c2023-06-14 18:28:19 +01008281 key_share_step = is_x1 ?
8282 PSA_JPAKE_X1_STEP_KEY_SHARE :
8283 PSA_JPAKE_X2_STEP_KEY_SHARE;
David Horstmann5da95602023-06-08 15:37:12 +01008284 } else if (stage->round == PSA_JPAKE_SECOND) {
David Horstmann74a3d8c2023-06-14 18:28:19 +01008285 key_share_step = (stage->io_mode == PSA_JPAKE_OUTPUT) ?
8286 PSA_JPAKE_X2S_STEP_KEY_SHARE :
8287 PSA_JPAKE_X4S_STEP_KEY_SHARE;
8288 } else {
8289 return PSA_JPAKE_STEP_INVALID;
Przemek Stekielb09c4872023-01-17 12:05:38 +01008290 }
Agathiyan Bragadeesh387bfa52023-07-17 17:01:33 +01008291 return (psa_crypto_driver_pake_step_t) (key_share_step + stage->step - PSA_PAKE_STEP_KEY_SHARE);
Przemek Stekielb09c4872023-01-17 12:05:38 +01008292}
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008293#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekielb09c4872023-01-17 12:05:38 +01008294
Przemek Stekiel2797d372022-12-22 11:19:22 +01008295static psa_status_t psa_pake_complete_inputs(
8296 psa_pake_operation_t *operation)
8297{
Przemek Stekiel2797d372022-12-22 11:19:22 +01008298 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel18620a32023-01-17 16:34:52 +01008299 /* Create copy of the inputs on stack as inputs share memory
8300 with the driver context which will be setup by the driver. */
8301 psa_crypto_driver_pake_inputs_t inputs = operation->data.inputs;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008302
Przemek Stekielfde11282023-03-13 16:06:09 +01008303 if (inputs.password_len == 0) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008304 return PSA_ERROR_BAD_STATE;
8305 }
8306
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008307 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekielfde11282023-03-13 16:06:09 +01008308 if (inputs.user_len == 0 || inputs.peer_len == 0) {
8309 return PSA_ERROR_BAD_STATE;
8310 }
Przemek Stekieldff21d32023-02-14 20:09:10 +01008311 }
8312
Przemek Stekiel18620a32023-01-17 16:34:52 +01008313 /* Clear driver context */
8314 mbedtls_platform_zeroize(&operation->data, sizeof(operation->data));
8315
8316 status = psa_driver_wrapper_pake_setup(operation, &inputs);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008317
8318 /* Driver is responsible for creating its own copy of the password. */
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008319 mbedtls_zeroize_and_free(inputs.password, inputs.password_len);
Przemek Stekiel2797d372022-12-22 11:19:22 +01008320
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008321 /* User and peer are translated to role. */
8322 mbedtls_free(inputs.user);
8323 mbedtls_free(inputs.peer);
8324
Przemek Stekiel2797d372022-12-22 11:19:22 +01008325 if (status == PSA_SUCCESS) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008326#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiel2797d372022-12-22 11:19:22 +01008327 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekield93de322023-02-24 08:39:04 +01008328 operation->stage = PSA_PAKE_OPERATION_STAGE_COMPUTATION;
Przemek Stekiel80a88492023-02-20 13:32:22 +01008329 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008330#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008331 {
8332 status = PSA_ERROR_NOT_SUPPORTED;
Przemek Stekiel2797d372022-12-22 11:19:22 +01008333 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008334 }
Przemek Stekiel2797d372022-12-22 11:19:22 +01008335 return status;
8336}
8337
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008338#if defined(PSA_WANT_ALG_JPAKE)
David Horstmanne7f21e62023-05-12 18:17:21 +01008339static psa_status_t psa_jpake_prologue(
Przemek Stekiele12ed362022-12-21 12:54:46 +01008340 psa_pake_operation_t *operation,
David Horstmanne7f21e62023-05-12 18:17:21 +01008341 psa_pake_step_t step,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008342 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008343{
Przemek Stekiele12ed362022-12-21 12:54:46 +01008344 if (step != PSA_PAKE_STEP_KEY_SHARE &&
8345 step != PSA_PAKE_STEP_ZK_PUBLIC &&
8346 step != PSA_PAKE_STEP_ZK_PROOF) {
8347 return PSA_ERROR_INVALID_ARGUMENT;
8348 }
8349
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008350 psa_jpake_computation_stage_t *computation_stage =
8351 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008352
David Horstmann5da95602023-06-08 15:37:12 +01008353 if (computation_stage->round != PSA_JPAKE_FIRST &&
8354 computation_stage->round != PSA_JPAKE_SECOND) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008355 return PSA_ERROR_BAD_STATE;
8356 }
8357
David Horstmanne7f21e62023-05-12 18:17:21 +01008358 /* Check that the step we are given is the one we were expecting */
8359 if (step != computation_stage->step) {
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008360 return PSA_ERROR_BAD_STATE;
8361 }
8362
David Horstmanne7f21e62023-05-12 18:17:21 +01008363 if (step == PSA_PAKE_STEP_KEY_SHARE &&
8364 computation_stage->inputs == 0 &&
8365 computation_stage->outputs == 0) {
8366 /* Start of the round, so function decides whether we are inputting
8367 * or outputting */
David Horstmann024e5c52023-06-14 15:48:21 +01008368 computation_stage->io_mode = io_mode;
8369 } else if (computation_stage->io_mode != io_mode) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008370 /* Middle of the round so the mode we are in must match the function
8371 * called by the user */
8372 return PSA_ERROR_BAD_STATE;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008373 }
8374
8375 return PSA_SUCCESS;
8376}
8377
David Horstmanne7f21e62023-05-12 18:17:21 +01008378static psa_status_t psa_jpake_epilogue(
8379 psa_pake_operation_t *operation,
David Horstmann00ad6bf2023-06-14 15:44:24 +01008380 psa_jpake_io_mode_t io_mode)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008381{
David Horstmanne7f21e62023-05-12 18:17:21 +01008382 psa_jpake_computation_stage_t *stage =
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008383 &operation->computation_stage.jpake;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008384
David Horstmanne7f21e62023-05-12 18:17:21 +01008385 if (stage->step == PSA_PAKE_STEP_ZK_PROOF) {
8386 /* End of an input/output */
David Horstmann00ad6bf2023-06-14 15:44:24 +01008387 if (io_mode == PSA_JPAKE_INPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008388 stage->inputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008389 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008390 stage->io_mode = PSA_JPAKE_OUTPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008391 }
8392 }
David Horstmann00ad6bf2023-06-14 15:44:24 +01008393 if (io_mode == PSA_JPAKE_OUTPUT) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008394 stage->outputs++;
David Horstmann246ec5a2023-06-27 10:33:06 +01008395 if (stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmann024e5c52023-06-14 15:48:21 +01008396 stage->io_mode = PSA_JPAKE_INPUT;
David Horstmanne7f21e62023-05-12 18:17:21 +01008397 }
8398 }
David Horstmann246ec5a2023-06-27 10:33:06 +01008399 if (stage->inputs == PSA_JPAKE_EXPECTED_INPUTS(stage->round) &&
8400 stage->outputs == PSA_JPAKE_EXPECTED_OUTPUTS(stage->round)) {
David Horstmanne7f21e62023-05-12 18:17:21 +01008401 /* End of a round, move to the next round */
8402 stage->inputs = 0;
8403 stage->outputs = 0;
8404 stage->round++;
8405 }
8406 stage->step = PSA_PAKE_STEP_KEY_SHARE;
Przemek Stekiel5eff1032023-02-21 19:10:36 +01008407 } else {
David Horstmanne7f21e62023-05-12 18:17:21 +01008408 stage->step++;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008409 }
Przemek Stekiele12ed362022-12-21 12:54:46 +01008410 return PSA_SUCCESS;
8411}
David Horstmanne7f21e62023-05-12 18:17:21 +01008412
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008413#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008414
Neil Armstronga7d08c32022-06-01 18:21:20 +02008415psa_status_t psa_pake_output(
8416 psa_pake_operation_t *operation,
8417 psa_pake_step_t step,
8418 uint8_t *output,
8419 size_t output_size,
8420 size_t *output_length)
8421{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008422 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008423 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008424 *output_length = 0;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008425
8426 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008427 status = psa_pake_complete_inputs(operation);
8428 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008429 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008430 }
8431 }
8432
8433 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008434 status = PSA_ERROR_BAD_STATE;
8435 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008436 }
8437
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008438 if (output_size == 0) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008439 status = PSA_ERROR_INVALID_ARGUMENT;
8440 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008441 }
8442
Przemek Stekiele12ed362022-12-21 12:54:46 +01008443 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008444#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008445 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008446 status = psa_jpake_prologue(operation, step, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008447 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008448 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008449 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008450 driver_step = convert_jpake_computation_stage_to_driver_step(
8451 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008452 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008453#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008454 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008455 (void) step;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008456 status = PSA_ERROR_NOT_SUPPORTED;
8457 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008458 }
8459
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008460 status = psa_driver_wrapper_pake_output(operation, driver_step,
8461 output, output_size, output_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008462
8463 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008464 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008465 }
8466
8467 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008468#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008469 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008470 status = psa_jpake_epilogue(operation, PSA_JPAKE_OUTPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008471 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008472 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008473 }
8474 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008475#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008476 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008477 status = PSA_ERROR_NOT_SUPPORTED;
8478 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008479 }
8480
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008481 return PSA_SUCCESS;
8482exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008483 psa_pake_abort(operation);
8484 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008485}
8486
8487psa_status_t psa_pake_input(
8488 psa_pake_operation_t *operation,
8489 psa_pake_step_t step,
8490 const uint8_t *input,
8491 size_t input_length)
8492{
Przemek Stekiel51eac532022-12-07 11:04:51 +01008493 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008494 psa_crypto_driver_pake_step_t driver_step = PSA_JPAKE_STEP_INVALID;
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008495 const size_t max_input_length = (size_t) PSA_PAKE_INPUT_SIZE(operation->alg,
8496 operation->primitive,
8497 step);
Przemek Stekiel51eac532022-12-07 11:04:51 +01008498
8499 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
Przemek Stekiel2797d372022-12-22 11:19:22 +01008500 status = psa_pake_complete_inputs(operation);
8501 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008502 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008503 }
8504 }
8505
8506 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008507 status = PSA_ERROR_BAD_STATE;
8508 goto exit;
Przemek Stekiel51eac532022-12-07 11:04:51 +01008509 }
8510
Przemek Stekiel256c75d2023-03-23 14:09:34 +01008511 if (input_length == 0 || input_length > max_input_length) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008512 status = PSA_ERROR_INVALID_ARGUMENT;
8513 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008514 }
8515
Przemek Stekiele12ed362022-12-21 12:54:46 +01008516 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008517#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008518 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008519 status = psa_jpake_prologue(operation, step, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008520 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008521 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008522 }
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008523 driver_step = convert_jpake_computation_stage_to_driver_step(
8524 &operation->computation_stage.jpake);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008525 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008526#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008527 default:
Przemek Stekiel80a88492023-02-20 13:32:22 +01008528 (void) step;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008529 status = PSA_ERROR_NOT_SUPPORTED;
8530 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008531 }
8532
Przemek Stekiel691e91a2023-03-07 16:26:37 +01008533 status = psa_driver_wrapper_pake_input(operation, driver_step,
8534 input, input_length);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008535
8536 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008537 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008538 }
8539
8540 switch (operation->alg) {
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008541#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008542 case PSA_ALG_JPAKE:
David Horstmann5da95602023-06-08 15:37:12 +01008543 status = psa_jpake_epilogue(operation, PSA_JPAKE_INPUT);
Przemek Stekiele12ed362022-12-21 12:54:46 +01008544 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008545 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008546 }
8547 break;
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008548#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiele12ed362022-12-21 12:54:46 +01008549 default:
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008550 status = PSA_ERROR_NOT_SUPPORTED;
8551 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008552 }
8553
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008554 return PSA_SUCCESS;
8555exit:
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008556 psa_pake_abort(operation);
8557 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008558}
8559
8560psa_status_t psa_pake_get_implicit_key(
8561 psa_pake_operation_t *operation,
8562 psa_key_derivation_operation_t *output)
8563{
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008564 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008565 psa_status_t abort_status = PSA_ERROR_CORRUPTION_DETECTED;
Przemek Stekiel251e86a2023-02-17 14:30:50 +01008566 uint8_t shared_key[MBEDTLS_PSA_JPAKE_BUFFER_SIZE];
Przemek Stekiel0c781802022-11-29 14:53:13 +01008567 size_t shared_key_len = 0;
8568
Przemek Stekielf62b3bb2023-01-31 19:51:24 +01008569 if (operation->stage != PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008570 status = PSA_ERROR_BAD_STATE;
8571 goto exit;
Neil Armstrong5ae60962022-09-15 11:29:46 +02008572 }
8573
Przemek Stekiel4aa99402023-02-27 13:00:57 +01008574#if defined(PSA_WANT_ALG_JPAKE)
Przemek Stekiele12ed362022-12-21 12:54:46 +01008575 if (operation->alg == PSA_ALG_JPAKE) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008576 psa_jpake_computation_stage_t *computation_stage =
Przemek Stekiel083745e2023-02-23 17:28:23 +01008577 &operation->computation_stage.jpake;
David Horstmann5da95602023-06-08 15:37:12 +01008578 if (computation_stage->round != PSA_JPAKE_FINISHED) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008579 status = PSA_ERROR_BAD_STATE;
8580 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008581 }
Przemek Stekiel80a88492023-02-20 13:32:22 +01008582 } else
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008583#endif /* PSA_WANT_ALG_JPAKE */
Przemek Stekiel80a88492023-02-20 13:32:22 +01008584 {
8585 status = PSA_ERROR_NOT_SUPPORTED;
8586 goto exit;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008587 }
8588
Przemek Stekiel0c781802022-11-29 14:53:13 +01008589 status = psa_driver_wrapper_pake_get_implicit_key(operation,
8590 shared_key,
Przemek Stekiel6b648622023-02-19 22:55:33 +01008591 sizeof(shared_key),
Przemek Stekiel0c781802022-11-29 14:53:13 +01008592 &shared_key_len);
8593
8594 if (status != PSA_SUCCESS) {
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008595 goto exit;
Przemek Stekiel0c781802022-11-29 14:53:13 +01008596 }
8597
8598 status = psa_key_derivation_input_bytes(output,
8599 PSA_KEY_DERIVATION_INPUT_SECRET,
8600 shared_key,
8601 shared_key_len);
8602
Przemek Stekiele3ef3a12023-02-27 10:20:06 +01008603 mbedtls_platform_zeroize(shared_key, sizeof(shared_key));
Przemek Stekiel3e784d82023-02-08 09:12:42 +01008604exit:
8605 abort_status = psa_pake_abort(operation);
8606 return status == PSA_SUCCESS ? abort_status : status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008607}
8608
8609psa_status_t psa_pake_abort(
8610 psa_pake_operation_t *operation)
8611{
Przemek Stekield69dca92023-01-31 19:59:20 +01008612 psa_status_t status = PSA_SUCCESS;
Przemek Stekiele12ed362022-12-21 12:54:46 +01008613
Przemek Stekield69dca92023-01-31 19:59:20 +01008614 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COMPUTATION) {
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008615 status = psa_driver_wrapper_pake_abort(operation);
Neil Armstrong5ae60962022-09-15 11:29:46 +02008616 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008617
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008618 if (operation->stage == PSA_PAKE_OPERATION_STAGE_COLLECT_INPUTS) {
8619 if (operation->data.inputs.password != NULL) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +01008620 mbedtls_zeroize_and_free(operation->data.inputs.password,
Przemek Stekielaa183422023-03-06 14:21:44 +01008621 operation->data.inputs.password_len);
Przemek Stekiel26c909d2023-02-28 12:34:03 +01008622 }
8623 if (operation->data.inputs.user != NULL) {
8624 mbedtls_free(operation->data.inputs.user);
8625 }
8626 if (operation->data.inputs.peer != NULL) {
8627 mbedtls_free(operation->data.inputs.peer);
8628 }
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008629 }
Przemek Stekield69dca92023-01-31 19:59:20 +01008630 memset(operation, 0, sizeof(psa_pake_operation_t));
Przemek Stekiel9a5b8122022-12-22 13:34:47 +01008631
Przemek Stekield69dca92023-01-31 19:59:20 +01008632 return status;
Neil Armstronga7d08c32022-06-01 18:21:20 +02008633}
Tom Cosgrove6d62fac2023-05-10 14:40:05 +01008634#endif /* PSA_WANT_ALG_SOME_PAKE */
Neil Armstronga7d08c32022-06-01 18:21:20 +02008635
David Horstmann00d7a042023-12-07 18:39:17 +00008636/* Memory copying test hooks. These are called before input copy, after input
8637 * copy, before output copy and after output copy, respectively.
8638 * They are used by memory-poisoning tests to temporarily unpoison buffers
8639 * while they are copied. */
David Horstmanne138dce2023-11-28 15:21:56 +00008640#if defined(MBEDTLS_TEST_HOOKS)
8641void (*psa_input_pre_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8642void (*psa_input_post_copy_hook)(const uint8_t *input, size_t input_len) = NULL;
8643void (*psa_output_pre_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8644void (*psa_output_post_copy_hook)(const uint8_t *output, size_t output_len) = NULL;
8645#endif
David Horstmannfde97392023-10-30 20:29:43 +00008646
David Horstmann1b7279a2023-11-15 15:18:30 +00008647/** Copy from an input buffer to a local copy.
8648 *
8649 * \param[in] input Pointer to input buffer.
8650 * \param[in] input_len Length of the input buffer.
8651 * \param[out] input_copy Pointer to a local copy in which to store the input data.
8652 * \param[out] input_copy_len Length of the local copy buffer.
8653 * \return #PSA_SUCCESS, if the buffer was successfully
8654 * copied.
8655 * \return #PSA_ERROR_CORRUPTION_DETECTED, if the local
8656 * copy is too small to hold contents of the
8657 * input buffer.
8658 */
8659MBEDTLS_STATIC_TESTABLE
David Horstmannfde97392023-10-30 20:29:43 +00008660psa_status_t psa_crypto_copy_input(const uint8_t *input, size_t input_len,
8661 uint8_t *input_copy, size_t input_copy_len)
8662{
8663 if (input_len > input_copy_len) {
David Horstmann49a72762023-11-03 19:51:40 +00008664 return PSA_ERROR_CORRUPTION_DETECTED;
David Horstmannfde97392023-10-30 20:29:43 +00008665 }
8666
David Horstmann372b8bb2023-11-24 16:21:04 +00008667#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008668 if (psa_input_pre_copy_hook != NULL) {
8669 psa_input_pre_copy_hook(input, input_len);
8670 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008671#endif
8672
David Horstmann777e7412023-11-15 17:33:47 +00008673 if (input_len > 0) {
8674 memcpy(input_copy, input, input_len);
8675 }
David Horstmannfde97392023-10-30 20:29:43 +00008676
David Horstmann372b8bb2023-11-24 16:21:04 +00008677#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008678 if (psa_input_post_copy_hook != NULL) {
8679 psa_input_post_copy_hook(input, input_len);
8680 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008681#endif
8682
David Horstmannfde97392023-10-30 20:29:43 +00008683 return PSA_SUCCESS;
8684}
8685
David Horstmann1b7279a2023-11-15 15:18:30 +00008686/** Copy from a local output buffer into a user-supplied one.
8687 *
8688 * \param[in] output_copy Pointer to a local buffer containing the output.
8689 * \param[in] output_copy_len Length of the local buffer.
8690 * \param[out] output Pointer to user-supplied output buffer.
8691 * \param[out] output_len Length of the user-supplied output buffer.
8692 * \return #PSA_SUCCESS, if the buffer was successfully
8693 * copied.
David Horstmann671f5f52023-11-20 12:39:38 +00008694 * \return #PSA_ERROR_BUFFER_TOO_SMALL, if the
David Horstmann1b7279a2023-11-15 15:18:30 +00008695 * user-supplied output buffer is too small to
8696 * hold the contents of the local buffer.
8697 */
8698MBEDTLS_STATIC_TESTABLE
David Horstmann8978f5c2023-10-30 20:37:12 +00008699psa_status_t psa_crypto_copy_output(const uint8_t *output_copy, size_t output_copy_len,
8700 uint8_t *output, size_t output_len)
8701{
8702 if (output_len < output_copy_len) {
David Horstmann671f5f52023-11-20 12:39:38 +00008703 return PSA_ERROR_BUFFER_TOO_SMALL;
David Horstmann8978f5c2023-10-30 20:37:12 +00008704 }
David Horstmann777e7412023-11-15 17:33:47 +00008705
David Horstmann372b8bb2023-11-24 16:21:04 +00008706#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008707 if (psa_output_pre_copy_hook != NULL) {
8708 psa_output_pre_copy_hook(output, output_len);
8709 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008710#endif
8711
David Horstmann777e7412023-11-15 17:33:47 +00008712 if (output_copy_len > 0) {
8713 memcpy(output, output_copy, output_copy_len);
8714 }
8715
David Horstmann372b8bb2023-11-24 16:21:04 +00008716#if defined(MBEDTLS_TEST_HOOKS)
David Horstmanne138dce2023-11-28 15:21:56 +00008717 if (psa_output_post_copy_hook != NULL) {
8718 psa_output_post_copy_hook(output, output_len);
8719 }
David Horstmann372b8bb2023-11-24 16:21:04 +00008720#endif
8721
David Horstmann8978f5c2023-10-30 20:37:12 +00008722 return PSA_SUCCESS;
8723}
8724
David Horstmannf1734052023-11-20 17:15:32 +00008725psa_status_t psa_crypto_local_input_alloc(const uint8_t *input, size_t input_len,
8726 psa_crypto_local_input_t *local_input)
David Horstmann4ac78852023-11-07 16:36:48 +00008727{
8728 psa_status_t status;
8729
David Horstmann9db14482023-11-23 15:50:37 +00008730 *local_input = PSA_CRYPTO_LOCAL_INPUT_INIT;
David Horstmann4ac78852023-11-07 16:36:48 +00008731
David Horstmannc5cc1c32023-11-15 18:11:26 +00008732 if (input_len == 0) {
David Horstmann4ac78852023-11-07 16:36:48 +00008733 return PSA_SUCCESS;
8734 }
8735
David Horstmannf1734052023-11-20 17:15:32 +00008736 local_input->buffer = mbedtls_calloc(input_len, 1);
8737 if (local_input->buffer == NULL) {
David Horstmann4ac78852023-11-07 16:36:48 +00008738 /* Since we dealt with the zero-length case above, we know that
8739 * a NULL return value means a failure of allocation. */
8740 return PSA_ERROR_INSUFFICIENT_MEMORY;
8741 }
David Horstmannf1734052023-11-20 17:15:32 +00008742 /* From now on, we must free local_input->buffer on error. */
David Horstmann4ac78852023-11-07 16:36:48 +00008743
David Horstmannf1734052023-11-20 17:15:32 +00008744 local_input->length = input_len;
David Horstmann4ac78852023-11-07 16:36:48 +00008745
8746 status = psa_crypto_copy_input(input, input_len,
David Horstmannf1734052023-11-20 17:15:32 +00008747 local_input->buffer, local_input->length);
David Horstmann4ac78852023-11-07 16:36:48 +00008748 if (status != PSA_SUCCESS) {
8749 goto error;
8750 }
8751
8752 return PSA_SUCCESS;
8753
8754error:
David Horstmannf1734052023-11-20 17:15:32 +00008755 mbedtls_free(local_input->buffer);
8756 local_input->buffer = NULL;
8757 local_input->length = 0;
David Horstmann4ac78852023-11-07 16:36:48 +00008758 return status;
8759}
8760
David Horstmannf1734052023-11-20 17:15:32 +00008761void psa_crypto_local_input_free(psa_crypto_local_input_t *local_input)
David Horstmanne6042ff2023-11-07 18:00:41 +00008762{
David Horstmannf1734052023-11-20 17:15:32 +00008763 mbedtls_free(local_input->buffer);
8764 local_input->buffer = NULL;
8765 local_input->length = 0;
David Horstmanne6042ff2023-11-07 18:00:41 +00008766}
8767
David Horstmann89875a42023-11-20 12:54:09 +00008768psa_status_t psa_crypto_local_output_alloc(uint8_t *output, size_t output_len,
8769 psa_crypto_local_output_t *local_output)
David Horstmannba3c7d62023-11-08 15:19:43 +00008770{
David Horstmann9db14482023-11-23 15:50:37 +00008771 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
David Horstmannba3c7d62023-11-08 15:19:43 +00008772
David Horstmannc5cc1c32023-11-15 18:11:26 +00008773 if (output_len == 0) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008774 return PSA_SUCCESS;
8775 }
David Horstmann89875a42023-11-20 12:54:09 +00008776 local_output->buffer = mbedtls_calloc(output_len, 1);
8777 if (local_output->buffer == NULL) {
David Horstmannba3c7d62023-11-08 15:19:43 +00008778 /* Since we dealt with the zero-length case above, we know that
8779 * a NULL return value means a failure of allocation. */
8780 return PSA_ERROR_INSUFFICIENT_MEMORY;
8781 }
David Horstmann89875a42023-11-20 12:54:09 +00008782 local_output->length = output_len;
8783 local_output->original = output;
David Horstmannba3c7d62023-11-08 15:19:43 +00008784
8785 return PSA_SUCCESS;
8786}
8787
Gabor Mezei1882c512024-01-24 13:07:17 +01008788psa_status_t psa_crypto_local_output_alloc_with_copy(uint8_t *output, size_t output_len,
8789 psa_crypto_local_output_t *local_output)
8790{
8791 psa_status_t status;
8792 *local_output = PSA_CRYPTO_LOCAL_OUTPUT_INIT;
8793
8794 if (output_len == 0) {
8795 return PSA_SUCCESS;
8796 }
8797 local_output->buffer = mbedtls_calloc(output_len, 1);
8798 if (local_output->buffer == NULL) {
8799 /* Since we dealt with the zero-length case above, we know that
8800 * a NULL return value means a failure of allocation. */
8801 return PSA_ERROR_INSUFFICIENT_MEMORY;
8802 }
8803 local_output->length = output_len;
8804 local_output->original = output;
8805
8806 status = psa_crypto_copy_input(output, output_len,
8807 local_output->buffer, local_output->length);
8808 if (status != PSA_SUCCESS) {
8809 goto error;
8810 }
8811
8812 return PSA_SUCCESS;
8813
8814error:
8815 mbedtls_free(local_output->buffer);
8816 local_output->buffer = NULL;
8817 local_output->length = 0;
8818 return status;
8819}
8820
David Horstmann89875a42023-11-20 12:54:09 +00008821psa_status_t psa_crypto_local_output_free(psa_crypto_local_output_t *local_output)
David Horstmann9467ea32023-11-08 17:44:18 +00008822{
David Horstmannc335a4e2023-11-15 15:57:32 +00008823 psa_status_t status;
8824
David Horstmann89875a42023-11-20 12:54:09 +00008825 if (local_output->buffer == NULL) {
8826 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008827 return PSA_SUCCESS;
8828 }
David Horstmann89875a42023-11-20 12:54:09 +00008829 if (local_output->original == NULL) {
David Horstmann9467ea32023-11-08 17:44:18 +00008830 /* We have an internal copy but nothing to copy back to. */
8831 return PSA_ERROR_CORRUPTION_DETECTED;
8832 }
8833
David Horstmann89875a42023-11-20 12:54:09 +00008834 status = psa_crypto_copy_output(local_output->buffer, local_output->length,
8835 local_output->original, local_output->length);
David Horstmannc335a4e2023-11-15 15:57:32 +00008836 if (status != PSA_SUCCESS) {
8837 return status;
8838 }
David Horstmann9467ea32023-11-08 17:44:18 +00008839
David Horstmann89875a42023-11-20 12:54:09 +00008840 mbedtls_free(local_output->buffer);
8841 local_output->buffer = NULL;
8842 local_output->length = 0;
David Horstmann9467ea32023-11-08 17:44:18 +00008843
8844 return PSA_SUCCESS;
8845}
8846
Gilles Peskinee59236f2018-01-27 23:32:46 +01008847#endif /* MBEDTLS_PSA_CRYPTO_C */